BasicDbEntityService::__construct() - Code Metrics - Inspection of "Fix SQL case error when using arrays as primary ke..." - starweb/starlit-db - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f500e6...8bb85a )

by Andreas

created 2017-03-25 18:37 UTC

BasicDbEntityService::__construct() A

↳ Parent: BasicDbEntityService

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php
/**
 * Starlit Db.
 *
 * @copyright Copyright (c) 2016 Starweb AB
 * @license   BSD 3-Clause
 */

namespace Starlit\Db;

use Starlit\Db\Exception;

/**
 * A database entity service is intended to handle database operations for existing
 * entity objects, i.e. load, save and load secondary objects etc.
 *
 * @author Andreas Nilsson <http://github.com/jandreasn>
 */
class BasicDbEntityService
{
    /**
     * The database adapter/connection/handler.
     *
     * @var Db
     */
    protected $db;

    /**
     * Constructor.
     *
     * @param Db $db
     */
    public function __construct(Db $db)
    {
        $this->db = $db;
    }

    /**
     * Load object's values from database table.
     *
     * @param AbstractDbEntity $dbEntity
     * @throws Exception\EntityNotFoundException
     */
    public function load(AbstractDbEntity $dbEntity)
    {
        // Check that the primary key is set
        if (!$dbEntity->getPrimaryDbValue()) {
            throw new \InvalidArgumentException(
                'Database entity can not be loaded because primary value is not set'
            );
        }

        // Fetch ad from db
        $row = $this->db->fetchRow(
            '
                SELECT *
                FROM `' . $dbEntity->getDbTableName() . '`
                WHERE ' . $this->getPrimaryKeyWhereSql($dbEntity) . '
            ',
            $this->getPrimaryKeyWhereParameters($dbEntity)
        );

        if (!$row) {
            throw new Exception\EntityNotFoundException("Db entity[{$dbEntity->getPrimaryDbValue()}] does not exist");
        }

        $dbEntity->setDbDataFromRow($row);
    }

    /**
     * Save entity to database table.
     *
     * @param AbstractDbEntity $dbEntity
     * @return bool
     */
    public function save(AbstractDbEntity $dbEntity)
    {
        if ($dbEntity->shouldBeDeletedFromDbOnSave()) {
            // Only delete if previously saved to db
            if ($dbEntity->getPrimaryDbValue()) {
                $this->delete($dbEntity);
            }

            return false;
        }

        if ($dbEntity->shouldInsertOnDbSave()) {
            // Note that database data always contains all properties, with defaults for non set properties
            $dataToSave = $dbEntity->getDbData();
        } else {
            if ($dbEntity->hasModifiedDbProperties()) {
                $dataToSave = $dbEntity->getModifiedDbData();
            } else {
                // Return if no value has been modified and it's not an insert
                // (we always want to insert if no id exist, since some child objects might
                // depend on the this primary id being available)
                return false;
            }
        }

        // We don't the want to insert/update primary value unless forced insert
        if (!$dbEntity->shouldForceDbInsertOnSave()) {
            $primaryKey = $dbEntity->getPrimaryDbPropertyKey();
            if (is_array($primaryKey)) {
                foreach ($primaryKey as $keyPart) {
                    unset($dataToSave[$keyPart]);
                }
            } else {
                unset($dataToSave[$primaryKey]);
            }
        }

        // Check data
        $sqlData = [];
        foreach ($dataToSave as $propertyName => $value) {
            if (!empty($value) && is_scalar($value)
                && $dbEntity->getDbPropertyMaxLength($propertyName)
                && mb_strlen($value) > $dbEntity->getDbPropertyMaxLength($propertyName)
            ) {
                throw new \RuntimeException(
                    "Database field \"{$propertyName}\" exceeds field max length (value: \"{$value}\")"
                );
            } elseif (empty($value) && $dbEntity->getDbPropertyNonEmpty($propertyName)) {
                throw new \RuntimeException("Database field \"{$propertyName}\" is empty and required");
            } elseif (((is_scalar($value) && ((string) $value) === '') || (!is_scalar($value) && empty($value)))
                && $dbEntity->getDbPropertyRequired($propertyName)
            ) {
                throw new \RuntimeException("Database field \"{$propertyName}\" is required to be set");
            }

            // Set data keys db field format
            $fieldName = $dbEntity->getDbFieldName($propertyName);
            $sqlData[$fieldName] = $value;
        }


        // Insert new database row
        if ($dbEntity->shouldInsertOnDbSave()) {
            $this->db->insert(
                $dbEntity->getDbTableName(),
                $sqlData
            );

            if (!is_array($dbEntity->getPrimaryDbPropertyKey())
                && !empty($lastInsertId = $this->db->getLastInsertId())
            ) {
                $dbEntity->setPrimaryDbValue($lastInsertId);
            }
        // Update existing database row
        } else {
            $this->db->update(
                $dbEntity->getDbTableName(),
                $sqlData,
                $this->getPrimaryKeyWhereSql($dbEntity),
                $this->getPrimaryKeyWhereParameters($dbEntity)

            );
        }

        $dbEntity->clearModifiedDbProperties();
        $dbEntity->setForceDbInsertOnSave(false);

        return true;
    }

