EloquentRepository::addAll() - Code Metrics - Inspection of "Simplification of the codebase" - nilportugues/php-eloquent-repository - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (acab90)

by Nil

created 2016-04-30 10:54 UTC

EloquentRepository::addAll() A

↳ Parent: EloquentRepository

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
c	4
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php

/**
 * Author: Nil Portugués Calderó <[email protected]>
 * Date: 7/02/16
 * Time: 15:58.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace NilPortugues\Foundation\Infrastructure\Model\Repository\Eloquent;

use Illuminate\Database\Eloquent\Model;
use NilPortugues\Foundation\Domain\Model\Repository\Contracts\Fields;
use NilPortugues\Foundation\Domain\Model\Repository\Contracts\Filter;
use NilPortugues\Foundation\Domain\Model\Repository\Contracts\Identity;
use NilPortugues\Foundation\Domain\Model\Repository\Contracts\Page;
use NilPortugues\Foundation\Domain\Model\Repository\Contracts\Pageable;
use NilPortugues\Foundation\Domain\Model\Repository\Contracts\PageRepository;
use NilPortugues\Foundation\Domain\Model\Repository\Contracts\ReadRepository;
use NilPortugues\Foundation\Domain\Model\Repository\Contracts\Sort;
use NilPortugues\Foundation\Domain\Model\Repository\Contracts\WriteRepository;

abstract class EloquentRepository implements ReadRepository, WriteRepository, PageRepository
{
    /** @var Model */
    protected static $instance;

    /** @var EloquentReadRepository */
    protected $readRepository;
    /** @var EloquentWriteRepository */
    protected $writeRepository;
    /** @var EloquentPageRepository */
    protected $pageRepository;

    /**
     * EloquentRepository constructor.
     */
    public function __construct()
    {
        $eloquentModel = $this->getModelInstance();

        $this->readRepository = EloquentReadRepository::create($eloquentModel);
        $this->writeRepository = EloquentWriteRepository::create($eloquentModel);
        $this->pageRepository = EloquentPageRepository::create($eloquentModel);
    }

    /**
     * Retrieves an entity by its id.
     *
     * @param Identity|Model $id
     * @param Fields|null    $fields
     *
     * @return array
     */
    public function find(Identity $id, Fields $fields = null)
    {
        return $this->readRepository->find($id, $fields);
    }

    /**
     * Returns all instances of the type.
     *
     * @param Filter|null $filter
     * @param Sort|null   $sort
     * @param Fields|null $fields
     *
     * @return array
     */
    public function findBy(Filter $filter = null, Sort $sort = null, Fields $fields = null)
    {
        return $this->readRepository->findBy($filter, $sort, $fields);
    }

    /**
     * Returns an Eloquent Model instance.
     *
     * @return Model
     */
    protected function getModelInstance()
    {
        if (null === self::$instance) {
            $modelInstance = $this->modelClassName();
            self::$instance = new $modelInstance();
        }

        return self::$instance;
    }

    /**
     * Must return the Eloquent Model Fully Qualified Class Name as a string.
     *
     * eg: return App\Model\User::class
     *
     * @return string
     */
    abstract protected function modelClassName();

    /**
     * Returns whether an entity with the given id exists.
     *
     * @param Identity|Model $id
     *
     * @return bool
     */
    public function exists(Identity $id)
    {
        return $this->writeRepository->exists($id);
    }

    /**
     * Returns the total amount of elements in the repository given the restrictions provided by the Filter object.
     *
     * @param Filter|null $filter
     *
     * @return int
     */
    public function count(Filter $filter = null)
    {
        return $this->writeRepository->count($filter);
    }

    /**
     * Adds a new entity to the storage.
     *
     * @param Identity|Model $value
     *
     * @return mixed
     */
    public function add(Identity $value)
    {
        return $this->writeRepository->add($value);
    }

    /**
     * Adds a collections of entities to the storage.
     *
     * @param Model[] $values
     *
     * @return mixed
     *
     * @throws \Exception
     */
    public function addAll(array $values)
    {
        return $this->writeRepository->addAll($values);
    }

    /**
     * Removes the entity with the given id.
     *
     * @param Identity|Model $id
     *
     * @return bool
     */
    public function remove(Identity $id)
    {
        $this->writeRepository->remove($id);
    }

    /**
     * Removes all elements in the repository given the restrictions provided by the Filter object.
     * If $filter is null, all the repository data will be deleted.
     *
     * @param Filter $filter
     *
     * @return bool
     */
    public function removeAll(Filter $filter = null)
    {
        $this->writeRepository->removeAll($filter);
    }

    /**
     * Returns a Page of entities meeting the paging restriction provided in the Pageable object.
     *
     * @param Pageable $pageable
     *
     * @return Page
     */
    public function findAll(Pageable $pageable = null)
    {
        return $this->pageRepository->findAll($pageable);
    }

    /**
     * Returns all instances of the type meeting $distinctFields values.
     *
     * @param Fields      $distinctFields
     * @param Filter|null $filter
     * @param Sort|null   $sort
     *
     * @return array
     */
    public function findByDistinct(Fields $distinctFields, Filter $filter = null, Sort $sort = null)
    {
        return $this->readRepository->findByDistinct($distinctFields, $filter, $sort);
    }

    /**
     * Repository data is added or removed as a whole block.
     * Must work or fail and rollback any persisted/erased data.
     *
     * @param callable $transaction
     *
     * @throws \Exception
     */
    public function transactional(callable $transaction)
    {
        $this->writeRepository->transactional($transaction);
    }
}


