PolymorphicForeignKey::writeToManipulation() - Code Metrics - Inspection of "Merge branch '3.7' into 3" - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 3 ( 3f46f2...6a6eaf )

by Robbie

created 2019-02-19 01:35 UTC

PolymorphicForeignKey::writeToManipulation() A

↳ Parent: PolymorphicForeignKey

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	11
rs	9.9
c	0
b	0
f	0

<?php

/**
 * A special ForeignKey class that handles relations with arbitrary class types
 *
 * @package framework
 * @subpackage model
 */
class PolymorphicForeignKey extends ForeignKey implements CompositeDBField {

	/**
	 * @var boolean $isChanged
	 */
	protected $isChanged = false;

	/**
	 * Value of relation class
	 *
	 * @var string
	 */
	protected $classValue = null;

	/**
	 * Field definition cache for compositeDatabaseFields
	 *
	 * @var string
	 */
	protected static $classname_spec_cache = array();

	/**
	 * Clear all cached classname specs. It's necessary to clear all cached subclassed names
	 * for any classes if a new class manifest is generated.
	 */
	public static function clear_classname_spec_cache() {
		self::$classname_spec_cache = array();

	}

	public function scaffoldFormField($title = null, $params = null) {
		// Opt-out of form field generation - Scaffolding should be performed on
		// the has_many end, or set programatically.
		// @todo - Investigate suitable FormField
		return null;
	}

	public function requireField() {
		$fields = $this->compositeDatabaseFields();
		if($fields) foreach($fields as $name => $type){

			DB::requireField($this->tableName, $this->name.$name, $type);

		}
	}

	public function writeToManipulation(&$manipulation) {

		// Write ID, checking that the value is valid
		$manipulation['fields'][$this->name . 'ID'] = $this->exists()
			? $this->prepValueForDB($this->getIDValue())
			: $this->nullValue();

		// Write class
		$classObject = DBField::create_field('Enum', $this->getClassValue(), $this->name . 'Class');
		$classObject->writeToManipulation($manipulation);
	}

	public function addToQuery(&$query) {
		parent::addToQuery($query);
		$query->selectField(
			"\"{$this->tableName}\".\"{$this->name}ID\"",
			"{$this->name}ID"
		);
		$query->selectField(
			"\"{$this->tableName}\".\"{$this->name}Class\"",
			"{$this->name}Class"
		);
	}

	/**
	 * Get the value of the "Class" this key points to
	 *
	 * @return string Name of a subclass of DataObject
	 */
	public function getClassValue() {
		return $this->classValue;
	}

	/**
	 * Set the value of the "Class" this key points to
	 *
	 * @param string $class Name of a subclass of DataObject
	 * @param boolean $markChanged Mark this field as changed?
	 */
	public function setClassValue($class, $markChanged = true) {
		$this->classValue = $class;
		if($markChanged) $this->isChanged = true;
	}

	/**
	 * Gets the value of the "ID" this key points to
	 *
	 * @return integer
	 */
	public function getIDValue() {
		return parent::getValue();
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
	}

	/**
	 * Sets the value of the "ID" this key points to
	 *
	 * @param integer $id
	 * @param boolean $markChanged Mark this field as changed?
	 */
	public function setIDValue($id, $markChanged = true) {
		parent::setValue($id);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
		if($markChanged) $this->isChanged = true;
	}

	public function setValue($value, $record = null, $markChanged = true) {
		$idField = "{$this->name}ID";
		$classField = "{$this->name}Class";

		// Check if an object is assigned directly
		if($value instanceof DataObject) {
			$record = array(
				$idField => $value->ID,
				$classField => $value->class
			);
		}

		// Convert an object to an array
		if($record instanceof DataObject) {
			$record = $record->getQueriedDatabaseFields();
		}

		// Use $value array if record is missing
		if(empty($record) && is_array($value)) {
			$record = $value;
		}

		// Inspect presented values
		if(isset($record[$idField]) && isset($record[$classField])) {
			if(empty($record[$idField]) || empty($record[$classField])) {
				$this->setIDValue($this->nullValue(), $markChanged);
				$this->setClassValue('', $markChanged);
			} else {
				$this->setClassValue($record[$classField], $markChanged);
				$this->setIDValue($record[$idField], $markChanged);
			}
		}
	}

