Repository::getScalar() - Code Metrics - Inspection of "Added method Repository::getScalar($query)" - byjg/micro-orm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — 2.2.0 (814c16)

by Joao

created 2018-01-30 14:45 UTC

Repository::getScalar() A

↳ Parent: Repository

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	1
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0

<?php

namespace ByJG\MicroOrm;

use ByJG\AnyDataset\DbDriverInterface;
use ByJG\MicroOrm\Exception\OrmBeforeInvalidException;
use ByJG\Serializer\BinderObject;

class Repository
{

    /**
     * @var Mapper
     */
    protected $mapper;

    /**
     * @var DbDriverInterface
     */
    protected $dbDriver = null;

    /**
     * @var \Closure
     */
    protected $beforeUpdate = null;

    /**
     * @var \Closure
     */
    protected $beforeInsert = null;

    /**
     * Repository constructor.
     * @param DbDriverInterface $dbDataset
     * @param Mapper $mapper
     */
    public function __construct(DbDriverInterface $dbDataset, Mapper $mapper)
    {
        $this->dbDriver = $dbDataset;
        $this->mapper = $mapper;
        $this->beforeInsert = function ($instance) {
            return $instance;
        };
        $this->beforeUpdate = function ($instance) {
            return $instance;
        };
    }

    /**
     * @return Mapper
     */
    public function getMapper()
    {
        return $this->mapper;
    }

    /**
     * @return DbDriverInterface
     */
    protected function getDbDriver()
    {
        return $this->dbDriver;
    }

    /**
     * @param array|string $pkId
     * @return mixed|null
     */
    public function get($pkId)
    {
        $result = $this->getByFilter($this->mapper->getPrimaryKey() . ' = [[id]]', ['id' => $pkId]);

        if (count($result) === 1) {
            return $result[0];
        }

        return null;
    }

    /**
     * @param array $pkId
     * @return mixed|null
     * @throws \Exception
     */
    public function delete($pkId)
    {
        $params = ['id' => $pkId];
        $updatable = Updatable::getInstance()
            ->table($this->mapper->getTable())
            ->where($this->mapper->getPrimaryKey() . ' = [[id]]', $params);

        return $this->deleteByQuery($updatable);
    }

    /**
     * @param $updatable
     * @return bool
     */
    public function deleteByQuery(Updatable $updatable)
    {
        $params = [];
        $sql = $updatable->buildDelete($params);

        $this->getDbDriver()->execute($sql, $params);

        return true;
    }

    /**
     * @param string $filter
     * @param array $params
     * @param bool $forUpdate
     * @return array
     */
    public function getByFilter($filter, array $params, $forUpdate = false)
    {
        $query = new Query();
        $query->table($this->mapper->getTable())
            ->where($filter, $params);
        
        if ($forUpdate) {
            $query->forUpdate();
        }

        return $this->getByQuery($query);
    }

    public function getScalar(Query $query)
    {
        $query = $query->build($this->getDbDriver());

        $params = $query['params'];
        $sql = $query['sql'];
        return $this->getDbDriver()->getScalar($sql, $params);
    }

    /**
     * @param Query $query
     * @param Mapper[] $mapper
     * @return array
     */
    public function getByQuery(Query $query, array $mapper = [])
    {
        $mapper = array_merge([$this->mapper], $mapper);
        $query = $query->build($this->getDbDriver());

        $params = $query['params'];
        $sql = $query['sql'];
        $result = [];
        $iterator = $this->getDbDriver()->getIterator($sql, $params);

        foreach ($iterator as $row) {
            $collection = [];
            foreach ($mapper as $item) {
                $instance = $item->getEntity();
                $data = $row->toArray();

                foreach ((array)$item->getFieldAlias() as $fieldname => $fieldalias) {
                    if (isset($data[$fieldalias])) {
                        $data[$fieldname] = $data[$fieldalias];
                        unset($fieldalias);
                    }
                }
                BinderObject::bindObject($data, $instance);

                foreach ((array)$item->getFieldMap() as $property => $fieldmap) {
                    $selectMask = $fieldmap[Mapper::FIELDMAP_SELECTMASK];
                    $value = "";
                    if (isset($data[$fieldmap[Mapper::FIELDMAP_FIELD]])) {
                        $value = $data[$fieldmap[Mapper::FIELDMAP_FIELD]];
                    }
                    $data[$property] = $selectMask($value, $instance);
                }
                if (count($item->getFieldMap()) > 0) {
                    BinderObject::bindObject($data, $instance);
                }
                $collection[] = $instance;
            }
            $result[] = count($collection) === 1 ? $collection[0] : $collection;
        }

        return $result;
    }

