Prado\Web\UI\WebControls\TStyle

Complexity

Total Complexity

72

Size/Duplication

Total Lines	444
Duplicated Lines	0 %

Test Coverage

Coverage

5.16%

Importance

Changes	1
Bugs	0	Features	0

37 Methods

Rating	Name	Duplication	Size	Complexity
A	setBorderColor()	0	6	2
A	__construct()	0	5	2
A	setBorderWidth()	0	6	2
A	__clone()	0	4	2
A	setBorderStyle()	0	6	2
A	setBackColor()	0	6	2
A	_getZappableSleepProps()	0	17	6
A	getBorderColor()	0	3	1
A	getBackColor()	0	3	1
A	getBorderStyle()	0	3	1
A	getBorderWidth()	0	3	1
A	setHeight()	0	6	2
A	copyFrom()	0	12	5
B	addAttributesToRender()	0	16	7
A	getFont()	0	6	2
A	setCustomStyle()	0	3	1
A	clearStyleField()	0	3	1
A	setStyleField()	0	3	1
A	setForeColor()	0	6	2
A	setDisplayStyle()	0	16	5
A	getStyleFields()	0	3	1
A	hasFont()	0	3	1
A	getCssClass()	0	3	2
A	getDisplayStyle()	0	3	1
A	hasCssClass()	0	3	1
A	getForeColor()	0	3	1
A	setWidth()	0	3	1
A	hasStyleField()	0	3	1
A	mergeWith()	0	12	5
A	getStyleField()	0	3	1
A	getHeight()	0	3	1
A	getCustomStyle()	0	3	2
A	getWidth()	0	3	1
A	setCssClass()	0	3	1
A	reset()	0	6	1
A	setBorderRadius()	0	6	2
A	getBorderRadius()	0	3	1

<?php
/**
 * TStyle class file.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @link https://github.com/pradosoft/prado
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 * @package Prado\Web\UI\WebControls
 */

namespace Prado\Web\UI\WebControls;

use Prado\TPropertyValue;

/**
 * TStyle class
 *
 * TStyle encapsulates the CSS style applied to a control.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @package Prado\Web\UI\WebControls
 * @since 3.0
 */
class TStyle extends \Prado\TComponent
{
	/**
	 * @var array storage of CSS fields
	 */
	protected $_fields = [];
	/**
	 * @var TFont font object
	 */
	protected $_font;
	/**
	 * @var string CSS class name
	 */
	protected $_class;
	/**
	 * @var string CSS style string (those not represented by specific fields of TStyle)
	 */
	protected $_customStyle;
	/**
	 * @var string display style
	 */
	protected $_displayStyle = 'Fixed';

	/**
	 * Returns an array with the names of all variables of this object that should NOT be serialized
	 * because their value is the default one or useless to be cached for the next page loads.
	 * Reimplement in derived classes to add new variables, but remember to  also to call the parent
	 * implementation first.
	 * @param array $exprops by reference
	 */
	protected function _getZappableSleepProps(&$exprops)
	{
		parent::_getZappableSleepProps($exprops);
		if ($this->_fields === []) {
			$exprops[] = "\0*\0_fields";
		}
		if ($this->_font === null) {
			$exprops[] = "\0*\0_font";
		}
		if ($this->_class === null) {
			$exprops[] = "\0*\0_class";
		}
		if ($this->_customStyle === null) {
			$exprops[] = "\0*\0_customStyle";
		}
		if ($this->_displayStyle === 'Fixed') {
			$exprops[] = "\0*\0_displayStyle";
		}
	}

	/**
	 * Constructor.
	 * @param TStyle $style style to copy from
	 */
	public function __construct($style = null)
	{
		parent::__construct();
		if ($style !== null) {
			$this->copyFrom($style);
		}
	}

	/**
	 * Need to clone the font object.
	 */
	public function __clone()
	{
		if ($this->_font !== null) {
			$this->_font = clone($this->_font);
		}
	}

	/**
	 * @return string the background color of the control
	 */
	public function getBackColor()
	{
		return $this->_fields['background-color'] ?? '';
	}

	/**
	 * @param string $value the background color of the control
	 */
	public function setBackColor($value)
	{
		if (trim($value) === '') {
			unset($this->_fields['background-color']);
		} else {
			$this->_fields['background-color'] = $value;
		}
	}

