Prado\Data\ActiveRecord\Scaffold\TScaffoldBase

Complexity

Total Complexity

23

Size/Duplication

Total Lines	174
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	getDefaultStyle()	0	3	1
A	copyFrom()	0	5	1
A	getEnableDefaultStyle()	0	3	1
A	setRecordClass()	0	3	1
A	onPreRender()	0	6	2
A	setDefaultStyle()	0	3	1
A	getTableInfo()	0	5	1
A	getRecordClass()	0	3	1
A	getRecordObject()	0	26	5
A	getRecordPropertyValues()	0	7	2
A	clearRecordObject()	0	3	1
A	getRecordPkValues()	0	9	3
A	setEnableDefaultStyle()	0	3	1
A	getRecordFinder()	0	3	1
A	setRecordObject()	0	3	1

<?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) {

The condition $class !== null is always true.

					$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);

Are you sure the usage of $this->setViewState('EnableDefaultStyle', Prado\TPropertyValue::ensureBoolean($value), true) targeting Prado\Web\UI\TControl::setViewState() seems to always return null.

	}

	/**
	 * 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);
		}
	}
}