DAOUpdatesTrait::removeByKey_() - Code Metrics - Inspection of "[update][orm] sync _rest array with updates + [fix..." - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c60d6c...7a2a93 )

by Jean-Christophe

created 2019-04-20 12:45 UTC

DAOUpdatesTrait::removeByKey_() A

↳ Parent: DAOUpdatesTrait

Complexity

Conditions	4
Paths	8

Size

Total Lines	16
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	4.0092

Importance

Changes

Metric	Value
eloc	12
dl	0
loc	16
ccs	11
cts	12
cp	0.9167
rs	9.8666
c	0
b	0
f	0
cc	4
nc	8
nop	2
crap	4.0092

<?php

namespace Ubiquity\orm\traits;

use Ubiquity\db\SqlUtils;
use Ubiquity\events\DAOEvents;
use Ubiquity\events\EventsManager;
use Ubiquity\log\Logger;
use Ubiquity\orm\OrmUtils;
use Ubiquity\orm\parser\ManyToManyParser;
use Ubiquity\orm\parser\Reflexion;

/**
 * Trait for DAO Updates (Create, Update, Delete)
 * Ubiquity\orm\traits$DAOUpdatesTrait
 * This class is part of Ubiquity
 *
 * @author jcheron <[email protected]>
 * @version 1.0.2
 *
 */
trait DAOUpdatesTrait {

	/**
	 * Deletes the object $instance from the database
	 *
	 * @param object $instance instance à supprimer
	 */
	public static function remove($instance) {
		$tableName = OrmUtils::getTableName ( get_class ( $instance ) );
		$keyAndValues = OrmUtils::getKeyFieldsAndValues ( $instance );
		return self::removeByKey_ ( $tableName, $keyAndValues );
	}

	/**
	 *
	 * @param string $tableName
	 * @param array $keyAndValues
	 * @return int the number of rows that were modified or deleted by the SQL statement you issued
	 */
	private static function removeByKey_($tableName, $keyAndValues) {
		$sql = "DELETE FROM " . $tableName . " WHERE " . SqlUtils::getWhere ( $keyAndValues );
		Logger::info ( "DAOUpdates", $sql, "delete" );
		$statement = self::$db->prepareStatement ( $sql );
		foreach ( $keyAndValues as $key => $value ) {
			self::$db->bindValueFromStatement ( $statement, $key, $value );
		}
		try {
			if ($statement->execute ()) {
				return $statement->rowCount ();
			}
		} catch ( \PDOException $e ) {
			Logger::warn ( "DAOUpdates", $e->getMessage (), "delete" );
			return;
		}
		return;
	}

	/**
	 *
	 * @param string $tableName
	 * @param string $where
	 * @return boolean|int the number of rows that were modified or deleted by the SQL statement you issued
	 */
	private static function remove_($tableName, $where) {
		$sql = "DELETE FROM `" . $tableName . "` " . SqlUtils::checkWhere ( $where );
		Logger::info ( "DAOUpdates", $sql, "delete" );
		$statement = self::$db->prepareStatement ( $sql );
		try {
			if ($statement->execute ()) {
				return $statement->rowCount ();
			}
		} catch ( \PDOException $e ) {
			Logger::warn ( "DAOUpdates", $e->getMessage (), "delete" );
			return false;
		}
	}

	/**
	 * Deletes all instances from $modelName matching the condition $where
	 *
	 * @param string $modelName
	 * @param string $where
	 * @return int|boolean
	 */
	public static function deleteAll($modelName, $where) {
		$tableName = OrmUtils::getTableName ( $modelName );
		return self::remove_ ( $tableName, $where );
	}

	/**
	 * Deletes all instances from $modelName corresponding to $ids
	 *
	 * @param string $modelName
	 * @param array|int $ids
	 * @return int|boolean
	 */
	public static function delete($modelName, $ids) {
		$tableName = OrmUtils::getTableName ( $modelName );
		$pk = OrmUtils::getFirstKey ( $modelName );
		if (! \is_array ( $ids )) {
			$ids = [ $ids ];
		}
		$where = SqlUtils::getMultiWhere ( $ids, $pk );
		return self::remove_ ( $tableName, $where );
	}