    /**
     * Delete entity's corresponding database row.
     *
     * @param AbstractDbEntity $dbEntity
     */
    public function delete(AbstractDbEntity $dbEntity)
    {
        if (!$dbEntity->getPrimaryDbValue()) {
            throw new \InvalidArgumentException('Primary database value not set');
        }

        $this->db->exec(
            'DELETE FROM `' . $dbEntity->getDbTableName() . '` WHERE ' . $this->getPrimaryKeyWhereSql($dbEntity),
            $this->getPrimaryKeyWhereParameters($dbEntity)
        );

        $dbEntity->setDeleted();
    }

    /**
     * @param AbstractDbEntity $dbEntity
     * @return string
     */
    protected function getPrimaryKeyWhereSql(AbstractDbEntity $dbEntity)
    {
        if (is_array($dbEntity->getPrimaryDbPropertyKey())) {
            $whereStrings = [];
            foreach ($dbEntity->getPrimaryDbFieldKey() as $primaryKeyPart) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                $whereStrings[] = '`' . $primaryKeyPart . '` = ?';
            }
            $whereSql = implode(' AND ', $whereStrings);
        } else {
            $whereSql = '`' . $dbEntity->getPrimaryDbFieldKey() . '` = ?';
        }

        return $whereSql;
    }

    /**
     * @param AbstractDbEntity $dbEntity
     * @return array
     */
    protected function getPrimaryKeyWhereParameters(AbstractDbEntity $dbEntity)
    {
        if (is_array($dbEntity->getPrimaryDbPropertyKey())) {
            $whereParameters = $dbEntity->getPrimaryDbValue();
        } else {
            $whereParameters = [$dbEntity->getPrimaryDbValue()];
        }

        return $whereParameters;
    }
}


