EntityMapper::getUpdateQuery() - Code Metrics - Inspection of "Created scnarios for repository retrieve and reuse..." - slickframework/orm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2525ff...fbc36c )

by Filipe

created 2016-02-29 23:57 UTC

EntityMapper::getUpdateQuery() A

↳ Parent: EntityMapper

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	14
ccs	11
cts	11
cp	1
rs	9.4285
cc	2
eloc	11
nc	2
nop	0
crap	2

<?php

/**
 * This file is part of slick/orm package
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Slick\Orm\Mapper;

use Slick\Database\Adapter\AdapterInterface;
use Slick\Database\RecordList;
use Slick\Database\Sql;
use Slick\Orm\Descriptor\EntityDescriptorInterface;
use Slick\Orm\Descriptor\EntityDescriptorRegistry;
use Slick\Orm\Descriptor\Field\FieldDescriptor;
use Slick\Orm\Entity\EntityCollection;
use Slick\Orm\EntityInterface;
use Slick\Orm\EntityMapperInterface;

/**
 * Generic Entity Mapper
 *
 * @package Slick\Orm\Mapper
 * @author  Filipe Silva <[email protected]>
 */
class EntityMapper implements EntityMapperInterface
{
    /**
     * @var EntityDescriptorInterface
     */
    protected $descriptor;

    /**
     * @var EntityInterface
     */
    protected $entity;

    /**
     * @var AdapterInterface
     */
    protected $adapter;

    /**
     * Saves current entity object to database
     *
     * Optionally saves only the partial data if $data argument is passed. If
     * no data is given al the field properties will be updated.
     *
     * @param array $data Partial data to save
     * @param EntityInterface $entity
     *
     * @return self|$this|EntityMapperInterface
     */
    public function save(EntityInterface $entity, array $data = [])
    {
        $this->entity = $entity;
        $query = $this->getUpdateQuery();
        $query->set($this->getData())
            ->execute();
        return $this;
    }

    /**
     * Get entity descriptor
     *
     * @return EntityDescriptorInterface
     */
    public function getDescriptor()
    {
        if (null == $this->descriptor) {
            $this->setDescriptor(
                EntityDescriptorRegistry::getInstance()
                    ->getDescriptorFor(get_class($this->entity))
            );
        }
        return $this->descriptor;
    }

    /**
     * Set entity descriptor
     *
     * @param EntityDescriptorInterface $descriptor
     *
     * @return $this|self|EntityMapper
     */
    public function setDescriptor($descriptor)
    {
        $this->descriptor = $descriptor;
        return $this;
    }

    /**
     * Sets the adapter for this mapper
     *
     * @param AdapterInterface $adapter
     *
     * @return self|$this|EntityMapper
     */
    public function setAdapter(AdapterInterface $adapter)
    {
        $this->adapter = $adapter;
        return $this;
    }

    /**
     * Retrieves the current adapter
     *
     * @return AdapterInterface
     */
    public function getAdapter()
    {
        return $this->adapter;
    }

    /**
     * Creates the insert/update query for current entity state
     *
     * @return Sql\Insert|Sql\Update
     */
    protected function getUpdateQuery()
    {
        $primaryKey = $this->getDescriptor()->getPrimaryKey()->getName();
        $table = $this->getDescriptor()->getTableName();
        $sql = Sql::createSql($this->getAdapter());
        $query = (null === $this->entity->{$primaryKey})
            ? $sql->insert($table)
            : $this->setUpdateCriteria(
                $sql->update($table),
                $primaryKey,
                $table
            );
        return $query;
    }

    /**
     * Adds the update criteria for an update query
     *
     * @param Sql\Update $query
     * @param string $primaryKey
     * @param string $table
     *
     * @return Sql\Update
     */
    protected function setUpdateCriteria(
        Sql\Update $query, $primaryKey, $table
    ) {
        $key = "{$table}.{$primaryKey} = :id";
        $query->where([$key => [':id' => $this->entity->{$primaryKey}]]);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        return $query;
    }

    /**
     * Gets data to be used in queries
     *
     * @return array
     */
    protected function getData()
    {
        $data = [];
        $fields = $this->getDescriptor()->getFields();
        /** @var FieldDescriptor $field */
        foreach ($fields as $field) {
            $data[$field->getField()] = $this->entity->{$field->getName()};
        }
        return $data;
    }