	public function getValue() {
		if($this->exists()) {
			return DataObject::get_by_id($this->getClassValue(), $this->getIDValue());
		}
	}

	public function compositeDatabaseFields() {

		// Ensure the table level cache exists
		if(empty(self::$classname_spec_cache[$this->tableName])) {
			self::$classname_spec_cache[$this->tableName] = array();
		}

		// Ensure the field level cache exists
		if(empty(self::$classname_spec_cache[$this->tableName][$this->name])) {

			// Get all class names
			$classNames = ClassInfo::subclassesFor('DataObject');
			unset($classNames['DataObject']);

			$schema = DB::get_schema();
			if($schema->hasField($this->tableName, "{$this->name}Class")) {
				$existing = DB::query("SELECT DISTINCT \"{$this->name}Class\" FROM \"{$this->tableName}\"")->column();
				$classNames = array_unique(array_merge($classNames, $existing));
			}

			self::$classname_spec_cache[$this->tableName][$this->name]
				= "Enum(array('" . implode("', '", array_filter($classNames)) . "'))";
		}

		return array(
			'ID' => 'Int',
			'Class' => self::$classname_spec_cache[$this->tableName][$this->name]
		);
	}

	public function isChanged() {
		return $this->isChanged;
	}

	public function exists() {
		return $this->getClassValue() && $this->getIDValue();
	}

    public function scalarValueOnly()
    {
        return false;
    }
}


