TPanelStyle::setBackImageUrl() - Code Metrics - Inspection of "General Utility Update and Addition (#756)" - pradosoft/prado - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 202a73...bb5081 )

by Fabio
created 2021-04-27 09:47 UTC
TPanelStyle::setBackImageUrl() A

↳ Parent: TPanelStyle
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	3
ccs	0
cts	2
cp	0
crap	2
rs	10
<?php
/**
 * TPanelStyle class file
 *
 * @author Qiang Xue <[email protected]>
 * @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;

/**
 * TPanelStyle class.
 * TPanelStyle represents the CSS style specific for panel HTML tag.
 *
 * @author Qiang Xue <[email protected]>
 * @package Prado\Web\UI\WebControls
 * @since 3.0
 */
class TPanelStyle extends TStyle
{
	/**
	 * @var string the URL of the background image for the panel component
	 */
	protected $_backImageUrl;
	/**
	 * @var string alignment of the content in the panel.
	 */
	protected $_direction;
	/**
	 * @var string horizontal alignment of the contents within the panel
	 */
	protected $_horizontalAlign;
	/**
	 * @var string visibility and position of scroll bars
	 */
	protected $_scrollBars;
	/**
	 * @var bool whether the content wraps within the panel
	 */
	protected $_wrap;
	/**
	 * @var bool whether the content wraps within the panel
	 */
	protected $_boxshadow;

	/**
	 * 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->_backImageUrl === null) {
			$exprops[] = "\0*\0_backImageUrl";
		}
		if ($this->_direction === null) {
			$exprops[] = "\0*\0_direction";
		}
		if ($this->_horizontalAlign === null) {
			$exprops[] = "\0*\0_horizontalAlign";
		}
		if ($this->_scrollBars === null) {
			$exprops[] = "\0*\0_scrollBars";
		}
		if ($this->_wrap === null) {
			$exprops[] = "\0*\0_wrap";
		}
		if ($this->_boxshadow === null) {
			$exprops[] = "\0*\0_boxshadow";
		}
	}

	/**
	 * Adds attributes related to CSS styles to renderer.
	 * This method overrides the parent implementation.
	 * @param \Prado\Web\UI\THtmlWriter $writer the writer used for the rendering purpose
	 */
	public function addAttributesToRender($writer)
	{
		if (($url = trim($this->getBackImageUrl())) !== '') {
			$this->setStyleField('background-image', 'url(' . $url . ')');
		}

		switch ($this->getScrollBars()) {
			case TScrollBars::Horizontal: $this->setStyleField('overflow-x', 'scroll'); break;
			case TScrollBars::Vertical: $this->setStyleField('overflow-y', 'scroll'); break;
			case TScrollBars::Both: $this->setStyleField('overflow', 'scroll'); break;
			case TScrollBars::Auto: $this->setStyleField('overflow', 'auto'); break;
		}

		if (($align = $this->getHorizontalAlign()) !== THorizontalAlign::NotSet) {

			$this->setStyleField('text-align', strtolower($align));
			$this->setStyleField('text-align', strtolower(/** @scrutinizer ignore-type */ $align));
		}

		if (!$this->getWrap()) {
			$this->setStyleField('white-space', 'nowrap');
		}

		if (($direction = $this->getDirection()) !== TContentDirection::NotSet) {

			if ($direction === TContentDirection::LeftToRight) {

				$this->setStyleField('direction', 'ltr');
			} else {
				$this->setStyleField('direction', 'rtl');
			}
		}
		if ($boxShadow = $this->getBoxShadow()) {
			$this->setStyleField('box-shadow', $boxShadow);
		}

		parent::addAttributesToRender($writer);
	}

	/**
	 * @return string the URL of the background image for the panel component.
	 */
	public function getBackImageUrl()
	{
		return $this->_backImageUrl === null ? '' : $this->_backImageUrl;
	}

	/**
	 * Sets the URL of the background image for the panel component.
	 * @param string $value the URL
	 */
	public function setBackImageUrl($value)
	{
		$this->_backImageUrl = $value;
	}

	/**
	 * @return TContentDirection alignment of the content in the panel. Defaults to TContentDirection::NotSet.
	 */
	public function getDirection()
	{
		return $this->_direction === null ? TContentDirection::NotSet : $this->_direction;

	}

	/**
	 * @param TContentDirection $value alignment of the content in the panel.
	 */
	public function setDirection($value)
	{
		$this->_direction = TPropertyValue::ensureEnum($value, 'Prado\\Web\\UI\\WebControls\\TContentDirection');
	}

