Download the PHP package nilportugues/eloquent-repository without Composer
On this page you can find all versions of the php package nilportugues/eloquent-repository. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nilportugues/eloquent-repository
More information about nilportugues/eloquent-repository
Files in nilportugues/eloquent-repository
Package eloquent-repository
Short Description Eloquent Repository implementation
License MIT
Homepage http://nilportugues.com
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package eloquent-repository
Eloquent Repository
Eloquent Repository using nilportugues/repository as foundation.
Installation
Use Composer to install the package:
Why? Drivers and Multiple Implementations!
Using this implementation you can switch it out to test your code without setting up databases.
Doesn't sound handy? Let's think of yet another use case you'll love using this. Functional tests and Unitary tests.
No database connection will be needed, nor fakes. Using an InMemoryRepository or FileSystemRepository implementation will make those a breeze to code. And once the tests finish, all data may be destroyed with no worries at all.
Available drivers:
Also, if you feel like changing the repository implementation, no logic changes would be needed, as there are a set of drivers for you to use out of the box:
composer require nilportugues/repository-cachefor caching.composer require nilportugues/repositoryfor an InMemoryRepository implementation.composer require nilportugues/filesystem-repositoryfor a FileSystemRepository implementation.composer require nilportugues/doctrine-repositoryfor a SQL Doctrine implementation.composer require nilportugues/eloquent-mongodb-repositoryfor a MongoDB Eloquent implementation.
Usage
To set up Eloquent you don't need Laravel or Lumen frameworks at all. This is how you use Eloquent in any project.
Now that Eloquent is running, we can use the Repository.
One Repository for One Eloquent Model
A well defined repository returns one kind of objects that belong to one Business model.
To be faithful to the repository pattern, using Eloquent Models internally is OK, but Business objects should be returned.
Therefore, you should translate Eloquent to Business representations and the other way round. This is represented by $userAdapter in the example below.
The fully implementation should be along the lines:
A sample implementation can be found in the /example directory.
One EloquentRepository for All Eloquent Models
While this is not the recommended way, as a repository should only return one kind of Business objects, this works well with Laravel projects.
While the amount of core is less than the previous example, bare in mind that your code will be coupled with Eloquent.
Filtering data
Filtering is as simple as using the Filter object. For instance, lets retrieve how many users are named Ken.
Notice how the key name matches the database column name in the users table.
Available options
Filter allow you to use must(), mustNot() and should() methods to set up a fine-grained search. These provide a fluent interface with the following methods available:
public function notEmpty($filterName)public function hasEmpty($filterName)public function startsWith($filterName, $value)public function endsWith($filterName, $value)public function equal($filterName, $value)public function notEqual($filterName, $value)public function includeGroup($filterName, array $value)public function notIncludeGroup($filterName, array $value)public function range($filterName, $firstValue, $secondValue)public function notRange($filterName, $firstValue, $secondValue)public function notContain($filterName, $value)public function contain($filterName, $value)public function beGreaterThanOrEqual($filterName, $value)public function beGreaterThan($filterName, $value)public function beLessThanOrEqual($filterName, $value)public function beLessThan($filterName, $value)
Sorting data
Sorting is straight forward. Create an instance of Sort and pass in the column names and ordering.
Fields data
Create a Fields object to fetch only selected columns. If no Fields object is passed, all columns are selected by default.
Fetching data
Repository allows you to fetch data from the database by using the following methods:
public function findAll(Pageable $pageable = null)public function find(Identity $id, Fields $fields = null)public function findBy(Filter $filter = null, Sort $sort = null, Fields $fields = null)
Quality
To run the PHPUnit tests at the command line, go to the tests directory and issue phpunit.
This library attempts to comply with PSR-1, PSR-2, PSR-4.
If you notice compliance oversights, please send a patch via Pull Request.
Contribute
Contributions to the package are always welcome!
- Report any bugs or issues you find on the issue tracker.
- You can grab the source code at the package's Git Repository.
Support
Get in touch with me using one of the following means:
- Emailing me at [email protected]
- Opening an Issue
Authors
License
The code base is licensed under the MIT license.
All versions of eloquent-repository with dependencies
nilportugues/assert Version ^1.0
illuminate/database Version ^5.2
illuminate/pagination Version ^5.2