1			<?php
2
3			/**
4			* A special ForeignKey class that handles relations with arbitrary class types
5			*
6			* @package framework
7			* @subpackage model
8			*/
9			class PolymorphicForeignKey extends ForeignKey implements CompositeDBField {
10
11			/**
12			* @var boolean $isChanged
13			*/
14			protected $isChanged = false;
15
16			/**
17			* Value of relation class
18			*
19			* @var string
20			*/
21			protected $classValue = null;
22
23			/**
24			* Field definition cache for compositeDatabaseFields
25			*
26			* @var string
27			*/
28			protected static $classname_spec_cache = array();
29
30			/**
31			* Clear all cached classname specs. It's necessary to clear all cached subclassed names
32			* for any classes if a new class manifest is generated.
33			*/
34			public static function clear_classname_spec_cache() {
35			self::$classname_spec_cache = array();
			0 ignored issues – show Documentation Bug introduced 2015-11-26 12:19 UTC by Report Bug Copy Issue Report It seems like `array()` of type `array` is incompatible with the declared type `string` of property `$classname_spec_cache`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
36			}
37
38			public function scaffoldFormField($title = null, $params = null) {
39			// Opt-out of form field generation - Scaffolding should be performed on
40			// the has_many end, or set programatically.
41			// @todo - Investigate suitable FormField
42			return null;
43			}
44
45			public function requireField() {
46			$fields = $this->compositeDatabaseFields();
47			if($fields) foreach($fields as $name => $type){
			0 ignored issues – show Bug Best Practice introduced 2015-11-26 12:19 UTC by Report Bug Copy Issue Report The expression `$fields` of type `array<string,string>` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
48			DB::requireField($this->tableName, $this->name.$name, $type);
			0 ignored issues – show Deprecated Code introduced 2015-11-26 12:19 UTC by Report Bug Copy Issue Report The method `DB::requireField()` has been deprecated with message: since version 4.0 Use DB::require_field instead This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
49			}
50			}
51
52			public function writeToManipulation(&$manipulation) {
53
54			// Write ID, checking that the value is valid
55			$manipulation['fields'][$this->name . 'ID'] = $this->exists()
56			? $this->prepValueForDB($this->getIDValue())
57			: $this->nullValue();
58
59			// Write class
60			$classObject = DBField::create_field('Enum', $this->getClassValue(), $this->name . 'Class');
61			$classObject->writeToManipulation($manipulation);
62			}
63
64			public function addToQuery(&$query) {
65			parent::addToQuery($query);
66			$query->selectField(
67			"\"{$this->tableName}\".\"{$this->name}ID\"",
68			"{$this->name}ID"
69			);
70			$query->selectField(
71			"\"{$this->tableName}\".\"{$this->name}Class\"",
72			"{$this->name}Class"
73			);
74			}
75
76			/**
77			* Get the value of the "Class" this key points to
78			*
79			* @return string Name of a subclass of DataObject
80			*/
81			public function getClassValue() {
82			return $this->classValue;
83			}
84
85			/**
86			* Set the value of the "Class" this key points to
87			*
88			* @param string $class Name of a subclass of DataObject
89			* @param boolean $markChanged Mark this field as changed?
90			*/
91			public function setClassValue($class, $markChanged = true) {
92			$this->classValue = $class;
93			if($markChanged) $this->isChanged = true;
94			}
95
96			/**
97			* Gets the value of the "ID" this key points to
98			*
99			* @return integer
100			*/
101			public function getIDValue() {
102			return parent::getValue();
			0 ignored issues – show Comprehensibility Bug introduced 2015-11-26 12:19 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`getValue()` instead of `getIDValue()`). Are you sure this is correct? If so, you might want to change this to `$this->getValue()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
103			}
104
105			/**
106			* Sets the value of the "ID" this key points to
107			*
108			* @param integer $id
109			* @param boolean $markChanged Mark this field as changed?
110			*/
111			public function setIDValue($id, $markChanged = true) {
112			parent::setValue($id);
			0 ignored issues – show Comprehensibility Bug introduced 2015-11-26 12:19 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`setValue()` instead of `setIDValue()`). Are you sure this is correct? If so, you might want to change this to `$this->setValue()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
113			if($markChanged) $this->isChanged = true;
114			}
115
116			public function setValue($value, $record = null, $markChanged = true) {
117			$idField = "{$this->name}ID";
118			$classField = "{$this->name}Class";
119
120			// Check if an object is assigned directly
121			if($value instanceof DataObject) {
122			$record = array(
123			$idField => $value->ID,
124			$classField => $value->class
125			);
126			}
127
128			// Convert an object to an array
129			if($record instanceof DataObject) {
130			$record = $record->getQueriedDatabaseFields();
131			}
132
133			// Use $value array if record is missing
134			if(empty($record) && is_array($value)) {
135			$record = $value;
136			}
137
138			// Inspect presented values
139			if(isset($record[$idField]) && isset($record[$classField])) {
140			if(empty($record[$idField]) \|\| empty($record[$classField])) {
141			$this->setIDValue($this->nullValue(), $markChanged);
142			$this->setClassValue('', $markChanged);
143			} else {
144			$this->setClassValue($record[$classField], $markChanged);
145			$this->setIDValue($record[$idField], $markChanged);
146			}
147			}
148			}
149
150			public function getValue() {
151			if($this->exists()) {
152			return DataObject::get_by_id($this->getClassValue(), $this->getIDValue());
153			}
154			}
155
156			public function compositeDatabaseFields() {
157
158			// Ensure the table level cache exists
159			if(empty(self::$classname_spec_cache[$this->tableName])) {
160			self::$classname_spec_cache[$this->tableName] = array();
161			}
162
163			// Ensure the field level cache exists
164			if(empty(self::$classname_spec_cache[$this->tableName][$this->name])) {
165
166			// Get all class names
167			$classNames = ClassInfo::subclassesFor('DataObject');
168			unset($classNames['DataObject']);
169
170			$schema = DB::get_schema();
171			if($schema->hasField($this->tableName, "{$this->name}Class")) {
172			$existing = DB::query("SELECT DISTINCT \"{$this->name}Class\" FROM \"{$this->tableName}\"")->column();
173			$classNames = array_unique(array_merge($classNames, $existing));
174			}
175
176			self::$classname_spec_cache[$this->tableName][$this->name]
177			= "Enum(array('" . implode("', '", array_filter($classNames)) . "'))";
178			}
179
180			return array(
181			'ID' => 'Int',
182			'Class' => self::$classname_spec_cache[$this->tableName][$this->name]
183			);
184			}
185
186			public function isChanged() {
187			return $this->isChanged;
188			}
189
190			public function exists() {
191			return $this->getClassValue() && $this->getIDValue();
192			}
193
194			public function scalarValueOnly()
195			{
196			return false;
197			}
198			}
199

silverstripe / silverstripe-framework

Push — 3 ( 3f46f2...6a6eaf )

PolymorphicForeignKey::writeToManipulation() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like