RecordSource::setSelector() - Code Metrics - spiral/orm - Measure and Improve Code Quality continuously with Scrutinizer

RecordSource::setSelector() A
last analyzed 2018-08-29 15:23 UTC

↳ Parent: RecordSource

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * Spiral, Core Components
 *
 * @author Wolfy-J
 */

namespace Spiral\ORM\Entities;

use Spiral\Core\Component;
use Spiral\Core\Traits\SaturateTrait;
use Spiral\Models\EntityInterface;
use Spiral\ORM\Exceptions\SourceException;
use Spiral\ORM\ORMInterface;
use Spiral\ORM\Record;

/**
 * Source class associated to one ORM model. Source can be used to write your own custom find
 * method or change default selection.
 */
class RecordSource extends Component implements \Countable, \IteratorAggregate
{
    use SaturateTrait;

    /**
     * Linked record model. ORM can automatically index and link user sources to models based on
     * value of this constant.
     *
     * Use this constant in custom source implementation in order to automatically link it to
     * appropriate model AND be able to create source as constructor or method injection without
     * ORM dependency.
     */
    const RECORD = null;

    /**
     * @var RecordSelector
     */
    private $selector;

    /**
     * Associated document class.
     *
     * @var string
     */
    private $class = null;

    /**
     * @invisible
     *
     * @var ORMInterface
     */
    protected $orm = null;

    /**
     * @param string       $class
     * @param ORMInterface $orm
     *
     * @throws SourceException
     */
    public function __construct(string $class = null, ORMInterface $orm = null)
    {
        if (empty($class)) {
            if (empty(static::RECORD)) {
                throw new SourceException('Unable to create source without associated class');
            }

            $class = static::RECORD;
        }

        $this->class = $class;
        $this->orm = $this->saturate($orm, ORMInterface::class);
    }

    /**
     * Associated class.
     *
     * @return string
     */
    public function getClass(): string
    {
        return $this->class;
    }

    /**
     * Associated ORM manager.
     *
     * @return ORMInterface
     */
    public function getORM(): ORMInterface
    {
        return $this->orm;
    }

    /**
     * Create new DocumentEntity based on set of provided fields.
     *
     * @final Change static method of entity, not this one.
     *
     * @param array  $fields
     * @param string $class  Due ODM models can be inherited you can use this argument to specify
     *                       custom model class.
     *
     * @return EntityInterface|Record
     */
    public function create($fields = [], string $class = null): EntityInterface
    {
        //Create model with filtered set of fields
        return $this->orm->make($class ?? $this->class, $fields, ORMInterface::STATE_NEW);
    }

    /**
     * Find document by it's primary key.
     *
     * @see findOne()
     *
     * @param string|int $id   Primary key value.
     * @param array      $load Relations to pre-load.
     *
     * @return EntityInterface|Record|null
     */
    public function findByPK($id, array $load = [])
    {
        return $this->getSelector()->wherePK($id)->load($load)->findOne();
    }

    /**
     * Select one document from mongo collection.
     *
     * @param array $query  Fields and conditions to query by.
     * @param array $sortBy Always specify sort by to ensure that results are stable.
     * @param array $load   Relations to pre-load.
     *
     * @return EntityInterface|Record|null
     */
    public function findOne(array $query = [], array $sortBy = [], array $load = [])
    {
        return $this->getSelector()->orderBy($sortBy)->load($load)->findOne($query);
    }

    /**
     * Get associated document selection with pre-configured query (if any).
     *
     * @param array $query
     *
     * @return RecordSelector
     */
    public function find(array $query = []): RecordSelector
    {
        return $this->getSelector()->where($query);
    }

    /**
     * @param array  $query
     * @param string $column Column to count by, PK or * by default.
     *
     * @return int
     */
    public function count(array $query = [], string $column = null): int
    {
        return $this->getSelector()->where($query)->count();
    }

    /**
     * @return RecordSelector
     */
    public function getIterator(): RecordSelector
    {
        return $this->getSelector();
    }

    /**
     * Create source with new associated selector.
     *
     * @param RecordSelector $selector
     *
     * @return RecordSource
     */
    public function withSelector(RecordSelector $selector): RecordSource
    {
        $source = clone $this;
        $source->setSelector($selector);

        return $source;
    }

    /**
     * Set initial selector.
     *
     * @param RecordSelector $selector
     */
    protected function setSelector(RecordSelector $selector)
    {
        $this->selector = clone $selector;
    }

    /**
     * Get associated selector.
     *
     * @return RecordSelector
     */
    protected function getSelector(): RecordSelector
    {
        if (empty($this->selector)) {
            //Requesting selector on demand
            $this->selector = $this->orm->selector($this->class);
        }

        return clone $this->selector;
    }

    /**
     * {@inheritdoc}
     */
    protected function iocContainer()
    {
        if ($this->orm instanceof Component) {
            //Always work in ODM scope
            return $this->orm->iocContainer();
        }

        return parent::iocContainer();
    }
}