    /**
     * Creates an entity object from provided data
     *
     * Data can be an array with single row fields or a RecordList from
     * a query.
     *
     * @param array|RecordList $data
     *
     * @return EntityInterface|EntityMapperInterface[]|EntityCollection
     */
    public function createFrom($data)
    {
        if ($data instanceof RecordList) {
            return $this->createMultiple($data);
        }
        return $this->createSingle($data);
    }

    /**
     * Creates an entity for provided row array
     *
     * @param array $source
     * @return EntityInterface
     */
    protected function createSingle(array $source)
    {
        $data = [];
        /** @var FieldDescriptor $field */
        foreach ($this->getDescriptor()->getFields() as $field) {
            if (array_key_exists($field->getField(), $source)) {
                $data[$field->getName()] = $source[$field->getField()];
            }
        }
        $class = $this->getDescriptor()->className();
        return new $class($data);
    }

    /**
     * Creates an entity collection for provided record list
     *
     * @param RecordList $source
     * @return EntityCollection
     */
    protected function createMultiple(RecordList $source)
    {
        $data = [];
        foreach ($source as $item) {
            $data[] = $this->createSingle($item);
        }
        return new EntityCollection($data);
    }

    /**
     * Sets entity class name
     *
     * @param $entityClass
     *
     * @return self|$this|EntityMapper
     */
    public function setEntity($entityClass)
    {
        $this->entity = $entityClass;
        return $this;
    }
}