    /**
     * @param mixed $instance
     * @return mixed
     * @throws \ByJG\MicroOrm\Exception\OrmBeforeInvalidException
     * @throws \ByJG\MicroOrm\Exception\OrmInvalidFieldsException
     * @throws \Exception
     */
    public function save($instance)
    {
        // Get all fields
        $array = BinderObject::toArrayFrom($instance, true);
        $array = $this->getMapper()->prepareField($array);

        // Mapping the data
        foreach ((array)$this->getMapper()->getFieldMap() as $property => $fieldmap) {
            $fieldname = $fieldmap[Mapper::FIELDMAP_FIELD];
            $updateMask = $fieldmap[Mapper::FIELDMAP_UPDATEMASK];

            // Get the value from the mapped field name
            $value = $array[$property];
            unset($array[$property]);
            $updateValue = $updateMask($value, $instance);

            // If no value for UpdateMask, remove from the list;
            if ($updateValue === false) {
                continue;
            }
            $array[$fieldname] = $updateValue;
        }

        // Defines if is Insert or Update
        $isInsert =
            empty($array[$this->mapper->getPrimaryKey()])
            || ($this->get($array[$this->mapper->getPrimaryKey()]) === null)
        ;

        // Prepare query to insert
        $updatable = Updatable::getInstance()
            ->table($this->mapper->getTable())
            ->fields(array_keys($array));

        // Execute Before Statements
        if ($isInsert) {
            $closure = $this->beforeInsert;
            $array = $closure($array);
        } else {
            $closure = $this->beforeUpdate;
            $array = $closure($array);
        }

        // Check if is OK
        if (empty($array) || !is_array($array)) {
            throw new OrmBeforeInvalidException('Invalid Before Insert Closure');
        }

        // Execute the Insert or Update
        if ($isInsert) {
            $array[$this->mapper->getPrimaryKey()] = $this->insert($updatable, $array);
        } else {
            $this->update($updatable, $array);
        }

        BinderObject::bindObject($array, $instance);

        return $instance;
    }

    /**
     * @param \ByJG\MicroOrm\Updatable $updatable
     * @param array $params
     * @return int
     * @throws \ByJG\MicroOrm\Exception\OrmInvalidFieldsException
     */
    protected function insert(Updatable $updatable, array $params)
    {
        $keyGen = $this->getMapper()->generateKey();
        if (empty($keyGen)) {
            return $this->insertWithAutoinc($updatable, $params);
        } else {
            return $this->insertWithKeyGen($updatable, $params, $keyGen);
        }
    }

    /**
     * @param \ByJG\MicroOrm\Updatable $updatable
     * @param array $params
     * @return int
     * @throws \ByJG\MicroOrm\Exception\OrmInvalidFieldsException
     */
    protected function insertWithAutoinc(Updatable $updatable, array $params)
    {
        $sql = $updatable->buildInsert($params, $this->getDbDriver()->getDbHelper());
        $dbFunctions = $this->getDbDriver()->getDbHelper();
        return $dbFunctions->executeAndGetInsertedId($this->getDbDriver(), $sql, $params);
    }

    /**
     * @param \ByJG\MicroOrm\Updatable $updatable
     * @param array $params
     * @param $keyGen
     * @return mixed
     * @throws \ByJG\MicroOrm\Exception\OrmInvalidFieldsException
     */
    protected function insertWithKeyGen(Updatable $updatable, array $params, $keyGen)
    {
        $params[$this->mapper->getPrimaryKey()] = $keyGen;
        $sql = $updatable->buildInsert($params, $this->getDbDriver()->getDbHelper());
        $this->getDbDriver()->execute($sql, $params);
        return $keyGen;
    }

    /**
     * @param \ByJG\MicroOrm\Updatable $updatable
     * @param array $params
     */
    protected function update(Updatable $updatable, array $params)
    {
        $params = array_merge($params, ['_id' => $params[$this->mapper->getPrimaryKey()]]);
        $updatable->where($this->mapper->getPrimaryKey() . ' = [[_id]] ', ['_id' => $params['_id']]);

        $sql = $updatable->buildUpdate($params, $this->getDbDriver()->getDbHelper());

        $this->getDbDriver()->execute($sql, $params);
    }

    public function setBeforeUpdate(\Closure $closure)
    {
        $this->beforeUpdate = $closure;
    }

    public function setBeforeInsert(\Closure $closure)
    {
        $this->beforeInsert = $closure;
    }
}