	/**
	 * @return string the border color of the control
	 */
	public function getBorderColor()
	{
		return $this->_fields['border-color'] ?? '';
	}

	/**
	 * @param string $value the border color of the control
	 */
	public function setBorderColor($value)
	{
		if (trim($value) === '') {
			unset($this->_fields['border-color']);
		} else {
			$this->_fields['border-color'] = $value;
		}
	}

	/**
	 * @return string the border style of the control
	 */
	public function getBorderStyle()
	{
		return $this->_fields['border-style'] ?? '';
	}

	/**
	 * Sets the border style of the control.
	 * @param string $value the border style of the control
	 */
	public function setBorderStyle($value)
	{
		if (trim($value) === '') {
			unset($this->_fields['border-style']);
		} else {
			$this->_fields['border-style'] = $value;
		}
	}

	/**
	 * @return string the border width of the control
	 */
	public function getBorderWidth()
	{
		return $this->_fields['border-width'] ?? '';
	}

	/**
	 * @param string $value the border width of the control
	 */
	public function setBorderWidth($value)
	{
		if (trim($value) === '') {
			unset($this->_fields['border-width']);
		} else {
			$this->_fields['border-width'] = $value;
		}
	}

	/**
	 * @return string the border radius of the panel
	 * @since 4.2.0
	 */
	public function getBorderRadius()
	{
		return $this->_fields['border-radius'] ?? '';
	}

	/**
	 * @param string $value the border radius of the panel
	 * @since 4.2.0
	 */
	public function setBorderRadius($value)
	{
		if (trim($value) === '') {
			unset($this->_fields['border-radius']);
		} else {
			$this->_fields['border-radius'] = $value;
		}
	}

	/**
	 * @return string the CSS class of the control
	 */
	public function getCssClass()
	{
		return $this->_class === null ? '' : $this->_class;
	}

	/**
	 * @return bool true if CSS is set or empty.
	 */
	public function hasCssClass()
	{
		return ($this->_class !== null);
	}

	/**
	 * @param string $value the name of the CSS class of the control
	 */
	public function setCssClass($value)
	{
		$this->_class = $value;
	}

	/**
	 * @return TFont the font of the control
	 */
	public function getFont()
	{
		if ($this->_font === null) {
			$this->_font = new TFont;
		}
		return $this->_font;
	}

	/**
	 * @return bool true if font is set.
	 */
	public function hasFont()
	{
		return $this->_font !== null;
	}

	/**
	 * @param TDisplayStyle $value control display style, default is TDisplayStyle::Fixed
	 */
	public function setDisplayStyle($value)
	{
		$this->_displayStyle = TPropertyValue::ensureEnum($value, 'Prado\\Web\\UI\\WebControls\\TDisplayStyle');
		switch ($this->_displayStyle) {
			case TDisplayStyle::None:
				$this->_fields['display'] = 'none';
				break;
			case TDisplayStyle::Dynamic:
				$this->_fields['display'] = ''; //remove the display property
				break;
			case TDisplayStyle::Fixed:
				$this->_fields['visibility'] = 'visible';
				break;
			case TDisplayStyle::Hidden:
				$this->_fields['visibility'] = 'hidden';
				break;
		}
	}

	/**
	 * @return TDisplayStyle display style
	 */
	public function getDisplayStyle()
	{
		return $this->_displayStyle;

The expression return $this->_displayStyle returns the type string which is incompatible with the documented return type Prado\Web\UI\WebControls\TDisplayStyle.

	}

	/**
	 * @return string the foreground color of the control
	 */
	public function getForeColor()
	{
		return $this->_fields['color'] ?? '';
	}

	/**
	 * @param string $value the foreground color of the control
	 */
	public function setForeColor($value)
	{
		if (trim($value) === '') {
			unset($this->_fields['color']);
		} else {
			$this->_fields['color'] = $value;
		}
	}

	/**
	 * @return string the height of the control
	 */
	public function getHeight()
	{
		return $this->_fields['height'] ?? '';
	}

