Repository
Litepie Repository is used to abstract the data layer. This allows the user to create a more flexible application and further providing an ease of maintenance on the same.
Repository Interface
The Link to the same can be found under
Litepie\Repository\Contracts\RepositoryInterface
The following methods are present under the Repository Interface
all($columns = array('*'))
first($columns = array('*'))
paginate($limit = null, $columns = ['*'])
find($id, $columns = ['*'])
findByField($field, $value, $columns = ['*'])
findWhere(array $where, $columns = ['*'])
findWhereIn($field, array $where, $columns = [*])
findWhereNotIn($field, array $where, $columns = [*])
create(array $attributes)
update(array $attributes, $id)
delete($id)
with(array $relations);
hidden(array $fields);
visible(array $fields);
scopeQuery(Closure $scope);
getFieldsSearchable();
setPresenter($presenter);
skipPresenter($status = true);
Repository Criteria Interface
The Link to the same can be found under
Litepie\Repository\Contracts\RepositoryCriteriaInterface
The following methods are present under the Repository Criteria Interface
pushCriteria(CriteriaInterface $criteria)
getCriteria()
getByCriteria(CriteriaInterface $criteria)
skipCriteria($status = true)
getFieldsSearchable()
Cacheable Interface
The Link to the same can be found under
Litepie\Repository\Contracts\CacheableInterface
The following methods are present under the Cacheable Interface
setCacheRepository(CacheRepository $repository)
getCacheRepository()
getCacheKey($method, $args = null)
getCacheMinutes()
skipCache($status = true)
Presenter Interface
The Link to the same can be found under
Litepie\Repository\Contracts\PresenterInterface
The following methods are present under the Cacheable Interface
present($data);
Presentable
The Link to the same can be found under
Litepie\Repository\Contracts\Presentable
The following methods are present under Presentable
setPresenter(PresenterInterface $presenter);
presenter();
Criteria Interface
The Link to the same can be found under
Litepie\Repository\Contracts\CriteriaInterface
The following methods under Criteria interface are as follows
apply($model, RepositoryInterface $repository);
Transformable
The Link to the same can be found under
Litepie\Repository\Contracts\Transformable
The following methods under Tranformable are as follows
transform();
USAGE
CREATE A MODEL
The user can use the code to create a model normally, however it is important to ensure that attributes are defined from the input data.
namespace App;
class Post extends Eloquent { // or Ardent, Or any other Model Class
protected $fillable = [
'title',
'author',
...
];
...
}
CREATE A REPOSITORY
The user can develop a Repository for your Database by extending the Base repository.
namespace App;
use Litepie\Repository\Eloquent\BaseRepository;
class PostRepository extends BaseRepository {
/**
* Specify Model class name
*
* @return string
*/
function model()
{
return "App\\Post";
}
}
GENERATORS
The Generators have enable users to create Repositories with ease.
Config
The user must first configure the respective storage location of the repository files. This is by default done through the "app" folder and the namespace "App".
...
'generator'=>[
'basePath'=>app_path(),
'rootNamespace'=>'App\\',
'paths'=>[
'models'=>'Entities',
'repositories'=>'Repositories',
'interfaces'=>'Repositories',
'transformers'=>'Transformers',
'presenters'=>'Presenters'
]
]
The user may want to save the root of your project folder outside the location of the app and add another namespace, For Eg.
...
'generator'=>[
'basePath' => base_path('src/Lorem'),
'rootNamespace' => 'Lorem\\'
]
Additionally, the user may wish to customize where your generated classes gets saved. This can be accomplished by editing the paths node to your liking. For Eg.
'generator'=>[
'basePath'=>app_path(),
'rootNamespace'=>'App\\',
'paths'=>[
'models'=>'Models',
'repositories'=>'Repositories\\Eloquent',
'interfaces'=>'Contracts\\Repositories',
'transformers'=>'Transformers',
'presenters'=>'Presenters'
]
]
COMMANDS
In order to generate all the functions that the user needs for the respective Model, this command can be run:
php artisan make:entity Post
This will create the Model, the Repository, the Presenter and the Transformer classes.
The user can also pass the options from the repository command, since this command is just a wrapper.
To generate a repository for your Post model, the following command can be utilized
php artisan make:repository Post
If you would like to implement a namespace to your blog, you could utilize the following command.
php artisan make:repository "Blog\Post"
There are certain Added fields that are fillable by the user.
php artisan make:repository "Blog\Post" --fillable="title,content"
When the user is running commado, he/she will be creating the "Entities" folder and "Repositories" inside the folder that you set as the default.
Done, done that just now you do bind its interface for your real repository, for example in your own Repositories Service Provider.
App::bind('{YOUR_NAMESPACE}Repositories\PostRepository', '{YOUR_NAMESPACE}Repositories\PostRepositoryEloquent');
And use
public function __construct({YOUR_NAMESPACE}Repositories\PostRepository $repository){
$this->repository = $repository;
}
USE METHOD
namespace App\Http\Controllers;
use App\PostRepository;
class PostsController extends BaseController {
/**
* @var PostRepository
*/
protected $repository;
public function __construct(PostRepository $repository){
$this->repository = $repository;
}
....
}
Find all results in Repository
$posts = $this->repository->all();
Find all results in Repository with pagination
$posts = $this->repository->paginate($limit = null, $columns = ['*']);
Find by result by id
$post = $this->repository->find($id);
Hiding attributes of the model
$post = $this->repository->hidden(['country_id'])->find($id);
Showing only specific attributes of the model
$post = $this->repository->visible(['id', 'state_id'])->find($id);
Loading the Model relationships
$post = $this->repository->with(['state'])->find($id);
Find by result by field name
$posts = $this->repository->findByField('country_id','15');
Find by result by multiple fields
$posts = $this->repository->findWhere([
//Default Condition =
'state_id'=>'10',
'country_id'=>'15',
//Custom Condition
['columnName','>','10']
]);
Find by result by multiple values in one field
$posts = $this->repository->findWhereIn('id', [1,2,3,4,5]);
Find by result by excluding multiple values in one field
$posts = $this->repository->findWhereNotIn('id', [6,7,8,9,10]);
Find all using custom scope
$posts = $this->repository->scopeQuery(function($query){
return $query->orderBy('sort_order','asc');
})->all();
Create new entry in Repository
$post = $this->repository->create( Input::all() );
Update entry in Repository
$post = $this->repository->update( Input::all(), $id );
Delete entry in Repository
$this->repository->delete($id)
CREATE A CRITERIA
The Criteria is a way to change the repository of the query by applying specific conditions according to the user's needs. The user can add multiple Criteria into the repository.
use Litepie\Repository\Contracts\RepositoryInterface;
use Litepie\Repository\Contracts\CriteriaInterface;
class MyCriteria implements CriteriaInterface {
public function apply($model, RepositoryInterface $repository)
{
$model = $model->where('user_id','=', Auth::user()->id );
return $model;
}
}
USING THE CRITERIA IN A CONTROLLER
The criteria can be utilized in the controller using the following code.
namespace App\Http\Controllers;
use App\PostRepository;
class PostsController extends BaseController {
/**
* @var PostRepository
*/
protected $repository;
public function __construct(PostRepository $repository){
$this->repository = $repository;
}
public function index()
{
$this->repository->pushCriteria(new MyCriteria());
$posts = $this->repository->all();
...
}
}
The user could obtain the results from Criteria utilizing the following code.
$posts = $this->repository->getByCriteria(new MyCriteria());
The user can set the default Criteria in Repository
use Litepie\Repository\Eloquent\BaseRepository;
class PostRepository extends BaseRepository {
public function boot(){
$this->pushCriteria(new MyCriteria());
$this->pushCriteria(new AnotherCriteria());
...
}
function model(){
return "App\\Post";
}
}
SKIP CRITERIA
The user can utilize the skipCriteria before any chaining method.
$posts = $this->repository->skipCriteria()->all();
USING THE REQUESTCRITERIA
The RequestCriteria is a standard Criteria implementation. It enables filters to perform in the repository from parameters sent in the request.
The user can perform a dynamic search, filter the data and customize the queries.
To use the Criteria in your repository, the user can add a new criteria in the boot method of your repository, or directly use in your controller, in order to filter out only a few requests.
ENABLING YOUR REPOSITORY
use Litepie\Repository\Eloquent\BaseRepository;
use Litepie\Repository\Criteria\RequestCriteria;
class PostRepository extends BaseRepository {
/**
* @var array
*/
protected $fieldSearchable = [
'name',
'email'
];
public function boot(){
$this->pushCriteria(app('Litepie\Repository\Criteria\RequestCriteria'));
...
}
function model(){
return "App\\Post";
}
}
The user would need to define which fields from the model can be searchable.
In the repository the fields that are searchable should be set to $fieldSearchable.
protected $fieldSearchable = [
'name',
'email'
];
You can set the type of condition which will be used to perform the query, the default condition is "="
protected $fieldSearchable = [
'name'=>'like',
'email', // Default Condition "="
'your_field'=>'condition'
];
ENABLING IN CONTROLLER
public function index()
{
$this->repository->pushCriteria(app('Litepie\Repository\Criteria\RequestCriteria'));
$posts = $this->repository->all();
...
}
EXAMPLE THE CRITERIA
The user can Request all data without filter by request
http://prettus.local/users
[
{
"id": 1,
"name": "John Doe",
"email": "[email protected]",
"created_at": "-0001-11-30 00:00:00",
"updated_at": "-0001-11-30 00:00:00"
},
{
"id": 2,
"name": "Lorem Ipsum",
"email": "[email protected]",
"created_at": "-0001-11-30 00:00:00",
"updated_at": "-0001-11-30 00:00:00"
},
{
"id": 3,
"name": "Laravel",
"email": "[email protected]",
"created_at": "-0001-11-30 00:00:00",
"updated_at": "-0001-11-30 00:00:00"
}
]
Conducting research in the repository
http://prettus.local/users?search=John%20Doe
Or
http://prettus.local/users?search=John&searchFields=name:like
Or
http://prettus.local/[email protected]&searchFields=email:=
Or
http://prettus.local/users?search=name:John Doe;email:[email protected]
Or
http://prettus.local/users
?search=name:John;email:[email protected]&searchFields=name:like;email:=
[
{
"id": 1,
"name": "John Doe",
"email": "[email protected]",
"created_at": "-0001-11-30 00:00:00",
"updated_at": "-0001-11-30 00:00:00"
}
]
Filtering fields
http://prettus.local/users?filter=id;name
[
{
"id": 1,
"name": "John Doe"
},
{
"id": 2,
"name": "Lorem Ipsum"
},
{
"id": 3,
"name": "Laravel"
}
]
Sorting the results
http://prettus.local/users?filter=id;name&orderBy=id&sortedBy=desc
[
{
"id": 3,
"name": "Laravel"
},
{
"id": 2,
"name": "Lorem Ipsum"
},
{
"id": 1,
"name": "John Doe"
}
]
Add relationship
http://prettus.local/users?with=groups
OVERWRITE PARAMS NAME
The user can change the name of the parameters in the configuration file config/repository.php
CACHE
The user can further add a layer of cache easily to your repository
Cache Usage
Implements the interface CacheableInterface and use CacheableRepository Trait.
use Litepie\Repository\Eloquent\BaseRepository;
use Litepie\Repository\Contracts\CacheableInterface;
use Litepie\Repository\Traits\CacheableRepository;
class PostRepository extends BaseRepository implements CacheableInterface {
use CacheableRepository;
...
}
Here the repository will be cached , and the repository cache is cleared whenever an item is created, modified or deleted.
Cache Config
You can change the cache settings in the file config/repository.php and also directly on your repository.
config/repository.php
'cache'=>[
//Enable or disable cache repositories
'enabled' => true,
//Lifetime of cache
'minutes' => 30,
//Repository Cache, implementation Illuminate\Contracts\Cache\Repository
'repository'=> 'cache',
//Sets clearing the cache
'clean' => [
//Enable, disable clearing the cache on changes
'enabled' => true,
'on' => [
//Enable, disable clearing the cache when you create an item
'create'=>true,
//Enable, disable clearing the cache when upgrading an item
'update'=>true,
//Enable, disable clearing the cache when you delete an item
'delete'=>true,
]
],
'params' => [
//Request parameter that will be used to bypass the cache repository
'skipCache'=>'skipCache'
],
'allowed'=>[
//Allow caching only for some methods
'only' =>null,
//Allow caching for all available methods, except
'except'=>null
],
],
Further, it is possible to override these settings directly in the repository.
use Litepie\Repository\Eloquent\BaseRepository;
use Litepie\Repository\Contracts\CacheableInterface;
use Litepie\Repository\Traits\CacheableRepository;
class PostRepository extends BaseRepository implements CacheableInterface {
// Setting the lifetime of the cache to a repository specifically
protected $cacheMinutes = 90;
protected $cacheOnly = ['all', ...];
//or
protected $cacheExcept = ['find', ...];
use CacheableRepository;
...
}
The cacheable methods are : all, paginate, find, findByField, findWhere, getByCriteria
VALIDATORS
Requires prettus/laravel-validator.
composer require prettus/laravel-validator
USING A VALIDATOR CLASS
Create a Validator
In the example below, we define some rules for both creation and edition.
use \Prettus\Validator\LaravelValidator;
class PostValidator extends LaravelValidator {
protected $rules = [
'title' => 'required',
'text' => 'min:3',
'author'=> 'required'
];
}
To define specific rules, proceed as shown below:
use \Prettus\Validator\Contracts\ValidatorInterface;
use \Prettus\Validator\LaravelValidator;
class PostValidator extends LaravelValidator {
protected $rules = [
ValidatorInterface::RULE_CREATE => [
'title' => 'required',
'text' => 'min:3',
'author'=> 'required'
],
ValidatorInterface::RULE_UPDATE => [
'title' => 'required'
]
];
}
Enabling Validator in the Repository
use Litepie\Repository\Eloquent\BaseRepository;
use Litepie\Repository\Criteria\RequestCriteria;
class PostRepository extends BaseRepository {
/**
* Specify Model class name
*
* @return mixed
*/
function model(){
return "App\\Post";
}
/**
* Specify Validator class name
*
* @return mixed
*/
public function validator()
{
return "App\\PostValidator";
}
}
Defining rules in the repository
Alternatively, instead of using a class to define its validation rules, the user can set your rules directly into the rules repository property, it will have the same effect as a Validation class.
use Litepie\Repository\Eloquent\BaseRepository;
use Litepie\Repository\Criteria\RequestCriteria;
use Prettus\Validator\Contracts\ValidatorInterface;
class PostRepository extends BaseRepository {
/**
* Specify Validator Rules
* @var array
*/
protected $rules = [
ValidatorInterface::RULE_CREATE => [
'title' => 'required',
'text' => 'min:3',
'author'=> 'required'
],
ValidatorInterface::RULE_UPDATE => [
'title' => 'required'
]
];
/**
* Specify Model class name
*
* @return mixed
*/
function model(){
return "App\\Post";
}
}
Validation is now ready. In case of a failure an exception will be given of the type: Prettus\Validator\Exceptions\ValidatorException
Presenters
Presenters function as a wrapper within the system and also a renderer for objects
Fractal Presenter
This requires Fractal
composer require league/fractal
There are two ways to implement the Presenter,
-
The first is creating a TransformerAbstract and setting it using your Presenter class as described in the Create a Transformer Class.
-
The second way is to make your model implement the Transformable interface, and use the default Presenter ModelFractarPresenter, this will have the same effect.
Transformer Class
You can Create a transformer class using the following command.
php artisan make:transformer Post
The code would generate the following class
use League\Fractal\TransformerAbstract;
class PostTransformer extends TransformerAbstract
{
public function transform(\Post $post)
{
return [
'id' => (int) $post->id,
'title' => $post->title,
'content' => $post->content
];
}
}
Create a Presenter
Create a Presenter using the command
php artisan make:presenter Post
The command will further prompt you for creating a Transformer too if you haven't already.
Create a Presenter
use Litepie\Repository\Presenter\FractalPresenter;
class PostPresenter extends FractalPresenter {
/**
* Prepare data to present
*
* @return \League\Fractal\TransformerAbstract
*/
public function getTransformer()
{
return new PostTransformer();
}
}
Enabling in your Repository
use Litepie\Repository\Eloquent\BaseRepository;
class PostRepository extends BaseRepository {
...
public function presenter()
{
return "App\\Presenter\\PostPresenter";
}
}
Or enable it in your controller with the following code
$this->repository->setPresenter("App\\Presenter\\PostPresenter");
Using the presenter after from the Model
If you recorded a presenter and sometime used the skipPresenter() method or simply you do not want your result is not changed automatically by the presenter. You can implement Presentable interface on your model so you will be able to present your model at any time.
In your model, implement the interface
Litepie\Repository\Contracts\Presentable
And
Litepie\Repository\Traits\PresentableTrait
namespace App;
use Litepie\Repository\Contracts\Presentable;
use Litepie\Repository\Traits\PresentableTrait;
class Post extends Eloquent implements Presentable {
use PresentableTrait;
protected $fillable = [
'title',
'author',
...
];
...
}
Once thsi is done, the user can submit your Model individually, See an example:
$repository = app('App\PostRepository');
$repository->setPresenter("Litepie\\Repository\\Presenter\\ModelFractalPresenter");
//Getting the result transformed by the presenter directly in the search
$post = $repository->find(1);
print_r( $post ); //It produces an output as array
...
//Skip presenter and bringing the original result of the Model
$post = $repository->skipPresenter()->find(1);
print_r( $post ); //It produces an output as a Model object
print_r( $post->presenter() ); //It produces an output as array
You can skip the presenter at every visit and use it on demand directly into the model, for it set the $skipPresenter attribute to true in your repository:
use Litepie\Repository\Eloquent\BaseRepository;
class PostRepository extends BaseRepository {
/**
* @var bool
*/
protected $skipPresenter = true;
public function presenter()
{
return "App\\Presenter\\PostPresenter";
}
}
Model Class
Implement Interface
namespace App;
use Litepie\Repository\Contracts\Transformable;
class Post extends Eloquent implements Transformable {
...
/**
* @return array
*/
public function transform()
{
return [
'id' => (int) $this->id,
'title' => $this->title,
'content' => $this->content
];
}
}
Enabling in your Repository
Litepie\Repository\Presenter\ModelFractalPresenter
This Presenter is available for all Models which iplements Transformable
use Litepie\Repository\Eloquent\BaseRepository;
class PostRepository extends BaseRepository {
...
public function presenter()
{
return "Litepie\\Repository\\Presenter\\ModelFractalPresenter";
}
}
You can also enable it in your controller with
$this->repository->setPresenter("Litepie\\Repository\\Presenter\\ModelFractalPresenter");
Skip Presenter defined in the repository
Use skipPresenter before any other chaining method
$posts = $this->repository->skipPresenter()->all();
Or
$this->repository->skipPresenter();
$posts = $this->repository->all();
Updated less than a minute ago