1		<?php
2		/**
3		* Starlit Db.
4		*
5		* @copyright Copyright (c) 2016 Starweb AB
6		* @license BSD 3-Clause
7		*/
8
9		namespace Starlit\Db;
10
11		use Starlit\Db\Exception;
12
13		/**
14		* A database entity service is intended to handle database operations for existing
15		* entity objects, i.e. load, save and load secondary objects etc.
16		*
17		* @author Andreas Nilsson <http://github.com/jandreasn>
18		*/
19		class BasicDbEntityService
20		{
21		/**
22		* The database adapter/connection/handler.
23		*
24		* @var Db
25		*/
26		protected $db;
27
28		/**
29		* Constructor.
30		*
31		* @param Db $db
32		*/
33	15	public function __construct(Db $db)
34		{
35	15	$this->db = $db;
36	15	}
37
38		/**
39		* Load object's values from database table.
40		*
41		* @param AbstractDbEntity $dbEntity
42		* @throws Exception\EntityNotFoundException
43		*/
44	3	public function load(AbstractDbEntity $dbEntity)
45		{
46		// Check that the primary key is set
47	3	if (!$dbEntity->getPrimaryDbValue()) {
48	1	throw new \InvalidArgumentException(
49		'Database entity can not be loaded because primary value is not set'
50	1	);
51		}
52
53		// Fetch ad from db
54	2	$row = $this->db->fetchRow(
55		'
56		SELECT *
57	2	FROM `' . $dbEntity->getDbTableName() . '`
58	2	WHERE ' . $this->getPrimaryKeyWhereSql($dbEntity) . '
59	2	',
60	2	$this->getPrimaryKeyWhereParameters($dbEntity)
61	2	);
62
63	2	if (!$row) {
64	1	throw new Exception\EntityNotFoundException("Db entity[{$dbEntity->getPrimaryDbValue()}] does not exist");
65		}
66
67	1	$dbEntity->setDbDataFromRow($row);
68	1	}
69
70		/**
71		* Save entity to database table.
72		*
73		* @param AbstractDbEntity $dbEntity
74		* @return bool
75		*/
76	10	public function save(AbstractDbEntity $dbEntity)
77		{
78	10	if ($dbEntity->shouldBeDeletedFromDbOnSave()) {
79		// Only delete if previously saved to db
80	2	if ($dbEntity->getPrimaryDbValue()) {
81	1	$this->delete($dbEntity);
82	1	}
83
84	2	return false;
85		}
86
87	8	if ($dbEntity->shouldInsertOnDbSave()) {
88		// Note that database data always contains all properties, with defaults for non set properties
89	5	$dataToSave = $dbEntity->getDbData();
90	5	} else {
91	3	if ($dbEntity->hasModifiedDbProperties()) {
92	2	$dataToSave = $dbEntity->getModifiedDbData();
93	2	} else {
94		// Return if no value has been modified and it's not an insert
95		// (we always want to insert if no id exist, since some child objects might
96		// depend on the this primary id being available)
97	1	return false;
98		}
99		}
100
101		// We don't the want to insert/update primary value unless forced insert
102	7	if (!$dbEntity->shouldForceDbInsertOnSave()) {
103	7	$primaryKey = $dbEntity->getPrimaryDbPropertyKey();
104	7	if (is_array($primaryKey)) {
105	1	foreach ($primaryKey as $keyPart) {
106	1	unset($dataToSave[$keyPart]);
107	1	}
108	1	} else {
109	6	unset($dataToSave[$primaryKey]);
110		}
111	7	}
112
113		// Check data
114	7	$sqlData = [];
115	7	foreach ($dataToSave as $propertyName => $value) {
116	7	if (!empty($value) && is_scalar($value)
117	7	&& $dbEntity->getDbPropertyMaxLength($propertyName)
118	7	&& mb_strlen($value) > $dbEntity->getDbPropertyMaxLength($propertyName)
119	7	) {
120	1	throw new \RuntimeException(
121	1	"Database field \"{$propertyName}\" exceeds field max length (value: \"{$value}\")"
122	1	);
123	6	} elseif (empty($value) && $dbEntity->getDbPropertyNonEmpty($propertyName)) {
124	1	throw new \RuntimeException("Database field \"{$propertyName}\" is empty and required");
125	6	} elseif (((is_scalar($value) && ((string) $value) === '') \|\| (!is_scalar($value) && empty($value)))
126	6	&& $dbEntity->getDbPropertyRequired($propertyName)
127	6	) {
128	2	throw new \RuntimeException("Database field \"{$propertyName}\" is required to be set");
129		}
130
131		// Set data keys db field format
132	4	$fieldName = $dbEntity->getDbFieldName($propertyName);
133	4	$sqlData[$fieldName] = $value;
134	4	}
135
136
137		// Insert new database row
138	3	if ($dbEntity->shouldInsertOnDbSave()) {
139	1	$this->db->insert(
140	1	$dbEntity->getDbTableName(),
141		$sqlData
142	1	);
143
144	1	if (!is_array($dbEntity->getPrimaryDbPropertyKey())
145	1	&& !empty($lastInsertId = $this->db->getLastInsertId())
146	1	) {
147		$dbEntity->setPrimaryDbValue($lastInsertId);
148		}
149		// Update existing database row
150	1	} else {
151	2	$this->db->update(
152	2	$dbEntity->getDbTableName(),
153	2	$sqlData,
154	2	$this->getPrimaryKeyWhereSql($dbEntity),
155	2	$this->getPrimaryKeyWhereParameters($dbEntity)
156
157	2	);
158		}
159
160	3	$dbEntity->clearModifiedDbProperties();
161	3	$dbEntity->setForceDbInsertOnSave(false);
162
163	3	return true;
164		}
165
166		/**
167		* Delete entity's corresponding database row.
168		*
169		* @param AbstractDbEntity $dbEntity
170		*/
171	3	public function delete(AbstractDbEntity $dbEntity)
172		{
173	3	if (!$dbEntity->getPrimaryDbValue()) {
174	1	throw new \InvalidArgumentException('Primary database value not set');
175		}
176
177	2	$this->db->exec(
178	2	'DELETE FROM `' . $dbEntity->getDbTableName() . '` WHERE ' . $this->getPrimaryKeyWhereSql($dbEntity),
179	2	$this->getPrimaryKeyWhereParameters($dbEntity)
180	2	);
181
182	2	$dbEntity->setDeleted();
183	2	}
184
185		/**
186		* @param AbstractDbEntity $dbEntity
187		* @return string
188		*/
189	6	protected function getPrimaryKeyWhereSql(AbstractDbEntity $dbEntity)
190		{
191	6	if (is_array($dbEntity->getPrimaryDbPropertyKey())) {
192	1	$whereStrings = [];
193	1	foreach ($dbEntity->getPrimaryDbFieldKey() as $primaryKeyPart) {
		0 ignored issues – show Bug introduced 2017-03-25 18:39 UTC by Report Bug Copy Issue Report The expression `$dbEntity->getPrimaryDbFieldKey()` of type `array\|string` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
194	1	$whereStrings[] = '`' . $primaryKeyPart . '` = ?';
195	1	}
196	1	$whereSql = implode(' AND ', $whereStrings);
197	1	} else {
198	5	$whereSql = '`' . $dbEntity->getPrimaryDbFieldKey() . '` = ?';
199		}
200
201	6	return $whereSql;
202		}
203
204		/**
205		* @param AbstractDbEntity $dbEntity
206		* @return array
207		*/
208	6	protected function getPrimaryKeyWhereParameters(AbstractDbEntity $dbEntity)
209		{
210	6	if (is_array($dbEntity->getPrimaryDbPropertyKey())) {
211	1	$whereParameters = $dbEntity->getPrimaryDbValue();
212	1	} else {
213	5	$whereParameters = [$dbEntity->getPrimaryDbValue()];
214		}
215
216	6	return $whereParameters;
217		}
218		}
219

starweb / starlit-db

GitHub Access Token became invalid

Push — master ( f500e6...8bb85a )

BasicDbEntityService::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like