ActiveRecord::save() - Code Metrics - Inspection of "Tests tidying" - ICanBoogie/ActiveRecord - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2f02d3...79061e )

by Olivier

created 2016-01-18 21:51 UTC

ActiveRecord::save() C

↳ Parent: ActiveRecord

Complexity

Conditions	8
Paths	6

Size

Total Lines	46
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes	17
Bugs	3	Features	2

Metric	Value
c	17
b	3
f	2
dl	0
loc	46
rs	5.5555
cc	8
eloc	17
nc	6
nop	0

<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie;

use ICanBoogie\ActiveRecord\Model;

/**
 * Active Record facilitates the creation and use of business objects whose data require persistent
 * storage via database.
 *
 * @property-read Model $model The model managing the active record.
 * @property-read string $model_id The identifier of the model managing the active record.
 */
class ActiveRecord extends Prototyped
{
	/**
	 * The identifier of the model managing the record.
	 *
	 *  @var string
	 */
	const MODEL_ID = null;

	/**
	 * Model managing the active record.
	 *
	 * @var Model
	 */
	private $model;

	/**
	 * Identifier of the model managing the active record.
	 *
	 * Note: Due to a PHP bug (or feature), the visibility of the property MUST NOT be private.
	 * https://bugs.php.net/bug.php?id=40412
	 *
	 * @var string
	 */
	protected $model_id;

	/**
	 * Initializes the {@link $model} and {@link $model_id} properties.
	 *
	 * @param string|Model|null $model The model managing the active record. A {@link Model}
	 * instance can be specified as well as a model identifier. If a model identifier is
	 * specified, the model is resolved when the {@link $model} property is accessed. If `$model`
	 * is empty, the identifier of the model is read from the {@link MODEL_ID} class constant.
	 *
	 * @throws \InvalidArgumentException if $model is neither a model identifier nor a
	 * {@link Model} instance.
	 */
	public function __construct($model = null)
	{
		if (!$model)
		{
			$model = static::MODEL_ID;
		}

		if (is_string($model))
		{
			$this->model_id = $model;
		}
		else if ($model instanceof Model)
		{
			$this->model = $model;
			$this->model_id = $model->id;
		}
		else
		{
			throw new \InvalidArgumentException("\$model must be an instance of ICanBoogie\\ActiveRecord\\Model or a model identifier. Given:" . (is_object($model) ? get_class($model) : gettype($model)));
		}
	}

	/**
	 * Removes the {@link $model} property.
	 *
	 * Properties whose value are instances of the {@link ActiveRecord} class are removed from the
	 * exported properties.
	 */
	public function __sleep()
	{
		$properties = parent::__sleep();

		unset($properties['model']);

		foreach (array_keys($properties) as $property)
		{
			if ($this->$property instanceof self)
			{
				unset($properties[$property]);
			}
		}

		return $properties;
	}

	/**
	 * Removes `model` from the output, since `model_id` is good enough to figure which model
	 * is used.
	 *
	 * @return array
	 */
	public function __debugInfo()
	{
		$array = (array) $this;

		unset($array["\0" . __CLASS__ . "\0model"]);

		return $array;
	}

	/**
	 * Returns the model managing the active record.
	 *
	 * @return Model
	 */
	protected function get_model()
	{
		return $this->model
			?: $this->model = ActiveRecord\get_model($this->model_id);
	}

	/**
	 * Returns the identifier of the model managing the active record.
	 *
	 * @return string
	 */
	protected function get_model_id()
	{
		return $this->model_id;
	}

	/**
	 * Saves the active record using its model.
	 *
	 * @return int|bool Primary key value of the active record, or a boolean if the primary key
	 * is not a serial.
	 */
	public function save()
	{
		$model = $this->get_model();
		$primary = $model->primary;
		$properties = $this->alter_persistent_properties($this->to_array(), $model);

		#
		# Multipart primary key
		#

		if (is_array($primary))
		{
			return $model->insert($properties, [ 'on duplicate' => true ]);
		}

		#
		# Non auto-increment primary key
		#

		if ($primary && isset($properties[$primary])
		&& !$model->extended_schema[$primary]->auto_increment)
		{
			return $model->insert($properties, [ 'on duplicate' => true ]);
		}

		#
		# Auto-increment primary key
		#

		$key = null;

		if (isset($properties[$primary]))
		{
			$key = $properties[$primary];
			unset($properties[$primary]);
		}

		$rc = $model->save($properties, $key);

		if ($key === null && $rc)
		{
			$this->update_primary_key($rc);
		}

		return $rc;
	}