	/**
	 * Inserts a new instance $instance into the database
	 *
	 * @param object $instance the instance to insert
	 * @param boolean $insertMany if true, save instances related to $instance by a ManyToMany association
	 */
	public static function insert($instance, $insertMany = false) {
		EventsManager::trigger ( 'dao.before.insert', $instance );
		$tableName = OrmUtils::getTableName ( get_class ( $instance ) );
		$keyAndValues = Reflexion::getPropertiesAndValues ( $instance );
		$keyAndValues = array_merge ( $keyAndValues, OrmUtils::getManyToOneMembersAndValues ( $instance ) );
		$sql = "INSERT INTO `" . $tableName . "`(" . SqlUtils::getInsertFields ( $keyAndValues ) . ") VALUES(" . SqlUtils::getInsertFieldsValues ( $keyAndValues ) . ")";
		Logger::info ( "DAOUpdates", $sql, "insert" );
		Logger::info ( "DAOUpdates", json_encode ( $keyAndValues ), "Key and values" );
		$statement = self::$db->prepareStatement ( $sql );
		foreach ( $keyAndValues as $key => $value ) {
			self::$db->bindValueFromStatement ( $statement, $key, $value );
		}
		try {
			$result = $statement->execute ();
			if ($result) {
				$pk = OrmUtils::getFirstKey ( get_class ( $instance ) );
				$accesseurId = "set" . ucfirst ( $pk );
				$lastId = self::$db->lastInserId ();
				if ($lastId != 0) {
					$instance->$accesseurId ( $lastId );
					$instance->_rest = $keyAndValues;
					$instance->_rest [$pk] = $lastId;
				}
				if ($insertMany) {
					self::insertOrUpdateAllManyToMany ( $instance );
				}
			}
			EventsManager::trigger ( DAOEvents::AFTER_INSERT, $instance, $result );
			return $result;
		} catch ( \PDOException $e ) {
			Logger::warn ( "DAOUpdates", $e->getMessage (), "insert" );
		}
		return false;
	}

	/**
	 * Met à jour les membres de $instance annotés par un ManyToMany
	 *
	 * @param object $instance
	 */
	public static function insertOrUpdateAllManyToMany($instance) {
		$members = OrmUtils::getAnnotationInfo ( get_class ( $instance ), "#manyToMany" );
		if ($members !== false) {
			$members = \array_keys ( $members );
			foreach ( $members as $member ) {
				self::insertOrUpdateManyToMany ( $instance, $member );
			}
		}
	}

	/**
	 * Updates the $member member of $instance annotated by a ManyToMany
	 *
	 * @param Object $instance
	 * @param String $member
	 */
	public static function insertOrUpdateManyToMany($instance, $member) {
		$parser = new ManyToManyParser ( $instance, $member );
		if ($parser->init ()) {
			$myField = $parser->getMyFkField ();
			$field = $parser->getFkField ();
			$sql = "INSERT INTO `" . $parser->getJoinTable () . "`(`" . $myField . "`,`" . $field . "`) VALUES (:" . $myField . ",:" . $field . ");";
			$memberAccessor = "get" . ucfirst ( $member );
			$memberValues = $instance->$memberAccessor ();
			$myKey = $parser->getMyPk ();
			$myAccessorId = "get" . ucfirst ( $myKey );
			$accessorId = "get" . ucfirst ( $parser->getPk () );
			$id = $instance->$myAccessorId ();
			if (! is_null ( $memberValues )) {
				self::$db->execute ( "DELETE FROM `" . $parser->getJoinTable () . "` WHERE `" . $myField . "`='" . $id . "'" );
				$statement = self::$db->prepareStatement ( $sql );
				foreach ( $memberValues as $targetInstance ) {
					$foreignId = $targetInstance->$accessorId ();
					$foreignInstances = self::getAll ( $parser->getTargetEntity (), "`" . $parser->getPk () . "`" . "='" . $foreignId . "'" );
					if (! OrmUtils::exists ( $targetInstance, $parser->getPk (), $foreignInstances )) {
						self::insert ( $targetInstance, false );
						$foreignId = $targetInstance->$accessorId ();
						Logger::info ( "DAOUpdates", "Insertion d'une instance de " . get_class ( $instance ), "InsertMany" );
					}
					self::$db->bindValueFromStatement ( $statement, $myField, $id );
					self::$db->bindValueFromStatement ( $statement, $field, $foreignId );
					$statement->execute ();
					Logger::info ( "DAOUpdates", "Insertion des valeurs dans la table association '" . $parser->getJoinTable () . "'", "InsertMany" );
				}
			}
		}
	}

