2017 © Pedro Peláez
 

library laravel-repositories

Provides an easy way to create your laravel repositories

image

reynholm/laravel-repositories

Provides an easy way to create your laravel repositories

  • Thursday, June 4, 2015
  • by carlosgoce
  • Repository
  • 0 Watchers
  • 0 Stars
  • 35 Installations
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 14 Versions
  • 0 % Grown

The README.md

Laravel Repositories

Latest Stable Version Build Status Coverage Status Total Downloads License, (*1)

Repository pattern for Laravel, (*2)

Installation and Configuration

Add this to your composer.json, (*3)

{
    "require": {
        "reynholm/laravel-repositories": "0.17.*"
    }
}

Notice

I think that you can use it even that is on an early stage, but I may make some breaking changes so if you don't want any surprises just don't put "dev-master" or an asterisk as your composer version. Be smart!, (*4)

If you put your version like on the above example you will not get any breaking changes., (*5)

Usage

Simply extend the abstract class Reynholm\LaravelRepositories\Repository\LaravelRepository, (*6)

Example


use Reynholm\LaravelRepositories\Repository\LaravelRepository;

class UserArrayRepository extends LaravelRepository
{
    //defaults to laravel's default connection
    //protected $connection = 'mysql';

    //If no tableName is specified it will be guessed based on a snake_case version of the CamelCase
    //class name without the repository part and pluralized.
    //Examples: UserRepository => users, CustomerHistoryLog => customer_history_logs, etc...
    //protected $tableName  = 'users';
}

Fetch Mode

You can also choose the fetcher that you like the most or create your own. You can select the one that you prefer from the LaravelRepositoryInterface constants. Example:, (*7)

    class YourRepository extends LaravelRepository {
        protected $fetchMode = LaravelRepositoryInterface::FETCH_AS_LARAVEL_COLLECTION_OBJECTS;
    }

So the repository will return a Illuminate\Support\Collection with objects., (*8)

Currently implemented methods:, (*9)


     /**
      * @param int $id
      * @param array $columns Restrict columns that you want to retrieve
      * @return array
      */
     public function find($id, array $columns = array());

     /**
      * @param int $id
      * @param array $columns Restrict columns that you want to retrieve
      * @return array
      * @throws EntityNotFoundException
      */
     public function findOrFail($id, array $columns = array());

     /**
      * @param array $criteria
      * Ex.:
      * array(
      *     array('name', '=', 'carlos'),
      *     array('age',  '>', 20),
      * )
      * @param array $columns Restrict columns that you want to retrieve
      * @return array
      */
     public function findOne(array $criteria, array $columns = array());

     /**
      * @param array $criteria
      * Ex.:
      * array(
      *     array('name', '=', 'carlos'),
      *     array('age',  '>', 20),
      * )
      * @param array $columns Restrict columns that you want to retrieve
      * @param integer $limit
      * @param array $orderBy
      * Ex.:
      * array(
      *     array('name', 'asc'),
      *     array('age', 'desc'),
      * )
      * @return array
      */
     public function findMany(array $criteria, array $columns = array(), $limit = 0, array $orderBy = array());

     /**
      * @param array $columns Restrict columns that you want to retrieve
      * @param int $limit
      * @param array $orderBy
      * Ex.: ['name' => 'asc', 'age' => 'desc']
      * @return array
      */
     public function findAll(array $columns = array(), $limit = 0, array $orderBy = array());

     /**
      * Get an array with the values of a given column.
      *
      * @param  string  $column
      * @param  string  $key
      * @return array
      */
     public function lists($column, $key = null);

     /**
      * @param array $data The resource that you want to create
      * @param bool $force If force is false and data is not valid error will be thrown
      * @return boolean
      * @throws DataNotValidException
      */
     public function create(array $data, $force = false);

     /**
      * @param array $data The resources that you want to create
      * @param bool $force If force is false and data is not valid error will be thrown
      * @return boolean
      * @throws DataNotValidException
      */
     public function createMany(array $data, $force = false);

     /**
      * @param array $criteria
      * Ex.:
      * array(
      *     array('name', '=', 'carlos'),
      *     array('age',  '>', 20),
      * )
      * @return int
      */
     public function count(array $criteria = array());

    /**
     * Update a resource by its id
     * @param int $id
     * @param array $data
     * @return boolean
     */
    public function update($id, array $data);

    /**
     * Update one or more resources
     * @param array $criteria
     * @param array $data
     * @return int Number of affected rows
     */
    public function updateMany(array $criteria, array $data);

     /**
      * Validates the input array and stores all the errors,
      * them, you can get them with the getValidationErrors() method
      * @param array $data
      * @return boolean
      */
     public function validate(array $data);

     /**
      * Validates the input array and stores all the errors,
      * them, you can get them with the getValidationErrors() method
      * Same as validate but specify the rules, instead of using the repository rules
      * @param array $data
      * @param array $rules
      * @return boolean
      */
     public function validateWithCustomRules(array $data, array $rules);

     /**
      * Validates the input array or throws exception
      * It also stores all the errors. Then you can retrieve them with the
      * getValidationErrors() method
      * @param array $data
      * @throws DataNotValidException
      * @return void
      */
     public function validateOrFail(array $data);

     /**
      * Validates the input array or throws exception
      * It also stores all the errors. Then you can retrieve them with the
      * getValidationErrors() method
      * @param array $data
      * @param array $rules
      * @throws DataNotValidException
      * @return void
      */
     public function validateWithCustomRulesOrFail(array $data, array $rules);

     /**
      * Validates a multidimensional
      * It also stores all the errors. Then you can retrieve them with the
      * getValidationErrors() method
      * @param array $data
      * @return boolean
      */
     public function validateMany(array $data);

     /**
      * Validates a multidimensional
      * It also stores all the errors. Then you can retrieve them with the
      * getValidationErrors() method
      * Same as validate but specify the rules, instead of using the repository rules
      * @param array $data
      * @param array $rules
      * @return boolean
      */
     public function validateManyWithCustomRules(array $data, array $rules);

     /**
      * Validates a multidimensional or throws exception
      * It also stores all the errors. Then you can retrieve them with the
      * getValidationErrors() method
      * @param array $data
      * @throws DataNotValidException
      */
     public function validateManyOrFail(array $data);

     /**
      * Validates a multidimensional or throws exception
      * It also stores all the errors. Then you can retrieve them with the
      * getValidationErrors() method
      * @param array $data
      * @param array $rules
      * @throws DataNotValidException
      */
     public function validateManyWithCustomRulesOrFail(array $data, array $rules);

    /**
     * Returns the errors generated by the validate methods
     * with the keys "messages" and "failed"
     * If you used validateMany it will be a multidimensional array
     * @return array
     */
    public function getValidationErrors();

    /**
    * Return the messages key from the getValidationErrors method
    * If used after validateMany it will be a multidimensional array
    * @return array
    */
    public function getValidationMessages();

    /**
    * Return the failed key from the getValidationErrors method
    * If used after validateMany it will be a multidimensional array
    * @return array
    */
    public function getValidationFailures();

     /**
      * @param int $id
      * @return boolean
      */
     public function delete($id);

     /**
      * @param int $id
      * @throw EntityNotFoundException
      */
     public function deleteOrFail($id);

     /**
      * Delete all the rows
      * @return int Number of deleted rows
      */
     public function deleteAll();