	/**
	 * Unless it's an acceptable value for a column, columns with `null` values are discarded.
	 * This way, we don't have to define every properties before saving our active record.
	 *
	 * @param array $properties
	 * @param Model $model
	 *
	 * @return array The altered persistent properties
	 */
	protected function alter_persistent_properties(array $properties, Model $model)
	{
		$schema = $model->extended_schema;

		foreach ($properties as $identifier => $value)
		{
			if ($value !== null || (isset($schema[$identifier]) && $schema[$identifier]->null))
			{
				continue;
			}

			unset($properties[$identifier]);
		}

		return $properties;
	}

	/**
	 * Updates primary key.
	 *
	 * @param array|string|int $primary_key
	 */
	protected function update_primary_key($primary_key)

	{
		$model = $this->model;
		$property = $model->primary;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

		if (!$property)
		{
			throw new \LogicException("Unable to update primary key, model `$model->id` doesn't define one.");
		}

		$this->$property = $primary_key;
	}

	/**
	 * Deletes the active record using its model.
	 *
	 * @return bool `true` if the record was deleted, `false` otherwise.
	 *
	 * @throws \Exception in attempt to delete a record from a model which primary key is empty.
	 */
	public function delete()

	{
		$model = $this->model;
		$primary = $model->primary;

		if (!$primary)
		{
			throw new \LogicException("Unable to delete record, model `$model->id` doesn't have a primary key.");
		}

		return $model->delete($this->$primary);
	}
}