1			<?php
2
3			namespace ByJG\MicroOrm;
4
5			use ByJG\AnyDataset\DbDriverInterface;
6			use ByJG\MicroOrm\Exception\OrmBeforeInvalidException;
7			use ByJG\Serializer\BinderObject;
8
9			class Repository
10			{
11
12			/**
13			* @var Mapper
14			*/
15			protected $mapper;
16
17			/**
18			* @var DbDriverInterface
19			*/
20			protected $dbDriver = null;
21
22			/**
23			* @var \Closure
24			*/
25			protected $beforeUpdate = null;
26
27			/**
28			* @var \Closure
29			*/
30			protected $beforeInsert = null;
31
32			/**
33			* Repository constructor.
34			* @param DbDriverInterface $dbDataset
35			* @param Mapper $mapper
36			*/
37			public function __construct(DbDriverInterface $dbDataset, Mapper $mapper)
38			{
39			$this->dbDriver = $dbDataset;
40			$this->mapper = $mapper;
41			$this->beforeInsert = function ($instance) {
42			return $instance;
43			};
44			$this->beforeUpdate = function ($instance) {
45			return $instance;
46			};
47			}
48
49			/**
50			* @return Mapper
51			*/
52			public function getMapper()
53			{
54			return $this->mapper;
55			}
56
57			/**
58			* @return DbDriverInterface
59			*/
60			protected function getDbDriver()
61			{
62			return $this->dbDriver;
63			}
64
65			/**
66			* @param array\|string $pkId
67			* @return mixed\|null
68			*/
69			public function get($pkId)
70			{
71			$result = $this->getByFilter($this->mapper->getPrimaryKey() . ' = [[id]]', ['id' => $pkId]);
72
73			if (count($result) === 1) {
74			return $result[0];
75			}
76
77			return null;
78			}
79
80			/**
81			* @param array $pkId
82			* @return mixed\|null
83			* @throws \Exception
84			*/
85			public function delete($pkId)
86			{
87			$params = ['id' => $pkId];
88			$updatable = Updatable::getInstance()
89			->table($this->mapper->getTable())
90			->where($this->mapper->getPrimaryKey() . ' = [[id]]', $params);
91
92			return $this->deleteByQuery($updatable);
93			}
94
95			/**
96			* @param $updatable
97			* @return bool
98			*/
99			public function deleteByQuery(Updatable $updatable)
100			{
101			$params = [];
102			$sql = $updatable->buildDelete($params);
103
104			$this->getDbDriver()->execute($sql, $params);
105
106			return true;
107			}
108
109			/**
110			* @param string $filter
111			* @param array $params
112			* @param bool $forUpdate
113			* @return array
114			*/
115			public function getByFilter($filter, array $params, $forUpdate = false)
116			{
117			$query = new Query();
118			$query->table($this->mapper->getTable())
119			->where($filter, $params);
120
121			if ($forUpdate) {
122			$query->forUpdate();
123			}
124
125			return $this->getByQuery($query);
126			}
127
128			public function getScalar(Query $query)
129			{
130			$query = $query->build($this->getDbDriver());
131
132			$params = $query['params'];
133			$sql = $query['sql'];
134			return $this->getDbDriver()->getScalar($sql, $params);
135			}
136
137			/**
138			* @param Query $query
139			* @param Mapper[] $mapper
140			* @return array
141			*/
142			public function getByQuery(Query $query, array $mapper = [])
143			{
144			$mapper = array_merge([$this->mapper], $mapper);
145			$query = $query->build($this->getDbDriver());
146
147			$params = $query['params'];
148			$sql = $query['sql'];
149			$result = [];
150			$iterator = $this->getDbDriver()->getIterator($sql, $params);
151
152			foreach ($iterator as $row) {
153			$collection = [];
154			foreach ($mapper as $item) {
155			$instance = $item->getEntity();
156			$data = $row->toArray();
157
158			foreach ((array)$item->getFieldAlias() as $fieldname => $fieldalias) {
159			if (isset($data[$fieldalias])) {
160			$data[$fieldname] = $data[$fieldalias];
161			unset($fieldalias);
162			}
163			}
164			BinderObject::bindObject($data, $instance);
165
166			foreach ((array)$item->getFieldMap() as $property => $fieldmap) {
167			$selectMask = $fieldmap[Mapper::FIELDMAP_SELECTMASK];
168			$value = "";
169			if (isset($data[$fieldmap[Mapper::FIELDMAP_FIELD]])) {
170			$value = $data[$fieldmap[Mapper::FIELDMAP_FIELD]];
171			}
172			$data[$property] = $selectMask($value, $instance);
173			}
174			if (count($item->getFieldMap()) > 0) {
175			BinderObject::bindObject($data, $instance);
176			}
177			$collection[] = $instance;
178			}
179			$result[] = count($collection) === 1 ? $collection[0] : $collection;
180			}
181
182			return $result;
183			}
184
185			/**
186			* @param mixed $instance
187			* @return mixed
188			* @throws \ByJG\MicroOrm\Exception\OrmBeforeInvalidException
189			* @throws \ByJG\MicroOrm\Exception\OrmInvalidFieldsException
190			* @throws \Exception
191			*/
192			public function save($instance)
193			{
194			// Get all fields
195			$array = BinderObject::toArrayFrom($instance, true);
196			$array = $this->getMapper()->prepareField($array);
197
198			// Mapping the data
199			foreach ((array)$this->getMapper()->getFieldMap() as $property => $fieldmap) {
200			$fieldname = $fieldmap[Mapper::FIELDMAP_FIELD];
201			$updateMask = $fieldmap[Mapper::FIELDMAP_UPDATEMASK];
202
203			// Get the value from the mapped field name
204			$value = $array[$property];
205			unset($array[$property]);
206			$updateValue = $updateMask($value, $instance);
207
208			// If no value for UpdateMask, remove from the list;
209			if ($updateValue === false) {
210			continue;
211			}
212			$array[$fieldname] = $updateValue;
213			}
214
215			// Defines if is Insert or Update
216			$isInsert =
217			empty($array[$this->mapper->getPrimaryKey()])
218			\|\| ($this->get($array[$this->mapper->getPrimaryKey()]) === null)
219			;
220
221			// Prepare query to insert
222			$updatable = Updatable::getInstance()
223			->table($this->mapper->getTable())
224			->fields(array_keys($array));
225
226			// Execute Before Statements
227			if ($isInsert) {
228			$closure = $this->beforeInsert;
229			$array = $closure($array);
230			} else {
231			$closure = $this->beforeUpdate;
232			$array = $closure($array);
233			}
234
235			// Check if is OK
236			if (empty($array) \|\| !is_array($array)) {
237			throw new OrmBeforeInvalidException('Invalid Before Insert Closure');
238			}
239
240			// Execute the Insert or Update
241			if ($isInsert) {
242			$array[$this->mapper->getPrimaryKey()] = $this->insert($updatable, $array);
243			} else {
244			$this->update($updatable, $array);
245			}
246
247			BinderObject::bindObject($array, $instance);
248
249			return $instance;
250			}
251
252			/**
253			* @param \ByJG\MicroOrm\Updatable $updatable
254			* @param array $params
255			* @return int
256			* @throws \ByJG\MicroOrm\Exception\OrmInvalidFieldsException
257			*/
258			protected function insert(Updatable $updatable, array $params)
259			{
260			$keyGen = $this->getMapper()->generateKey();
261			if (empty($keyGen)) {
262			return $this->insertWithAutoinc($updatable, $params);
263			} else {
264			return $this->insertWithKeyGen($updatable, $params, $keyGen);
265			}
266			}
267
268			/**
269			* @param \ByJG\MicroOrm\Updatable $updatable
270			* @param array $params
271			* @return int
272			* @throws \ByJG\MicroOrm\Exception\OrmInvalidFieldsException
273			*/
274			protected function insertWithAutoinc(Updatable $updatable, array $params)
275			{
276			$sql = $updatable->buildInsert($params, $this->getDbDriver()->getDbHelper());
277			$dbFunctions = $this->getDbDriver()->getDbHelper();
278			return $dbFunctions->executeAndGetInsertedId($this->getDbDriver(), $sql, $params);
279			}
280
281			/**
282			* @param \ByJG\MicroOrm\Updatable $updatable
283			* @param array $params
284			* @param $keyGen
285			* @return mixed
286			* @throws \ByJG\MicroOrm\Exception\OrmInvalidFieldsException
287			*/
288			protected function insertWithKeyGen(Updatable $updatable, array $params, $keyGen)
289			{
290			$params[$this->mapper->getPrimaryKey()] = $keyGen;
291			$sql = $updatable->buildInsert($params, $this->getDbDriver()->getDbHelper());
292			$this->getDbDriver()->execute($sql, $params);
293			return $keyGen;
294			}
295
296			/**
297			* @param \ByJG\MicroOrm\Updatable $updatable
298			* @param array $params
299			*/
300			protected function update(Updatable $updatable, array $params)
301			{
302			$params = array_merge($params, ['_id' => $params[$this->mapper->getPrimaryKey()]]);
303			$updatable->where($this->mapper->getPrimaryKey() . ' = [[_id]] ', ['_id' => $params['_id']]);
304
305			$sql = $updatable->buildUpdate($params, $this->getDbDriver()->getDbHelper());
306
307			$this->getDbDriver()->execute($sql, $params);
308			}
309
310			public function setBeforeUpdate(\Closure $closure)
311			{
312			$this->beforeUpdate = $closure;
313			}
314
315			public function setBeforeInsert(\Closure $closure)
316			{
317			$this->beforeInsert = $closure;
318			}
319			}
320

byjg / micro-orm

Branch — 2.2.0 (814c16)

Repository::getScalar() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like