	/**
	 * Updates an existing $instance in the database.
	 * Be careful not to modify the primary key
	 *
	 * @param object $instance instance to modify
	 * @param boolean $updateMany Adds or updates ManyToMany members
	 */
	public static function update($instance, $updateMany = false) {
		EventsManager::trigger ( "dao.before.update", $instance );
		$tableName = OrmUtils::getTableName ( get_class ( $instance ) );
		$ColumnskeyAndValues = Reflexion::getPropertiesAndValues ( $instance );
		$ColumnskeyAndValues = array_merge ( $ColumnskeyAndValues, OrmUtils::getManyToOneMembersAndValues ( $instance ) );
		$keyFieldsAndValues = OrmUtils::getKeyFieldsAndValues ( $instance );
		$sql = "UPDATE `" . $tableName . "` SET " . SqlUtils::getUpdateFieldsKeyAndValues ( $ColumnskeyAndValues ) . " WHERE " . SqlUtils::getWhere ( $keyFieldsAndValues );
		Logger::info ( "DAOUpdates", $sql, "update" );
		Logger::info ( "DAOUpdates", json_encode ( $ColumnskeyAndValues ), "Key and values" );
		$statement = self::$db->prepareStatement ( $sql );
		foreach ( $ColumnskeyAndValues as $key => $value ) {
			self::$db->bindValueFromStatement ( $statement, $key, $value );
		}
		try {
			$result = $statement->execute ();
			if ($result && $updateMany)
				self::insertOrUpdateAllManyToMany ( $instance );
			EventsManager::trigger ( DAOEvents::AFTER_UPDATE, $instance, $result );
			$instance->_rest = array_merge ( $instance->_rest, $ColumnskeyAndValues );
			return $result;
		} catch ( \PDOException $e ) {
			Logger::warn ( "DAOUpdates", $e->getMessage (), "update" );
		}
		return false;
	}

	/**
	 *
	 * @param object $instance
	 * @param boolean $updateMany
	 * @return boolean|int
	 */
	public static function save($instance, $updateMany = false) {
		if (isset ( $instance->_rest )) {
			return self::update ( $instance, $updateMany );
		}
		return self::insert ( $instance, $updateMany );
	}
}