1		<?php
2
3		/*
4		* This file is part of the ICanBoogie package.
5		*
6		* (c) Olivier Laviale <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace ICanBoogie;
13
14		use ICanBoogie\ActiveRecord\Model;
15
16		/**
17		* Active Record facilitates the creation and use of business objects whose data require persistent
18		* storage via database.
19		*
20		* @property-read Model $model The model managing the active record.
21		* @property-read string $model_id The identifier of the model managing the active record.
22		*/
23		class ActiveRecord extends Prototyped
24		{
25		/**
26		* The identifier of the model managing the record.
27		*
28		* @var string
29		*/
30		const MODEL_ID = null;
31
32		/**
33		* Model managing the active record.
34		*
35		* @var Model
36		*/
37		private $model;
38
39		/**
40		* Identifier of the model managing the active record.
41		*
42		* Note: Due to a PHP bug (or feature), the visibility of the property MUST NOT be private.
43		* https://bugs.php.net/bug.php?id=40412
44		*
45		* @var string
46		*/
47		protected $model_id;
48
49		/**
50		* Initializes the {@link $model} and {@link $model_id} properties.
51		*
52		* @param string\|Model\|null $model The model managing the active record. A {@link Model}
53		* instance can be specified as well as a model identifier. If a model identifier is
54		* specified, the model is resolved when the {@link $model} property is accessed. If `$model`
55		* is empty, the identifier of the model is read from the {@link MODEL_ID} class constant.
56		*
57		* @throws \InvalidArgumentException if $model is neither a model identifier nor a
58		* {@link Model} instance.
59		*/
60		public function __construct($model = null)
61		{
62		if (!$model)
63		{
64		$model = static::MODEL_ID;
65		}
66
67		if (is_string($model))
68		{
69		$this->model_id = $model;
70		}
71		else if ($model instanceof Model)
72		{
73		$this->model = $model;
74		$this->model_id = $model->id;
75		}
76		else
77		{
78		throw new \InvalidArgumentException("\$model must be an instance of ICanBoogie\\ActiveRecord\\Model or a model identifier. Given:" . (is_object($model) ? get_class($model) : gettype($model)));
79		}
80		}
81
82		/**
83		* Removes the {@link $model} property.
84		*
85		* Properties whose value are instances of the {@link ActiveRecord} class are removed from the
86		* exported properties.
87		*/
88		public function __sleep()
89		{
90		$properties = parent::__sleep();
91
92		unset($properties['model']);
93
94		foreach (array_keys($properties) as $property)
95		{
96		if ($this->$property instanceof self)
97		{
98		unset($properties[$property]);
99		}
100		}
101
102		return $properties;
103		}
104
105		/**
106		* Removes `model` from the output, since `model_id` is good enough to figure which model
107		* is used.
108		*
109		* @return array
110		*/
111		public function __debugInfo()
112		{
113		$array = (array) $this;
114
115		unset($array["\0" . __CLASS__ . "\0model"]);
116
117		return $array;
118		}
119
120		/**
121		* Returns the model managing the active record.
122		*
123		* @return Model
124		*/
125		protected function get_model()
126		{
127		return $this->model
128		?: $this->model = ActiveRecord\get_model($this->model_id);
129		}
130
131		/**
132		* Returns the identifier of the model managing the active record.
133		*
134		* @return string
135		*/
136		protected function get_model_id()
137		{
138		return $this->model_id;
139		}
140
141		/**
142		* Saves the active record using its model.
143		*
144		* @return int\|bool Primary key value of the active record, or a boolean if the primary key
145		* is not a serial.
146		*/
147		public function save()
148		{
149		$model = $this->get_model();
150		$primary = $model->primary;
151		$properties = $this->alter_persistent_properties($this->to_array(), $model);
152
153		#
154		# Multipart primary key
155		#
156
157		if (is_array($primary))
158		{
159		return $model->insert($properties, [ 'on duplicate' => true ]);
160		}
161
162		#
163		# Non auto-increment primary key
164		#
165
166		if ($primary && isset($properties[$primary])
167		&& !$model->extended_schema[$primary]->auto_increment)
168		{
169		return $model->insert($properties, [ 'on duplicate' => true ]);
170		}
171
172		#
173		# Auto-increment primary key
174		#
175
176		$key = null;
177
178		if (isset($properties[$primary]))
179		{
180		$key = $properties[$primary];
181		unset($properties[$primary]);
182		}
183
184		$rc = $model->save($properties, $key);
185
186		if ($key === null && $rc)
187		{
188		$this->update_primary_key($rc);
189		}
190
191		return $rc;
192		}
193
194		/**
195		* Unless it's an acceptable value for a column, columns with `null` values are discarded.
196		* This way, we don't have to define every properties before saving our active record.
197		*
198		* @param array $properties
199		* @param Model $model
200		*
201		* @return array The altered persistent properties
202		*/
203		protected function alter_persistent_properties(array $properties, Model $model)
204		{
205		$schema = $model->extended_schema;
206
207		foreach ($properties as $identifier => $value)
208		{
209		if ($value !== null \|\| (isset($schema[$identifier]) && $schema[$identifier]->null))
210		{
211		continue;
212		}
213
214		unset($properties[$identifier]);
215		}
216
217		return $properties;
218		}
219
220		/**
221		* Updates primary key.
222		*
223		* @param array\|string\|int $primary_key
224		*/
225	View Code Duplication	protected function update_primary_key($primary_key)
		0 ignored issues – show Duplication introduced 2016-01-18 21:54 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
226		{
227		$model = $this->model;
228		$property = $model->primary;
		0 ignored issues – show Documentation introduced 2016-01-16 20:30 UTC by Report Bug Copy Issue Report The property `$primary` is declared protected in `ICanBoogie\ActiveRecord\Table`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
229
230		if (!$property)
231		{
232		throw new \LogicException("Unable to update primary key, model `$model->id` doesn't define one.");
233		}
234
235		$this->$property = $primary_key;
236		}
237
238		/**
239		* Deletes the active record using its model.
240		*
241		* @return bool `true` if the record was deleted, `false` otherwise.
242		*
243		* @throws \Exception in attempt to delete a record from a model which primary key is empty.
244		*/
245	View Code Duplication	public function delete()
		0 ignored issues – show Duplication introduced 2016-01-18 21:54 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
246		{
247		$model = $this->model;
248		$primary = $model->primary;
249
250		if (!$primary)
251		{
252		throw new \LogicException("Unable to delete record, model `$model->id` doesn't have a primary key.");
253		}
254
255		return $model->delete($this->$primary);
256		}
257		}
258

ICanBoogie / ActiveRecord

Push — master ( 2f02d3...79061e )

ActiveRecord::save() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like