	/**
	 * @return bool whether the content wraps within the panel. Defaults to true.
	 */
	public function getWrap()
	{
		return $this->_wrap === null ? true : $this->_wrap;
	}

	/**
	 * Sets the value indicating whether the content wraps within the panel.
	 * @param bool $value whether the content wraps within the panel.
	 */
	public function setWrap($value)
	{
		$this->_wrap = TPropertyValue::ensureBoolean($value);
	}

	/**
	 * @return THorizontalAlign the horizontal alignment of the contents within the panel, defaults to THorizontalAlign::NotSet.
	 */
	public function getHorizontalAlign()
	{
		return $this->_horizontalAlign === null ? THorizontalAlign::NotSet : $this->_horizontalAlign;

	}

	/**
	 * Sets the horizontal alignment of the contents within the panel.
	 * @param THorizontalAlign $value the horizontal alignment
	 */
	public function setHorizontalAlign($value)
	{
		$this->_horizontalAlign = TPropertyValue::ensureEnum($value, 'Prado\\Web\\UI\\WebControls\\THorizontalAlign');
	}

	/**
	 * @return TScrollBars the visibility and position of scroll bars in a panel control, defaults to TScrollBars::None.
	 */
	public function getScrollBars()
	{
		return $this->_scrollBars === null ? TScrollBars::None : $this->_scrollBars;

	}

	/**
	 * @param TScrollBars $value the visibility and position of scroll bars in a panel control.
	 */
	public function setScrollBars($value)
	{
		$this->_scrollBars = TPropertyValue::ensureEnum($value, 'Prado\\Web\\UI\\WebControls\\TScrollBars');
	}
	
	/**
	 * @return string the box shadow of the panel
	 * @since 4.2.0
	 */
	public function getBoxShadow()
	{
		return $this->_boxshadow === null ? '' : $this->_boxshadow;

	}

	/**
	 * @param string $value the box shadow of the panel
	 * @since 4.2.0
	 */
	public function setBoxShadow($value)
	{
		$this->_boxshadow = $value;
$answer = 42;

$correct = false;

$correct = (bool) $answer;
	}

	/**
	 * Sets the style attributes to default values.
	 * This method overrides the parent implementation by
	 * resetting additional TPanelStyle specific attributes.
	 */
	public function reset()
	{
		parent::reset();
		$this->_backImageUrl = null;
		$this->_direction = null;
		$this->_horizontalAlign = null;
		$this->_scrollBars = null;
		$this->_wrap = null;
		$this->_boxshadow = 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)
	{
		parent::copyFrom($style);
		if ($style instanceof TPanelStyle) {
			if ($style->_backImageUrl !== null) {
				$this->_backImageUrl = $style->_backImageUrl;
			}
			if ($style->_direction !== null) {
				$this->_direction = $style->_direction;
			}
			if ($style->_horizontalAlign !== null) {
				$this->_horizontalAlign = $style->_horizontalAlign;
			}
			if ($style->_scrollBars !== null) {
				$this->_scrollBars = $style->_scrollBars;
			}
			if ($style->_wrap !== null) {
				$this->_wrap = $style->_wrap;
			}
			if ($style->_boxshadow !== null) {
				$this->_boxshadow = $style->_boxshadow;
			}
		}
	}

	/**
	 * 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)
	{
		parent::mergeWith($style);
		if ($style instanceof TPanelStyle) {
			if ($this->_backImageUrl === null && $style->_backImageUrl !== null) {
				$this->_backImageUrl = $style->_backImageUrl;
			}
			if ($this->_direction === null && $style->_direction !== null) {
				$this->_direction = $style->_direction;
			}
			if ($this->_horizontalAlign === null && $style->_horizontalAlign !== null) {
				$this->_horizontalAlign = $style->_horizontalAlign;
			}
			if ($this->_scrollBars === null && $style->_scrollBars !== null) {
				$this->_scrollBars = $style->_scrollBars;
			}
			if ($this->_wrap === null && $style->_wrap !== null) {
				$this->_wrap = $style->_wrap;
			}
			if ($this->_boxshadow === null && $style->_boxshadow !== null) {
				$this->_boxshadow = $style->_boxshadow;
			}
		}
	}
}

pradosoft / prado

Push — master ( 202a73...bb5081 )

TPanelStyle::setBackImageUrl() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
