TScaffoldBase::getRecordPkValues() - Code Metrics - pradosoft/prado - Measure and Improve Code Quality continuously with Scrutinizer

TScaffoldBase::getRecordPkValues() A
last analyzed 2025-05-21 15:52 UTC

↳ Parent: TScaffoldBase

Complexity

Conditions	3
Paths	3

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

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

<?php

/**
 * TScaffoldBase class file.
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @link https://github.com/pradosoft/prado
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 */

namespace Prado\Data\ActiveRecord\Scaffold;

/**
 * Include the base Active Record class.
 */
use Prado\Data\ActiveRecord\TActiveRecord;
use Prado\Data\Common\TDbTableInfo;
use Prado\Exceptions\TConfigurationException;
use Prado\Prado;
use Prado\TPropertyValue;
use Prado\Web\UI\TTemplateControl;

/**
 * Base class for Active Record scaffold views.
 *
 * Provides common properties for all scaffold views (such as, TScaffoldListView,
 * TScaffoldEditView, TScaffoldListView and TScaffoldView).
 *
 * During the OnPrRender stage the default css style file (filename style.css)
 * is published and registered. To override the default style, provide your own stylesheet
 * file explicitly.
 *
 * @author Wei Zhuo <weizho[at]gmail[dot]com>
 * @since 3.1
 */
abstract class TScaffoldBase extends TTemplateControl
{
	/**
	 * @var null|TActiveRecord record instance (may be new or retrieved from db)
	 */
	private $_record;

	/**
	 * @return TDbTableInfo table/view information
	 */
	protected function getTableInfo()
	{
		$finder = $this->getRecordFinder();
		$gateway = $finder->getRecordManager()->getRecordGateWay();
		return $gateway->getRecordTableInfo($finder);
	}

	/**
	 * @param \Prado\Data\ActiveRecord\TActiveRecord $record record instance
	 * @return array record property values
	 */
	protected function getRecordPropertyValues($record)
	{
		$data = [];
		foreach ($this->getTableInfo()->getColumns() as $name => $column) {
			$data[] = $record->getColumnValue($name);
		}
		return $data;
	}

	/**
	 * @param \Prado\Data\ActiveRecord\TActiveRecord $record record instance
	 * @return array record primary key values.
	 */
	protected function getRecordPkValues($record)
	{
		$data = [];
		foreach ($this->getTableInfo()->getColumns() as $name => $column) {
			if ($column->getIsPrimaryKey()) {
				$data[] = $record->getColumnValue($name);
			}
		}
		return $data;
	}

	/**
	 * Name of the Active Record class to be viewed or scaffolded.
	 * @return string Active Record class name.
	 */
	public function getRecordClass()
	{
		return $this->getViewState('RecordClass');
	}

	/**
	 * Name of the Active Record class to be viewed or scaffolded.
	 * @param string $value Active Record class name.
	 */
	public function setRecordClass($value)
	{
		$this->setViewState('RecordClass', $value);
	}

	/**
	 * Copy the view details from another scaffold view instance.
	 * @param TScaffoldBase $obj scaffold view.
	 */
	protected function copyFrom(TScaffoldBase $obj)
	{
		$this->_record = $obj->_record;
		$this->setRecordClass($obj->getRecordClass());
		$this->setEnableDefaultStyle($obj->getEnableDefaultStyle());
	}

	/**
	 * Unset the current record instance and table information.
	 */
	protected function clearRecordObject()
	{
		$this->_record = null;
	}

	/**
	 * Gets the current Active Record instance. Creates new instance if the
	 * primary key value is null otherwise the record is fetched from the db.
	 * @param null|array $pk primary key value
	 * @return TActiveRecord record instance
	 */
	protected function getRecordObject($pk = null)
	{
		if ($this->_record === null) {
			if ($pk !== null) {
				$this->_record = $this->getRecordFinder()->findByPk($pk);
				if ($this->_record === null) {
					throw new TConfigurationException(
						'scaffold_invalid_record_pk',
						$this->getRecordClass(),
						$pk
					);
				}
			} else {
				$class = $this->getRecordClass();
				if ($class !== null) {

					$this->_record = Prado::createComponent($class);
				} else {
					throw new TConfigurationException(
						'scaffold_invalid_record_class',
						$this->getRecordClass(),
						$this->getID()
					);
				}
			}
		}
		return $this->_record;
	}