1			<?php
2
3			/**
4			* Author: Nil Portugués Calderó <[email protected]>
5			* Date: 7/02/16
6			* Time: 15:58.
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11			namespace NilPortugues\Foundation\Infrastructure\Model\Repository\Eloquent;
12
13			use Illuminate\Database\Eloquent\Model;
14			use NilPortugues\Foundation\Domain\Model\Repository\Contracts\Fields;
15			use NilPortugues\Foundation\Domain\Model\Repository\Contracts\Filter;
16			use NilPortugues\Foundation\Domain\Model\Repository\Contracts\Identity;
17			use NilPortugues\Foundation\Domain\Model\Repository\Contracts\Page;
18			use NilPortugues\Foundation\Domain\Model\Repository\Contracts\Pageable;
19			use NilPortugues\Foundation\Domain\Model\Repository\Contracts\PageRepository;
20			use NilPortugues\Foundation\Domain\Model\Repository\Contracts\ReadRepository;
21			use NilPortugues\Foundation\Domain\Model\Repository\Contracts\Sort;
22			use NilPortugues\Foundation\Domain\Model\Repository\Contracts\WriteRepository;
23
24			abstract class EloquentRepository implements ReadRepository, WriteRepository, PageRepository
25			{
26			/** @var Model */
27			protected static $instance;
28
29			/** @var EloquentReadRepository */
30			protected $readRepository;
31			/** @var EloquentWriteRepository */
32			protected $writeRepository;
33			/** @var EloquentPageRepository */
34			protected $pageRepository;
35
36			/**
37			* EloquentRepository constructor.
38			*/
39			public function __construct()
40			{
41			$eloquentModel = $this->getModelInstance();
42
43			$this->readRepository = EloquentReadRepository::create($eloquentModel);
44			$this->writeRepository = EloquentWriteRepository::create($eloquentModel);
45			$this->pageRepository = EloquentPageRepository::create($eloquentModel);
46			}
47
48			/**
49			* Retrieves an entity by its id.
50			*
51			* @param Identity\|Model $id
52			* @param Fields\|null $fields
53			*
54			* @return array
55			*/
56			public function find(Identity $id, Fields $fields = null)
57			{
58			return $this->readRepository->find($id, $fields);
59			}
60
61			/**
62			* Returns all instances of the type.
63			*
64			* @param Filter\|null $filter
65			* @param Sort\|null $sort
66			* @param Fields\|null $fields
67			*
68			* @return array
69			*/
70			public function findBy(Filter $filter = null, Sort $sort = null, Fields $fields = null)
71			{
72			return $this->readRepository->findBy($filter, $sort, $fields);
73			}
74
75			/**
76			* Returns an Eloquent Model instance.
77			*
78			* @return Model
79			*/
80			protected function getModelInstance()
81			{
82			if (null === self::$instance) {
83			$modelInstance = $this->modelClassName();
84			self::$instance = new $modelInstance();
85			}
86
87			return self::$instance;
88			}
89
90			/**
91			* Must return the Eloquent Model Fully Qualified Class Name as a string.
92			*
93			* eg: return App\Model\User::class
94			*
95			* @return string
96			*/
97			abstract protected function modelClassName();
98
99			/**
100			* Returns whether an entity with the given id exists.
101			*
102			* @param Identity\|Model $id
103			*
104			* @return bool
105			*/
106			public function exists(Identity $id)
107			{
108			return $this->writeRepository->exists($id);
109			}
110
111			/**
112			* Returns the total amount of elements in the repository given the restrictions provided by the Filter object.
113			*
114			* @param Filter\|null $filter
115			*
116			* @return int
117			*/
118			public function count(Filter $filter = null)
119			{
120			return $this->writeRepository->count($filter);
121			}
122
123			/**
124			* Adds a new entity to the storage.
125			*
126			* @param Identity\|Model $value
127			*
128			* @return mixed
129			*/
130			public function add(Identity $value)
131			{
132			return $this->writeRepository->add($value);
133			}
134
135			/**
136			* Adds a collections of entities to the storage.
137			*
138			* @param Model[] $values
139			*
140			* @return mixed
141			*
142			* @throws \Exception
143			*/
144			public function addAll(array $values)
145			{
146			return $this->writeRepository->addAll($values);
147			}
148
149			/**
150			* Removes the entity with the given id.
151			*
152			* @param Identity\|Model $id
153			*
154			* @return bool
155			*/
156			public function remove(Identity $id)
157			{
158			$this->writeRepository->remove($id);
159			}
160
161			/**
162			* Removes all elements in the repository given the restrictions provided by the Filter object.
163			* If $filter is null, all the repository data will be deleted.
164			*
165			* @param Filter $filter
166			*
167			* @return bool
168			*/
169			public function removeAll(Filter $filter = null)
170			{
171			$this->writeRepository->removeAll($filter);
172			}
173
174			/**
175			* Returns a Page of entities meeting the paging restriction provided in the Pageable object.
176			*
177			* @param Pageable $pageable
178			*
179			* @return Page
180			*/
181			public function findAll(Pageable $pageable = null)
182			{
183			return $this->pageRepository->findAll($pageable);
184			}
185
186			/**
187			* Returns all instances of the type meeting $distinctFields values.
188			*
189			* @param Fields $distinctFields
190			* @param Filter\|null $filter
191			* @param Sort\|null $sort
192			*
193			* @return array
194			*/
195			public function findByDistinct(Fields $distinctFields, Filter $filter = null, Sort $sort = null)
196			{
197			return $this->readRepository->findByDistinct($distinctFields, $filter, $sort);
198			}
199
200			/**
201			* Repository data is added or removed as a whole block.
202			* Must work or fail and rollback any persisted/erased data.
203			*
204			* @param callable $transaction
205			*
206			* @throws \Exception
207			*/
208			public function transactional(callable $transaction)
209			{
210			$this->writeRepository->transactional($transaction);
211			}
212			}
213

nilportugues / php-eloquent-repository

Branch — master (acab90)

EloquentRepository::addAll() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like