1		<?php
2
3		/**
4		* This file is part of slick/orm package
5		*
6		* For the full copyright and license information, please view the LICENSE
7		* file that was distributed with this source code.
8		*/
9
10		namespace Slick\Orm\Mapper;
11
12		use Slick\Database\Adapter\AdapterInterface;
13		use Slick\Database\RecordList;
14		use Slick\Database\Sql;
15		use Slick\Orm\Descriptor\EntityDescriptorInterface;
16		use Slick\Orm\Descriptor\EntityDescriptorRegistry;
17		use Slick\Orm\Descriptor\Field\FieldDescriptor;
18		use Slick\Orm\Entity\EntityCollection;
19		use Slick\Orm\EntityInterface;
20		use Slick\Orm\EntityMapperInterface;
21
22		/**
23		* Generic Entity Mapper
24		*
25		* @package Slick\Orm\Mapper
26		* @author Filipe Silva <[email protected]>
27		*/
28		class EntityMapper implements EntityMapperInterface
29		{
30		/**
31		* @var EntityDescriptorInterface
32		*/
33		protected $descriptor;
34
35		/**
36		* @var EntityInterface
37		*/
38		protected $entity;
39
40		/**
41		* @var AdapterInterface
42		*/
43		protected $adapter;
44
45		/**
46		* Saves current entity object to database
47		*
48		* Optionally saves only the partial data if $data argument is passed. If
49		* no data is given al the field properties will be updated.
50		*
51		* @param array $data Partial data to save
52		* @param EntityInterface $entity
53		*
54		* @return self\|$this\|EntityMapperInterface
55		*/
56	4	public function save(EntityInterface $entity, array $data = [])
57		{
58	4	$this->entity = $entity;
59	4	$query = $this->getUpdateQuery();
60	4	$query->set($this->getData())
61	4	->execute();
62	4	return $this;
63		}
64
65		/**
66		* Get entity descriptor
67		*
68		* @return EntityDescriptorInterface
69		*/
70	4	public function getDescriptor()
71		{
72	4	if (null == $this->descriptor) {
73	4	$this->setDescriptor(
74	4	EntityDescriptorRegistry::getInstance()
75	4	->getDescriptorFor(get_class($this->entity))
76	2	);
77	2	}
78	4	return $this->descriptor;
79		}
80
81		/**
82		* Set entity descriptor
83		*
84		* @param EntityDescriptorInterface $descriptor
85		*
86		* @return $this\|self\|EntityMapper
87		*/
88	4	public function setDescriptor($descriptor)
89		{
90	4	$this->descriptor = $descriptor;
91	4	return $this;
92		}
93
94		/**
95		* Sets the adapter for this mapper
96		*
97		* @param AdapterInterface $adapter
98		*
99		* @return self\|$this\|EntityMapper
100		*/
101	8	public function setAdapter(AdapterInterface $adapter)
102		{
103	8	$this->adapter = $adapter;
104	8	return $this;
105		}
106
107		/**
108		* Retrieves the current adapter
109		*
110		* @return AdapterInterface
111		*/
112	4	public function getAdapter()
113		{
114	4	return $this->adapter;
115		}
116
117		/**
118		* Creates the insert/update query for current entity state
119		*
120		* @return Sql\Insert\|Sql\Update
121		*/
122	4	protected function getUpdateQuery()
123		{
124	4	$primaryKey = $this->getDescriptor()->getPrimaryKey()->getName();
125	4	$table = $this->getDescriptor()->getTableName();
126	4	$sql = Sql::createSql($this->getAdapter());
127	4	$query = (null === $this->entity->{$primaryKey})
128	3	? $sql->insert($table)
129	3	: $this->setUpdateCriteria(
130	3	$sql->update($table),
131	1	$primaryKey,
132		$table
133	2	);
134	4	return $query;
135		}
136
137		/**
138		* Adds the update criteria for an update query
139		*
140		* @param Sql\Update $query
141		* @param string $primaryKey
142		* @param string $table
143		*
144		* @return Sql\Update
145		*/
146	2	protected function setUpdateCriteria(
147		Sql\Update $query, $primaryKey, $table
148		) {
149	2	$key = "{$table}.{$primaryKey} = :id";
150	2	$query->where([$key => [':id' => $this->entity->{$primaryKey}]]);
		0 ignored issues – show Documentation introduced 2016-02-28 02:58 UTC by Report Bug Copy Issue Report `array($key => array(':id...entity->{$primaryKey}))` is of type `array<?,array<string,?,{":id":"?"}>>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
151	2	return $query;
152		}
153
154		/**
155		* Gets data to be used in queries
156		*
157		* @return array
158		*/
159	4	protected function getData()
160		{
161	4	$data = [];
162	4	$fields = $this->getDescriptor()->getFields();
163		/** @var FieldDescriptor $field */
164	4	foreach ($fields as $field) {
165	4	$data[$field->getField()] = $this->entity->{$field->getName()};
166	2	}
167	4	return $data;
168		}
169
170		/**
171		* Creates an entity object from provided data
172		*
173		* Data can be an array with single row fields or a RecordList from
174		* a query.
175		*
176		* @param array\|RecordList $data
177		*
178		* @return EntityInterface\|EntityMapperInterface[]\|EntityCollection
179		*/
180		public function createFrom($data)
181		{
182		if ($data instanceof RecordList) {
183		return $this->createMultiple($data);
184		}
185		return $this->createSingle($data);
186		}
187
188		/**
189		* Creates an entity for provided row array
190		*
191		* @param array $source
192		* @return EntityInterface
193		*/
194		protected function createSingle(array $source)
195		{
196		$data = [];
197		/** @var FieldDescriptor $field */
198		foreach ($this->getDescriptor()->getFields() as $field) {
199		if (array_key_exists($field->getField(), $source)) {
200		$data[$field->getName()] = $source[$field->getField()];
201		}
202		}
203		$class = $this->getDescriptor()->className();
204		return new $class($data);
205		}
206
207		/**
208		* Creates an entity collection for provided record list
209		*
210		* @param RecordList $source
211		* @return EntityCollection
212		*/
213		protected function createMultiple(RecordList $source)
214		{
215		$data = [];
216		foreach ($source as $item) {
217		$data[] = $this->createSingle($item);
218		}
219		return new EntityCollection($data);
220		}
221
222		/**
223		* Sets entity class name
224		*
225		* @param $entityClass
226		*
227		* @return self\|$this\|EntityMapper
228		*/
229	4	public function setEntity($entityClass)
230		{
231	4	$this->entity = $entityClass;
232	4	return $this;
233		}
234		}

slickframework / orm

Push — master ( 2525ff...fbc36c )

EntityMapper::getUpdateQuery() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like