1			<?php
2			/**
3			* Spiral, Core Components
4			*
5			* @author Wolfy-J
6			*/
7
8			namespace Spiral\ORM\Entities;
9
10			use Spiral\Core\Component;
11			use Spiral\Core\Traits\SaturateTrait;
12			use Spiral\Models\EntityInterface;
13			use Spiral\ORM\Exceptions\SourceException;
14			use Spiral\ORM\ORMInterface;
15			use Spiral\ORM\Record;
16
17			/**
18			* Source class associated to one ORM model. Source can be used to write your own custom find
19			* method or change default selection.
20			*/
21			class RecordSource extends Component implements \Countable, \IteratorAggregate
22			{
23			use SaturateTrait;
24
25			/**
26			* Linked record model. ORM can automatically index and link user sources to models based on
27			* value of this constant.
28			*
29			* Use this constant in custom source implementation in order to automatically link it to
30			* appropriate model AND be able to create source as constructor or method injection without
31			* ORM dependency.
32			*/
33			const RECORD = null;
34
35			/**
36			* @var RecordSelector
37			*/
38			private $selector;
39
40			/**
41			* Associated document class.
42			*
43			* @var string
44			*/
45			private $class = null;
46
47			/**
48			* @invisible
49			*
50			* @var ORMInterface
51			*/
52			protected $orm = null;
53
54			/**
55			* @param string $class
56			* @param ORMInterface $orm
57			*
58			* @throws SourceException
59			*/
60			public function __construct(string $class = null, ORMInterface $orm = null)
61			{
62			if (empty($class)) {
63			if (empty(static::RECORD)) {
64			throw new SourceException('Unable to create source without associated class');
65			}
66
67			$class = static::RECORD;
68			}
69
70			$this->class = $class;
71			$this->orm = $this->saturate($orm, ORMInterface::class);
72			}
73
74			/**
75			* Associated class.
76			*
77			* @return string
78			*/
79			public function getClass(): string
80			{
81			return $this->class;
82			}
83
84			/**
85			* Associated ORM manager.
86			*
87			* @return ORMInterface
88			*/
89			public function getORM(): ORMInterface
90			{
91			return $this->orm;
92			}
93
94			/**
95			* Create new DocumentEntity based on set of provided fields.
96			*
97			* @final Change static method of entity, not this one.
98			*
99			* @param array $fields
100			* @param string $class Due ODM models can be inherited you can use this argument to specify
101			* custom model class.
102			*
103			* @return EntityInterface\|Record
104			*/
105			public function create($fields = [], string $class = null): EntityInterface
106			{
107			//Create model with filtered set of fields
108			return $this->orm->make($class ?? $this->class, $fields, ORMInterface::STATE_NEW);
109			}
110
111			/**
112			* Find document by it's primary key.
113			*
114			* @see findOne()
115			*
116			* @param string\|int $id Primary key value.
117			* @param array $load Relations to pre-load.
118			*
119			* @return EntityInterface\|Record\|null
120			*/
121			public function findByPK($id, array $load = [])
122			{
123			return $this->getSelector()->wherePK($id)->load($load)->findOne();
124			}
125
126			/**
127			* Select one document from mongo collection.
128			*
129			* @param array $query Fields and conditions to query by.
130			* @param array $sortBy Always specify sort by to ensure that results are stable.
131			* @param array $load Relations to pre-load.
132			*
133			* @return EntityInterface\|Record\|null
134			*/
135			public function findOne(array $query = [], array $sortBy = [], array $load = [])
136			{
137			return $this->getSelector()->orderBy($sortBy)->load($load)->findOne($query);
138			}
139
140			/**
141			* Get associated document selection with pre-configured query (if any).
142			*
143			* @param array $query
144			*
145			* @return RecordSelector
146			*/
147			public function find(array $query = []): RecordSelector
148			{
149			return $this->getSelector()->where($query);
150			}
151
152			/**
153			* @param array $query
154			* @param string $column Column to count by, PK or * by default.
155			*
156			* @return int
157			*/
158			public function count(array $query = [], string $column = null): int
159			{
160			return $this->getSelector()->where($query)->count();
161			}
162
163			/**
164			* @return RecordSelector
165			*/
166			public function getIterator(): RecordSelector
167			{
168			return $this->getSelector();
169			}
170
171			/**
172			* Create source with new associated selector.
173			*
174			* @param RecordSelector $selector
175			*
176			* @return RecordSource
177			*/
178			public function withSelector(RecordSelector $selector): RecordSource
179			{
180			$source = clone $this;
181			$source->setSelector($selector);
182
183			return $source;
184			}
185
186			/**
187			* Set initial selector.
188			*
189			* @param RecordSelector $selector
190			*/
191			protected function setSelector(RecordSelector $selector)
192			{
193			$this->selector = clone $selector;
194			}
195
196			/**
197			* Get associated selector.
198			*
199			* @return RecordSelector
200			*/
201			protected function getSelector(): RecordSelector
202			{
203			if (empty($this->selector)) {
204			//Requesting selector on demand
205			$this->selector = $this->orm->selector($this->class);
206			}
207
208			return clone $this->selector;
209			}
210
211			/**
212			* {@inheritdoc}
213			*/
214			protected function iocContainer()
215			{
216			if ($this->orm instanceof Component) {
217			//Always work in ODM scope
218			return $this->orm->iocContainer();
219			}
220
221			return parent::iocContainer();
222			}
223			}

spiral / orm

RecordSource::setSelector() A last analyzed 2018-08-29 15:23 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

RecordSource::setSelector() A
last analyzed 2018-08-29 15:23 UTC