	/**
	 * @param \Prado\Data\ActiveRecord\TActiveRecord $value Active Record instance.
	 */
	protected function setRecordObject(TActiveRecord $value)
	{
		$this->_record = $value;
	}

	/**
	 * @return TActiveRecord Active Record finder instance
	 */
	protected function getRecordFinder()
	{
		return TActiveRecord::finder($this->getRecordClass());
	}

	/**
	 * @return string default scaffold stylesheet name
	 */
	public function getDefaultStyle()
	{
		return $this->getViewState('DefaultStyle', 'style');
	}

	/**
	 * @param string $value default scaffold stylesheet name
	 */
	public function setDefaultStyle($value)
	{
		$this->setViewState('DefaultStyle', TPropertyValue::ensureString($value), 'style');
	}

	/**
	 * @return bool enable default stylesheet, default is true.
	 */
	public function getEnableDefaultStyle()
	{
		return $this->getViewState('EnableDefaultStyle', true);
	}

	/**
	 * @param bool $value enable default stylesheet, default is true.
	 */
	public function setEnableDefaultStyle($value)
	{
		return $this->setViewState('EnableDefaultStyle', TPropertyValue::ensureBoolean($value), true);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
	}

	/**
	 * Publish the default stylesheet file.
	 * @param mixed $param
	 */
	public function onPreRender($param)
	{
		parent::onPreRender($param);
		if ($this->getEnableDefaultStyle()) {
			$url = $this->publishAsset($this->getDefaultStyle() . '.css');
			$this->getPage()->getClientScript()->registerStyleSheetFile($url, $url);
		}
	}
}