Timestamps

You can add timestamps adding the $timestamps = true property:, (*10)

class DownloadRepository extends LaravelRepository
{
    protected $timestamps = true;
}

By default it will manage created_at and updated_at fields. You can override the created and updated fields using the following properties:, (*11)

protected $stamp_create = 'created_at';
protected $stamp_update = 'updated_at';

Validation

You can validate your data with the validate methods. Specify the rules of your repository in the rules property:, (*12)

class UserArrayRepository extends LaravelRepository {

    protected $connection = 'default';
    protected $tableName  = 'users';
    protected $rules      = array(
        'name' => 'required|min:5|unique:users',
        'age'  => 'required|integer|between:0,120',
    );
}

Examples:, (*13)

if ($this->arrayRepository->validate($validData)) {
    //The data is valid
}
else {
    //The data is not valid
    //You can get the validation failed or messages this way:
    $errors = $this->arrayRepository->getValidationErrors()
    //$errors['messages'] Contains an array with the validation messages
    //$errors['failed'] Contains an array with the failed rules
}

Extending the repository with your custom methods

You can grab the builder instance with, (*14)

$this->getBuilder()

to create your custom repository methods., (*15)

Example

class MyUserRepository extends LaravelRepository
{
    public function getActiveUsers()
    {
        $result = $this->getBuilder()->whereActive(true)->get();

        //and let the fetcher do it's job
        return $this->fetchMany($result);
    }
}

A best practice would be to create a new interface for MyUsersRepository with all of the new methods that you are going to add., (*16)

interface MyUserRepositoryInterface
{
    /**
    * @return array
    */
    public function getActiveUsers();
}

And then implement it on your repository:, (*17)

class MyUserRepository extends LaravelRepository implements MyUserRepositoryInterface
{
    /**
    * {@inheritdoc}
    */
    public function getActiveUsers()
    {
        $result = $this->getBuilder()->whereActive(true)->get();

        //In order to return the data with the current fetcher use the getFetcher() method like this:
        return $this->fetchMany($result);

        //If you are returning only one entity use fetch method instead
        return $this->fetch($result);
    }
}

So if you want to change the implementation you would need to implement the MyUsersRepositoryInterface and LaravelRepositoryInterface., (*18)

Future

More features coming soon, (*19)

The Versions

04/06 2015

dev-develop

dev-develop

Provides an easy way to create your laravel repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Carlos Goce

04/06 2015

dev-master

9999999-dev

Provides an easy way to create your laravel repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Carlos Goce

database laravel repository collection repositories

30/09 2014

0.17.3

0.17.3.0

Provides an easy way to create your laravel repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Carlos Goce

database laravel repository collection repositories

29/09 2014

0.17.2

0.17.2.0

Provides an easy way to create your laravel repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Carlos Goce

database laravel repository collection repositories

26/09 2014

0.17.1

0.17.1.0

Provides an easy way to create your laravel repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Carlos Goce

25/09 2014

dev-feature/fetch-mode

dev-feature/fetch-mode

Provides an easy way to create your laravel repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Carlos Goce

25/09 2014

0.17.0

0.17.0.0

Provides an easy way to create your laravel repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Carlos Goce

03/09 2014

0.16.0

0.16.0.0

Provides an easy way to create your laravel repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Carlos Goce

02/09 2014

0.15.1

0.15.1.0

Provides an easy way to create your laravel repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Carlos Goce

02/09 2014

0.14

0.14.0.0

Provides an easy way to create your laravel repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Carlos Goce

02/09 2014

0.13

0.13.0.0

Provides an easy way to create your laravel repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Carlos Goce

01/09 2014

0.12

0.12.0.0

Provides an easy way to create your laravel repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Carlos Goce

01/09 2014

0.11

0.11.0.0

Provides an easy way to create your laravel repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Carlos Goce

01/09 2014

0.10

0.10.0.0

Provides an easy way to create your laravel repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Carlos Goce