	/**
	 * @param string $value the height of the control
	 */
	public function setHeight($value)
	{
		if (trim($value) === '') {
			unset($this->_fields['height']);
		} else {
			$this->_fields['height'] = $value;
		}
	}

	/**
	 * @return string the custom style of the control
	 */
	public function getCustomStyle()
	{
		return $this->_customStyle === null ? '' : $this->_customStyle;
	}

	/**
	 * Sets custom style fields from a string.
	 * Custom style fields will be overwritten by style fields explicitly defined.
	 * @param string $value the custom style of the control
	 */
	public function setCustomStyle($value)
	{
		$this->_customStyle = $value;
	}

	/**
	 * @param mixed $name
	 * @return string a single style field value set via {@link setStyleField}. Defaults to empty string.
	 */
	public function getStyleField($name)
	{
		return $this->_fields[$name] ?? '';
	}

	/**
	 * Sets a single style field value.
	 * Style fields set by this method will overwrite those set by {@link setCustomStyle}.
	 * @param string $name style field name
	 * @param string $value style field value
	 */
	public function setStyleField($name, $value)
	{
		$this->_fields[$name] = $value;
	}

	/**
	 * Clears a single style field value;
	 * @param string $name style field name
	 */
	public function clearStyleField($name)
	{
		unset($this->_fields[$name]);
	}

	/**
	 * @param mixed $name
	 * @return bool whether a style field has been defined by {@link setStyleField}
	 */
	public function hasStyleField($name)
	{
		return isset($this->_fields[$name]);
	}

	/**
	 * @return string the width of the control
	 */
	public function getWidth()
	{
		return $this->_fields['width'] ?? '';
	}

	/**
	 * @param string $value the width of the control
	 */
	public function setWidth($value)
	{
		$this->_fields['width'] = $value;
	}

	/**
	 * Resets the style to the original empty state.
	 */
	public function reset()
	{
		$this->_fields = [];
		$this->_font = null;
		$this->_class = null;
		$this->_customStyle = null;
	}

	/**
	 * Copies the fields in a new style to this style.
	 * If a style field is set in the new style, the corresponding field
	 * in this style will be overwritten.
	 * @param TStyle $style the new style
	 */
	public function copyFrom($style)
	{
		if ($style instanceof TStyle) {

$style is always a sub-type of Prado\Web\UI\WebControls\TStyle.

			$this->_fields = array_merge($this->_fields, $style->_fields);
			if ($style->_class !== null) {
				$this->_class = $style->_class;
			}
			if ($style->_customStyle !== null) {
				$this->_customStyle = $style->_customStyle;
			}
			if ($style->_font !== null) {
				$this->getFont()->copyFrom($style->_font);
			}
		}
	}

	/**
	 * Merges the style with a new one.
	 * If a style field is not set in this style, it will be overwritten by
	 * the new one.
	 * @param TStyle $style the new style
	 */
	public function mergeWith($style)
	{
		if ($style instanceof TStyle) {

$style is always a sub-type of Prado\Web\UI\WebControls\TStyle.

			$this->_fields = array_merge($style->_fields, $this->_fields);
			if ($this->_class === null) {
				$this->_class = $style->_class;
			}
			if ($this->_customStyle === null) {
				$this->_customStyle = $style->_customStyle;
			}
			if ($style->_font !== null) {
				$this->getFont()->mergeWith($style->_font);
			}
		}
	}

	/**
	 * Adds attributes related to CSS styles to renderer.
	 * @param \Prado\Web\UI\THtmlWriter $writer the writer used for the rendering purpose
	 */
	public function addAttributesToRender($writer)
	{
		if ($this->_customStyle !== null) {
			foreach (explode(';', $this->_customStyle) as $style) {
				$arr = explode(':', $style, 2);
				if (isset($arr[1]) && trim($arr[0]) !== '') {
					$writer->addStyleAttribute(trim($arr[0]), trim($arr[1]));
				}
			}
		}
		$writer->addStyleAttributes($this->_fields);
		if ($this->_font !== null) {
			$this->_font->addAttributesToRender($writer);
		}
		if ($this->_class !== null) {
			$writer->addAttribute('class', $this->_class);
		}
	}

	/**
	 * @return array list of style fields.
	 */
	public function getStyleFields()
	{
		return $this->_fields;
	}
}