1			<?php
2
3			/**
4			* TScaffoldBase class file.
5			*
6			* @author Wei Zhuo <weizhuo[at]gmail[dot]com>
7			* @link https://github.com/pradosoft/prado
8			* @license https://github.com/pradosoft/prado/blob/master/LICENSE
9			*/
10
11			namespace Prado\Data\ActiveRecord\Scaffold;
12
13			/**
14			* Include the base Active Record class.
15			*/
16			use Prado\Data\ActiveRecord\TActiveRecord;
17			use Prado\Data\Common\TDbTableInfo;
18			use Prado\Exceptions\TConfigurationException;
19			use Prado\Prado;
20			use Prado\TPropertyValue;
21			use Prado\Web\UI\TTemplateControl;
22
23			/**
24			* Base class for Active Record scaffold views.
25			*
26			* Provides common properties for all scaffold views (such as, TScaffoldListView,
27			* TScaffoldEditView, TScaffoldListView and TScaffoldView).
28			*
29			* During the OnPrRender stage the default css style file (filename style.css)
30			* is published and registered. To override the default style, provide your own stylesheet
31			* file explicitly.
32			*
33			* @author Wei Zhuo <weizho[at]gmail[dot]com>
34			* @since 3.1
35			*/
36			abstract class TScaffoldBase extends TTemplateControl
37			{
38			/**
39			* @var null\|TActiveRecord record instance (may be new or retrieved from db)
40			*/
41			private $_record;
42
43			/**
44			* @return TDbTableInfo table/view information
45			*/
46			protected function getTableInfo()
47			{
48			$finder = $this->getRecordFinder();
49			$gateway = $finder->getRecordManager()->getRecordGateWay();
50			return $gateway->getRecordTableInfo($finder);
51			}
52
53			/**
54			* @param \Prado\Data\ActiveRecord\TActiveRecord $record record instance
55			* @return array record property values
56			*/
57			protected function getRecordPropertyValues($record)
58			{
59			$data = [];
60			foreach ($this->getTableInfo()->getColumns() as $name => $column) {
61			$data[] = $record->getColumnValue($name);
62			}
63			return $data;
64			}
65
66			/**
67			* @param \Prado\Data\ActiveRecord\TActiveRecord $record record instance
68			* @return array record primary key values.
69			*/
70			protected function getRecordPkValues($record)
71			{
72			$data = [];
73			foreach ($this->getTableInfo()->getColumns() as $name => $column) {
74			if ($column->getIsPrimaryKey()) {
75			$data[] = $record->getColumnValue($name);
76			}
77			}
78			return $data;
79			}
80
81			/**
82			* Name of the Active Record class to be viewed or scaffolded.
83			* @return string Active Record class name.
84			*/
85			public function getRecordClass()
86			{
87			return $this->getViewState('RecordClass');
88			}
89
90			/**
91			* Name of the Active Record class to be viewed or scaffolded.
92			* @param string $value Active Record class name.
93			*/
94			public function setRecordClass($value)
95			{
96			$this->setViewState('RecordClass', $value);
97			}
98
99			/**
100			* Copy the view details from another scaffold view instance.
101			* @param TScaffoldBase $obj scaffold view.
102			*/
103			protected function copyFrom(TScaffoldBase $obj)
104			{
105			$this->_record = $obj->_record;
106			$this->setRecordClass($obj->getRecordClass());
107			$this->setEnableDefaultStyle($obj->getEnableDefaultStyle());
108			}
109
110			/**
111			* Unset the current record instance and table information.
112			*/
113			protected function clearRecordObject()
114			{
115			$this->_record = null;
116			}
117
118			/**
119			* Gets the current Active Record instance. Creates new instance if the
120			* primary key value is null otherwise the record is fetched from the db.
121			* @param null\|array $pk primary key value
122			* @return TActiveRecord record instance
123			*/
124			protected function getRecordObject($pk = null)
125			{
126			if ($this->_record === null) {
127			if ($pk !== null) {
128			$this->_record = $this->getRecordFinder()->findByPk($pk);
129			if ($this->_record === null) {
130			throw new TConfigurationException(
131			'scaffold_invalid_record_pk',
132			$this->getRecordClass(),
133			$pk
134			);
135			}
136			} else {
137			$class = $this->getRecordClass();
138			if ($class !== null) {
			0 ignored issues – show introduced 2019-11-23 15:22 UTC by Report Bug Copy Issue Report The condition `$class !== null` is always `true`. Loading history...
139			$this->_record = Prado::createComponent($class);
140			} else {
141			throw new TConfigurationException(
142			'scaffold_invalid_record_class',
143			$this->getRecordClass(),
144			$this->getID()
145			);
146			}
147			}
148			}
149			return $this->_record;
150			}
151
152			/**
153			* @param \Prado\Data\ActiveRecord\TActiveRecord $value Active Record instance.
154			*/
155			protected function setRecordObject(TActiveRecord $value)
156			{
157			$this->_record = $value;
158			}
159
160			/**
161			* @return TActiveRecord Active Record finder instance
162			*/
163			protected function getRecordFinder()
164			{
165			return TActiveRecord::finder($this->getRecordClass());
166			}
167
168			/**
169			* @return string default scaffold stylesheet name
170			*/
171			public function getDefaultStyle()
172			{
173			return $this->getViewState('DefaultStyle', 'style');
174			}
175
176			/**
177			* @param string $value default scaffold stylesheet name
178			*/
179			public function setDefaultStyle($value)
180			{
181			$this->setViewState('DefaultStyle', TPropertyValue::ensureString($value), 'style');
182			}
183
184			/**
185			* @return bool enable default stylesheet, default is true.
186			*/
187			public function getEnableDefaultStyle()
188			{
189			return $this->getViewState('EnableDefaultStyle', true);
190			}
191
192			/**
193			* @param bool $value enable default stylesheet, default is true.
194			*/
195			public function setEnableDefaultStyle($value)
196			{
197			return $this->setViewState('EnableDefaultStyle', TPropertyValue::ensureBoolean($value), true);
			0 ignored issues – show Bug introduced 2018-02-15 21:32 UTC by Report Bug Copy Issue Report Are you sure the usage of `$this->setViewState('Ena...eBoolean($value), true)` targeting `Prado\Web\UI\TControl::setViewState()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
198			}
199
200			/**
201			* Publish the default stylesheet file.
202			* @param mixed $param
203			*/
204			public function onPreRender($param)
205			{
206			parent::onPreRender($param);
207			if ($this->getEnableDefaultStyle()) {
208			$url = $this->publishAsset($this->getDefaultStyle() . '.css');
209			$this->getPage()->getClientScript()->registerStyleSheetFile($url, $url);
210			}
211			}
212			}
213

pradosoft / prado

TScaffoldBase::getRecordPkValues() A last analyzed 2025-05-21 15:52 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

TScaffoldBase::getRecordPkValues() A
last analyzed 2025-05-21 15:52 UTC