Merge pull request #4589 from najdanovicivan/model-id

BaseModel - Add public getIdValue() method

Author: MGatner

system/BaseModel.php

@@ -463,9 +463,26 @@ abstract protected function doErrors();
 	 * @param array|object $data Data
 	 *
 	 * @return integer|array|string|null
+	 *
+	 * @deprecated Add an override on getIdValue() instead. Will be removed in version 5.0.
 	 */
 	abstract protected function idValue($data);
 
+	/**
+	 * Public getter to return the id value using the idValue() method
+	 * For example with SQL this will return $data->$this->primaryKey
+	 *
+	 * @param array|object $data
+	 *
+	 * @return array|integer|string|null
+	 *
+	 * @todo: Make abstract in version 5.0
+	 */
+	public function getIdValue($data)
+	{
+		return $this->idValue($data);
+	}
+
 	/**
 	 * Override countAllResults to account for soft deleted accounts.
 	 * This methods works only with dbCalls
@@ -663,7 +680,7 @@ public function save($data): bool
 
 		if ($this->shouldUpdate($data))
 		{
-			$response = $this->update($this->idValue($data), $data);
+			$response = $this->update($this->getIdValue($data), $data);
 		}
 		else
 		{
@@ -687,7 +704,7 @@ public function save($data): bool
 	 */
 	protected function shouldUpdate($data) : bool
 	{
-		return ! empty($this->idValue($data));
+		return ! empty($this->getIdValue($data));
 	}
 
 	/**

system/Model.php

@@ -459,8 +459,22 @@ protected function doErrors()
 	 * @param array|object $data Data
 	 *
 	 * @return integer|array|string|null
+	 *
+	 * @deprecated Use getIdValue() instead. Will be removed in version 5.0.
 	 */
 	protected function idValue($data)
+	{
+		return $this->getIdValue($data);
+	}
+
+	/**
+	 * Returns the id value for the data array or object
+	 *
+	 * @param array|object $data Data
+	 *
+	 * @return integer|array|string|null
+	 */
+	public function getIdValue($data)
 	{
 		if (is_object($data) && isset($data->{$this->primaryKey}))
 		{
@@ -636,7 +650,7 @@ protected function shouldUpdate($data) : bool
 		return parent::shouldUpdate($data) &&
 			($this->useAutoIncrement
 				? true
-				: $this->where($this->primaryKey, $this->idValue($data))->countAllResults() === 1
+				: $this->where($this->primaryKey, $this->getIdValue($data))->countAllResults() === 1
 			);
 	}
 

user_guide_src/source/changelogs/v4.1.2.rst

@@ -52,6 +52,7 @@ Deprecations:
 - Deprecated ``Time::instance()``, use ``Time::createFromInstance()`` instead (now accepts ``DateTimeInterface``).
 - Deprecated ``IncomingRequest::removeRelativeDirectory()``, use ``URI::removeDotSegments()`` instead
 - Deprecated ``\API\ResponseTrait::failValidationError`` to use ``\API\ResponseTrait::failValidationErrors`` instead
+- Deprecated ``BaseModel::idValue()`` in favor of public ``BaseModel::getIdValue()``. ``BaseModel::getIdValue()`` will be defined as abstract in future any custom Model classes should be updated.
 
 Bugs Fixed: