Package Data | |
---|---|
Maintainer Username: | nayjest |
Maintainer Contact: | mail@vitaliy.in (Vitalii [Nayjest] Stepanenko) |
Package Create Date: | 2016-02-24 |
Package Last Update: | 2021-07-06 |
Language: | PHP |
License: | MIT |
Last Refreshed: | 2024-12-19 03:11:53 |
Package Statistics | |
---|---|
Total Downloads: | 48,087 |
Monthly Downloads: | 888 |
Daily Downloads: | 19 |
Total Stars: | 19 |
Total Watchers: | 2 |
Total Forks: | 2 |
Total Open Issues: | 1 |
Eloquent ORM support for ViewComponents
The recommended way of installing the component is through Composer.
Run following command:
composer require view-components/eloquent-data-processing
EloquentDataProvider supports 3 types of data sources:
use MyApp\UserModel;
use ViewComponents\Eloquent\EloquentDataProvider;
$provider = new EloquentDataProvider(UserModel::class);
If you use class name of Eloquent model as data source, the only way to modify database query is specifying data provider operations:
use ViewComponents\ViewComponents\Data\Operation\FilterOperation;
$provider->operations()->add(
new FilterOperation('role', FilterOperation::OPERATOR_EQ, 'Manager')
);
use ViewComponents\Eloquent\EloquentDataProvider;
$provider = new EloquentDataProvider((new MyApp\UserModel)->newQuery());
It's possible to specify query parts before creating EloquentDataProvider but note that some parts of query may be changed by data provider operations.
use ViewComponents\Eloquent\EloquentDataProvider;
$query = MyApp\UserModel
::where('role', '=', 'Manager')
->where('company', '=', 'Facebook')
->orderBy('id');
$provider = new EloquentDataProvider($query);
It's possible to use EloquentDataProvider if you not deal with Eloquent models.
use DB;
use ViewComponents\Eloquent\EloquentDataProvider;
$provider = new EloquentDataProvider(
DB::table('users')->where('name', '=', 'David')
);
Eloquent Data provider modifies database query when it has operations.
Use operations() method for accessing operations collection.
Documentation related to collections can be found here.
Example of adding operation:
$provider
->operations()
->add(new SortOperation('id', SortOperation::ASC));
Also operations can be specified on data provider creation:
use MyApp\UserModel;
use ViewComponents\Eloquent\EloquentDataProvider;
use ViewComponents\ViewComponents\Data\Operation\FilterOperation;
$provider = new EloquentDataProvider(
UserModel::class
[
new FilterOperation('role', FilterOperation::OPERATOR_EQ, 'Manager')
new SortOperation('id', SortOperation::DESC),
]
);
Data providers implements IteratorAggregate interface, so you can iterate it like array:
use MyApp\UserModel;
use ViewComponents\Eloquent\EloquentDataProvider;
$provider = new EloquentDataProvider(UserModel::class);
foreach ($provider as $user) {
var_dump($user); // instance of UserModel
}
Data provider executes DB query when getIterator() method is called or when iteration begins in case if data is not loaded yet, i. e. calling getIterator() twice will not produce 2 database queries. But changing operations collection will cause resetting cache:
use MyApp\UserModel;
use ViewComponents\Eloquent\EloquentDataProvider;
use ViewComponents\ViewComponents\Data\Operation\FilterOperation;
$provider = new EloquentDataProvider(UserModel::class);
// databse query will be executed
$provider->getIterator();
// databse query will not be executed again, iterating over same data
$provider->getIterator();
$provider->operations->add(
new FilterOperation('id', FilterOperation::OPERATOR_LTE, 5)
)
// databse query will be executed again
$provider->getIterator();
Please see Contributing Guidelines and Code of Conduct for details.
This package bundled with unit tests (PHPUnit).
To run tests locally, you must install this package as stand-alone project with dev-dependencies:
composer create-project view-components/eloquent-data-processing
Command for running tests:
composer test
If you discover any security related issues, please email mail@vitaliy.in instead of using the issue tracker.
© 2015 — 2016 Vitalii Stepanenko
Licensed under the MIT License.
Please see License File for more information.