1		<?php
2
3		namespace Ubiquity\orm\traits;
4
5		use Ubiquity\db\SqlUtils;
6		use Ubiquity\events\DAOEvents;
7		use Ubiquity\events\EventsManager;
8		use Ubiquity\log\Logger;
9		use Ubiquity\orm\OrmUtils;
10		use Ubiquity\orm\parser\ManyToManyParser;
11		use Ubiquity\orm\parser\Reflexion;
12
13		/**
14		* Trait for DAO Updates (Create, Update, Delete)
15		* Ubiquity\orm\traits$DAOUpdatesTrait
16		* This class is part of Ubiquity
17		*
18		* @author jcheron <[email protected]>
19		* @version 1.0.2
20		*
21		*/
22		trait DAOUpdatesTrait {
23
24		/**
25		* Deletes the object $instance from the database
26		*
27		* @param object $instance instance à supprimer
28		*/
29	4	public static function remove($instance) {
30	4	$tableName = OrmUtils::getTableName ( get_class ( $instance ) );
31	4	$keyAndValues = OrmUtils::getKeyFieldsAndValues ( $instance );
32	4	return self::removeByKey_ ( $tableName, $keyAndValues );
33		}
34
35		/**
36		*
37		* @param string $tableName
38		* @param array $keyAndValues
39		* @return int the number of rows that were modified or deleted by the SQL statement you issued
40		*/
41	4	private static function removeByKey_($tableName, $keyAndValues) {
42	4	$sql = "DELETE FROM " . $tableName . " WHERE " . SqlUtils::getWhere ( $keyAndValues );
43	4	Logger::info ( "DAOUpdates", $sql, "delete" );
44	4	$statement = self::$db->prepareStatement ( $sql );
45	4	foreach ( $keyAndValues as $key => $value ) {
46	4	self::$db->bindValueFromStatement ( $statement, $key, $value );
47		}
48		try {
49	4	if ($statement->execute ()) {
50	3	return $statement->rowCount ();
51		}
52	1	} catch ( \PDOException $e ) {
53	1	Logger::warn ( "DAOUpdates", $e->getMessage (), "delete" );
54	1	return;
55		}
56		return;
57		}
58
59		/**
60		*
61		* @param string $tableName
62		* @param string $where
63		* @return boolean\|int the number of rows that were modified or deleted by the SQL statement you issued
64		*/
65		private static function remove_($tableName, $where) {
66		$sql = "DELETE FROM `" . $tableName . "` " . SqlUtils::checkWhere ( $where );
67		Logger::info ( "DAOUpdates", $sql, "delete" );
68		$statement = self::$db->prepareStatement ( $sql );
69		try {
70		if ($statement->execute ()) {
71		return $statement->rowCount ();
72		}
73		} catch ( \PDOException $e ) {
74		Logger::warn ( "DAOUpdates", $e->getMessage (), "delete" );
75		return false;
76		}
77		}
78
79		/**
80		* Deletes all instances from $modelName matching the condition $where
81		*
82		* @param string $modelName
83		* @param string $where
84		* @return int\|boolean
85		*/
86		public static function deleteAll($modelName, $where) {
87		$tableName = OrmUtils::getTableName ( $modelName );
88		return self::remove_ ( $tableName, $where );
89		}
90
91		/**
92		* Deletes all instances from $modelName corresponding to $ids
93		*
94		* @param string $modelName
95		* @param array\|int $ids
96		* @return int\|boolean
97		*/
98		public static function delete($modelName, $ids) {
99		$tableName = OrmUtils::getTableName ( $modelName );
100		$pk = OrmUtils::getFirstKey ( $modelName );
101		if (! \is_array ( $ids )) {
102		$ids = [ $ids ];
103		}
104		$where = SqlUtils::getMultiWhere ( $ids, $pk );
105		return self::remove_ ( $tableName, $where );
106		}
107
108		/**
109		* Inserts a new instance $instance into the database
110		*
111		* @param object $instance the instance to insert
112		* @param boolean $insertMany if true, save instances related to $instance by a ManyToMany association
113		*/
114	3	public static function insert($instance, $insertMany = false) {
115	3	EventsManager::trigger ( 'dao.before.insert', $instance );
116	3	$tableName = OrmUtils::getTableName ( get_class ( $instance ) );
117	3	$keyAndValues = Reflexion::getPropertiesAndValues ( $instance );
118	3	$keyAndValues = array_merge ( $keyAndValues, OrmUtils::getManyToOneMembersAndValues ( $instance ) );
119	3	$sql = "INSERT INTO `" . $tableName . "`(" . SqlUtils::getInsertFields ( $keyAndValues ) . ") VALUES(" . SqlUtils::getInsertFieldsValues ( $keyAndValues ) . ")";
120	3	Logger::info ( "DAOUpdates", $sql, "insert" );
121	3	Logger::info ( "DAOUpdates", json_encode ( $keyAndValues ), "Key and values" );
122	3	$statement = self::$db->prepareStatement ( $sql );
123	3	foreach ( $keyAndValues as $key => $value ) {
124	3	self::$db->bindValueFromStatement ( $statement, $key, $value );
125		}
126		try {
127	3	$result = $statement->execute ();
128	3	if ($result) {
129	3	$pk = OrmUtils::getFirstKey ( get_class ( $instance ) );
130	3	$accesseurId = "set" . ucfirst ( $pk );
131	3	$lastId = self::$db->lastInserId ();
132	3	if ($lastId != 0) {
133	3	$instance->$accesseurId ( $lastId );
134	3	$instance->_rest = $keyAndValues;
135	3	$instance->_rest [$pk] = $lastId;
136		}
137	3	if ($insertMany) {
138	1	self::insertOrUpdateAllManyToMany ( $instance );
139		}
140		}
141	3	EventsManager::trigger ( DAOEvents::AFTER_INSERT, $instance, $result );
142	3	return $result;
143	1	} catch ( \PDOException $e ) {
144	1	Logger::warn ( "DAOUpdates", $e->getMessage (), "insert" );
145		}
146	1	return false;
147		}
148
149		/**
150		* Met à jour les membres de $instance annotés par un ManyToMany
151		*
152		* @param object $instance
153		*/
154	1	public static function insertOrUpdateAllManyToMany($instance) {
155	1	$members = OrmUtils::getAnnotationInfo ( get_class ( $instance ), "#manyToMany" );
156	1	if ($members !== false) {
157		$members = \array_keys ( $members );
158		foreach ( $members as $member ) {
159		self::insertOrUpdateManyToMany ( $instance, $member );
160		}
161		}
162	1	}
163
164		/**
165		* Updates the $member member of $instance annotated by a ManyToMany
166		*
167		* @param Object $instance
168		* @param String $member
169		*/
170		public static function insertOrUpdateManyToMany($instance, $member) {
171		$parser = new ManyToManyParser ( $instance, $member );
172		if ($parser->init ()) {
173		$myField = $parser->getMyFkField ();
174		$field = $parser->getFkField ();
175		$sql = "INSERT INTO `" . $parser->getJoinTable () . "`(`" . $myField . "`,`" . $field . "`) VALUES (:" . $myField . ",:" . $field . ");";
176		$memberAccessor = "get" . ucfirst ( $member );
177		$memberValues = $instance->$memberAccessor ();
178		$myKey = $parser->getMyPk ();
179		$myAccessorId = "get" . ucfirst ( $myKey );
180		$accessorId = "get" . ucfirst ( $parser->getPk () );
181		$id = $instance->$myAccessorId ();
182		if (! is_null ( $memberValues )) {
183		self::$db->execute ( "DELETE FROM `" . $parser->getJoinTable () . "` WHERE `" . $myField . "`='" . $id . "'" );
184		$statement = self::$db->prepareStatement ( $sql );
185		foreach ( $memberValues as $targetInstance ) {
186		$foreignId = $targetInstance->$accessorId ();
187		$foreignInstances = self::getAll ( $parser->getTargetEntity (), "`" . $parser->getPk () . "`" . "='" . $foreignId . "'" );
188		if (! OrmUtils::exists ( $targetInstance, $parser->getPk (), $foreignInstances )) {
189		self::insert ( $targetInstance, false );
190		$foreignId = $targetInstance->$accessorId ();
191		Logger::info ( "DAOUpdates", "Insertion d'une instance de " . get_class ( $instance ), "InsertMany" );
192		}
193		self::$db->bindValueFromStatement ( $statement, $myField, $id );
194		self::$db->bindValueFromStatement ( $statement, $field, $foreignId );
195		$statement->execute ();
196		Logger::info ( "DAOUpdates", "Insertion des valeurs dans la table association '" . $parser->getJoinTable () . "'", "InsertMany" );
197		}
198		}
199		}
200		}
201
202		/**
203		* Updates an existing $instance in the database.
204		* Be careful not to modify the primary key
205		*
206		* @param object $instance instance to modify
207		* @param boolean $updateMany Adds or updates ManyToMany members
208		*/
209	3	public static function update($instance, $updateMany = false) {
210	3	EventsManager::trigger ( "dao.before.update", $instance );
211	3	$tableName = OrmUtils::getTableName ( get_class ( $instance ) );
212	3	$ColumnskeyAndValues = Reflexion::getPropertiesAndValues ( $instance );
213	3	$ColumnskeyAndValues = array_merge ( $ColumnskeyAndValues, OrmUtils::getManyToOneMembersAndValues ( $instance ) );
214	3	$keyFieldsAndValues = OrmUtils::getKeyFieldsAndValues ( $instance );
215	3	$sql = "UPDATE `" . $tableName . "` SET " . SqlUtils::getUpdateFieldsKeyAndValues ( $ColumnskeyAndValues ) . " WHERE " . SqlUtils::getWhere ( $keyFieldsAndValues );
216	3	Logger::info ( "DAOUpdates", $sql, "update" );
217	3	Logger::info ( "DAOUpdates", json_encode ( $ColumnskeyAndValues ), "Key and values" );
218	3	$statement = self::$db->prepareStatement ( $sql );
219	3	foreach ( $ColumnskeyAndValues as $key => $value ) {
220	3	self::$db->bindValueFromStatement ( $statement, $key, $value );
221		}
222		try {
223	3	$result = $statement->execute ();
224	3	if ($result && $updateMany)
225	1	self::insertOrUpdateAllManyToMany ( $instance );
226	3	EventsManager::trigger ( DAOEvents::AFTER_UPDATE, $instance, $result );
227	3	$instance->_rest = array_merge ( $instance->_rest, $ColumnskeyAndValues );
228	3	return $result;
229		} catch ( \PDOException $e ) {
230		Logger::warn ( "DAOUpdates", $e->getMessage (), "update" );
231		}
232		return false;
233		}
234
235		/**
236		*
237		* @param object $instance
238		* @param boolean $updateMany
239		* @return boolean\|int
240		*/
241		public static function save($instance, $updateMany = false) {
242		if (isset ( $instance->_rest )) {
243		return self::update ( $instance, $updateMany );
244		}
245		return self::insert ( $instance, $updateMany );
246		}
247		}
248

phpMv / ubiquity

Push — master ( c60d6c...7a2a93 )

DAOUpdatesTrait::removeByKey_() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like