How maarsson/eloquent-getter works
Main Components
a) Core Package Components:
• GetterableTrait (key integration point)
• AbstractEloquentGetter (base filtering/sorting logic)
• Command System (for getter generation)
b) Integration Points:
• Laravel Model Layer
• Query Builder Interface
• HTTP Request Layer
Component Relationships
HTTP Request → Laravel Model → GetterableTrait → AbstractEloquentGetter → Query Builder → Database
Specific Implementation Details
a) Service Provider Layer:
• EloquentGetterServiceProvider (registration point)
b) Command Layer:
• MakeGetterCommand (code generation)
c) Core Features:
• Filtering System
• Sorting System
• Attribute Loading System
Flow Representation
• Request flow (→): How filters/sorts move through system
• Integration points (⇢): Where package connects to Laravel
• Extension points (⇢): Where users can add custom filters/sorters
Key Processes
a) Filter Flow:
Request with filter[] → Model → GetterableTrait → Custom Filter Methods → Query Builder
b) Sorter Flow:
Request with sort_by → Model → GetterableTrait → Custom Sorter Methods → Query Builder
c) Attribute Loading:
withAttributes() → Model → Relation Loading → Attribute Selection
Additional Elements
• Configuration points (config/eloquent-getter.php)
• Stub generation flow
• Extension points for custom filters/sorters
Implementation Notes
• How the trait injection works
• Where custom getter classes are generated
• Points where user customization is expected
• High-level architecture (package integration)
• Implementation details (filter/sort flow)
• Extension points (custom getters)
Remember to:
• Keep components clearly labeled
• Use consistent styling
• Version/dependency information
• Notes for important configuration options