volosyuk / simple-eloquent
Adaptation of eloquent for retrieving its attributes
Installs: 74 253
Dependents: 0
Suggesters: 0
Security: 0
Stars: 50
Watchers: 2
Forks: 11
Open Issues: 1
Requires
- php: ^7.2
- illuminate/database: ^8.0
- illuminate/pagination: ^8.0
- illuminate/support: ^8.0
Requires (Dev)
- phpunit/phpunit: ^8.0
This package is auto-updated.
Last update: 2024-10-28 18:25:59 UTC
README
This extension presents some methods for eloquent ORM in order to reduce time and memory consumption.
Sometimes application doesn't need all of eloquent overhead. It just requires to retrieve model's attributes with relations and nothing more.
In this case this methods might be enough useful for you.
Extension supports:
- eloquent relations
- illuminate pagination
- PDO::FETCH_OBJ and PDO::FETCH_ASSOC fetch modes
Requirements
laravel >= 5.3
Installation
Run
composer require --prefer-dist volosyuk/simple-eloquent "*"
or add this code line to the require section of your composer.json file:
"volosyuk/simple-eloquent": "*"
Usage
Just use SimpleEloquent trait in your model. If you want to get models with relations attach SimpleEloquent trait to related models as well.
use Volosyuk\SimpleEloquent\SimpleEloquent; class Department extends \Illuminate\Database\Eloquent\Model { use SimpleEloquent; }
Then use simple() method in chain of methods calls.
$users = User::whereHas('units')->withCount('units')->with('units')->limit(10)->simple()->get(); $activeUser = User::simple()->where('is_active', 1)->first();
Profit
Example 1 - users with details; 50 per page
$users = User::with([ 'units.leaders.performance', 'teams.leaders.performance', 'programs.courses' ])->limit(50)->get()
Example 2 - select models with 5-level relation
$goals = Goal::with('goalUser.user.courses.points.user')->limit(20)->get()
Example 3 - let's select 1000 models
$performance = Performance::whereHas('user')->with('goal.goalUser')->limit(1000)->get()
What do you lose?
Since this extension provides less expensive methods you'll definitely lose some functionality. Basic methods return collection of eloquent models in contrast to new functionality which returns collection of stdClasses|arrays. This example will show the difference between results.
$categories = Category::with('articles')->get() // want to grab all categories with articles
get() returns
Illuminate\Database\Eloquent\Collection::__set_state([ 'items' => [ 0 => Category::__set_state([ 'guarded' => [], 'connection' => 'default', 'table' => NULL, 'primaryKey' => 'id', 'keyType' => 'int', 'incrementing' => true, 'with' => [], 'withCount' => [], 'perPage' => 15, 'exists' => true, 'wasRecentlyCreated' => false, 'attributes' => [ 'id' => '1', 'name' => 'Test category', 'created_at' => '2017-12-21 12:33:34', 'updated_at' => '2017-12-21 12:33:34' ], 'original' => [ 'id' => '1', 'name' => 'Test category', 'created_at' => '2017-12-21 12:33:34', 'updated_at' => '2017-12-21 12:33:34', ], 'changes' => [], 'casts' => [], 'dates' => [], 'dateFormat' => NULL, 'appends' => [], 'dispatchesEvents' => [], 'observables' => [], 'relations' => [ 'articles' => Illuminate\Database\Eloquent\Collection::__set_state([ 'items' => [ 0 => Article::__set_state([ 'guarded' => [], 'connection' => 'default', 'table' => NULL, 'primaryKey' => 'id', 'keyType' => 'int', 'incrementing' => true, 'with' => [], 'withCount' => [], 'perPage' => 15, 'exists' => true, 'wasRecentlyCreated' => false, 'attributes' => [ 'id' => '1', 'category_id' => '1', 'title' => 'Test article', 'created_at' => '2017-12-21 12:33:34', 'updated_at' => '2017-12-21 12:33:34', ], 'original' => [ 'id' => '1', 'category_id' => '1', 'title' => 'Test article', 'created_at' => '2017-12-21 12:33:34', 'updated_at' => '2017-12-21 12:33:34', ], 'changes' => [], 'casts' => [], 'dates' => [], 'dateFormat' => NULL, 'appends' => [], 'dispatchesEvents' => [], 'observables' => [], 'relations' => [], 'touches' => [], 'timestamps' => true, 'hidden' => [], 'visible' => [], 'fillable' => [], ]), ], ]), ], 'touches' => [], 'timestamps' => true, 'hidden' => [], 'visible' => [], 'fillable' => [], ]) ] ]);
simple()->get() returns
Illuminate\Support\Collection::__set_state([ 'items' => [ 0 => stdClass::__set_state([ 'id' => '1', 'name' => 'Test category', 'created_at' => '2017-12-21 12:43:44', 'updated_at' => '2017-12-21 12:43:44', 'articles' => Illuminate\Support\Collection::__set_state([ 'items' => [ 0 => stdClass::__set_state([ 'id' => '1', 'category_id' => '1', 'title' => 'Test article', 'created_at' => '2017-12-21 12:43:44', 'updated_at' => '2017-12-21 12:43:44', ]), ], ]), ]), ] ]);
Since you'll get stdClasses|arrays you won't reach out to casting, appends, guarded/fillable, crud and another possibilities. That's why new methods are much faster 😏