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

TTextBox::addAttributesToRender() F
last analyzed 2025-05-21 15:52 UTC

↳ Parent: TTextBox
Complexity

Conditions	37
Paths	8320
Size

Total Lines	105
Code Lines	87
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	1406
Importance

Changes
Metric	Value
cc	37
eloc	87
c	0
b	0
f	0
nc	8320
nop	1
dl	0
loc	105
ccs	0
cts	102
cp	0
crap	1406
rs	0
How to fix Long Method Complexity

<?php

/**
 * TTextBox class file.
 *
 * @author Qiang Xue <[email protected]>
 * @link https://github.com/pradosoft/prado
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 */

namespace Prado\Web\UI\WebControls;

use Prado\Prado;
use Prado\TPropertyValue;
use Prado\Web\THttpUtility;
use Prado\Exceptions\TInvalidDataValueException;
use Prado\Exceptions\TConfigurationException;

/**
 * TTextBox class
 *
 * TTextBox displays a text box on the Web page for user input.
 * The text displayed in the TTextBox control is determined by the
 * {@see setText Text} property. You can create a <b>SingleLine</b>,
 * a <b>MultiLine</b>, or a <b>Password</b> text box by setting
 * the {@see setTextMode TextMode} property. If the TTextBox control
 * is a multiline text box, the number of rows it displays is determined
 * by the {@see setRows Rows} property, and the {@see setWrap Wrap} property
 * can be used to determine whether to wrap the text in the component.
 * Additional {@see setTextMode TextMode} types enable the use of new input types
 * added with html5, eg. <b>Color</b>, <b>Date</b>, <b>Email</b>.
 *
 * To specify the display width of the text box, in characters, set
 * the {@see setColumns Columns} property. To prevent the text displayed
 * in the component from being modified, set the {@see setReadOnly ReadOnly}
 * property to true. If you want to limit the user input to a specified number
 * of characters, set the {@see setMaxLength MaxLength} property.
 * To use AutoComplete feature, set the {@see setAutoCompleteType AutoCompleteType} property.
 *
 * If {@see setAutoPostBack AutoPostBack} is set true, updating the text box
 * and then changing the focus out of it will cause postback action.
 * And if {@see setCausesValidation CausesValidation} is true, validation will
 * also be processed, which can be further restricted within
 * a {@see setValidationGroup ValidationGroup}.
 *
 * WARNING: Be careful if you want to display the text collected via TTextBox.
 * Malicious cross-site script may be injected in. You may use {@see getSafeText SafeText}
 * to prevent this problem.
 *
 * NOTE: If you set {@see setWrap Wrap} to false or use {@see setAutoCompleteType AutoCompleteType},
 * the generated HTML output for the textbox will not be XHTML-compatible.
 * Currently, no alternatives are available.
 *
 * @author Qiang Xue <[email protected]>
 * @since 3.0
 */
class TTextBox extends \Prado\Web\UI\WebControls\TWebControl implements \Prado\Web\UI\IPostBackDataHandler, \Prado\Web\UI\IValidatable, \Prado\IDataRenderer
{
	/**
	 * Default number of rows (for MultiLine text box)
	 */
	public const DEFAULT_ROWS = 4;
	/**
	 * Default number of columns (for MultiLine text box)
	 */
	public const DEFAULT_COLUMNS = 20;
	/**
	 * @var mixed safe text parser
	 */
	private static $_safeTextParser;
	/**
	 * @var string safe textbox content with javascript stripped off
	 */
	private $_safeText;
	private $_dataChanged = false;
	private $_isValid = true;

	/**
	 * @return string tag name of the textbox
	 */
	protected function getTagName()
	{
		return ($this->getTextMode() === TTextBoxMode::MultiLine) ? 'textarea' : 'input';

	}

	/**
	 * @return bool whether to render javascript.
	 */
	public function getEnableClientScript()
	{
		return $this->getViewState('EnableClientScript', true);
	}

	/**
	 * @param bool $value whether to render javascript.
	 */
	public function setEnableClientScript($value)
	{
		$this->setViewState('EnableClientScript', TPropertyValue::ensureBoolean($value), true);
	}

	/**
	 * Adds attribute name-value pairs to renderer.
	 * This method overrides the parent implementation with additional textbox specific attributes.
	 * @param \Prado\Web\UI\THtmlWriter $writer the writer used for the rendering purpose
	 */
	protected function addAttributesToRender($writer)
	{
		$page = $this->getPage();
		$page->ensureRenderInForm($this);
		if (($uid = $this->getUniqueID()) !== '') {
			$writer->addAttribute('name', $uid);
		}
		if (($textMode = $this->getTextMode()) === TTextBoxMode::MultiLine) {

			if (($rows = $this->getRows()) <= 0) {
				$rows = self::DEFAULT_ROWS;
			}
			if (($cols = $this->getColumns()) <= 0) {
				$cols = self::DEFAULT_COLUMNS;
			}
			$writer->addAttribute('rows', "$rows");
			$writer->addAttribute('cols', "$cols");
			if (!$this->getWrap()) {
				$writer->addAttribute('wrap', 'off');
			}
		} else {
			switch ($textMode) {
				case TTextBoxMode::Password:
					$writer->addAttribute('type', 'password');
					break;
				case TTextBoxMode::Color:
					$writer->addAttribute('type', 'color');
					break;
				case TTextBoxMode::Date:
					$writer->addAttribute('type', 'date');
					break;
				case TTextBoxMode::Datetime:
					$writer->addAttribute('type', 'datetime');
					break;
				case TTextBoxMode::DatetimeLocal:
					$writer->addAttribute('type', 'datetime-local');
					break;
				case TTextBoxMode::Email:
					$writer->addAttribute('type', 'email');
					break;
				case TTextBoxMode::Month:
					$writer->addAttribute('type', 'month');
					break;
				case TTextBoxMode::Number:
					$writer->addAttribute('type', 'number');
					break;
				case TTextBoxMode::Range:
					$writer->addAttribute('type', 'range');
					break;
				case TTextBoxMode::Search:
					$writer->addAttribute('type', 'search');
					break;
				case TTextBoxMode::Tel:
					$writer->addAttribute('type', 'tel');
					break;
				case TTextBoxMode::Time:
					$writer->addAttribute('type', 'time');
					break;
				case TTextBoxMode::Url:
					$writer->addAttribute('type', 'url');
					break;
				case TTextBoxMode::Week:
					$writer->addAttribute('type', 'week');
					break;
				case TTextBoxMode::SingleLine:
				default:
					$writer->addAttribute('type', 'text');
					break;
			}

			if (($text = $this->getText()) !== '' && ($textMode !== TTextBoxMode::Password || $this->getPersistPassword())) {
				$writer->addAttribute('value', $text);
			}

			switch ($this->getAutoCompleteType()) {
				case TTextBoxAutoCompleteType::Enabled:
					$writer->addAttribute('autocomplete', 'on');
					break;
				case TTextBoxAutoCompleteType::Disabled:
					$writer->addAttribute('autocomplete', 'off');
					break;
				case TTextBoxAutoCompleteType::None:
					break;
			}

			if (($cols = $this->getColumns()) > 0) {
				$writer->addAttribute('size', "$cols");
			}
			if (($maxLength = $this->getMaxLength()) > 0) {
				$writer->addAttribute('maxlength', "$maxLength");
			}
		}
		if ($this->getReadOnly()) {
			$writer->addAttribute('readonly', 'readonly');
		}
		$isEnabled = $this->getEnabled(true);
		if (!$isEnabled && $this->getEnabled()) {  // in this case parent will not render 'disabled'
			$writer->addAttribute('disabled', 'disabled');
		}
		if ($isEnabled
			&& $this->getEnableClientScript()
			&& ($this->getAutoPostBack() || $textMode === TTextBoxMode::SingleLine)
			&& $page->getClientSupportsJavaScript()) {
			$this->renderClientControlScript($writer);
		}
		parent::addAttributesToRender($writer);
	}

	/**
	 * Renders the javascript for textbox.
	 * @param mixed $writer
	 */
	protected function renderClientControlScript($writer)
	{
		$writer->addAttribute('id', $this->getClientID());
		$cs = $this->getPage()->getClientScript();
		$cs->registerPostBackControl($this->getClientClassName(), $this->getPostBackOptions());
	}

	/**
	 * Gets the name of the javascript class responsible for performing postback for this control.
	 * This method overrides the parent implementation.
	 * @return string the javascript class name
	 */
	protected function getClientClassName()
	{
		return 'Prado.WebUI.TTextBox';
	}

	/**
	 * Gets the post back options for this textbox.
	 * @return array
	 */
	protected function getPostBackOptions()
	{
		$options['ID'] = $this->getClientID();

		$options['EventTarget'] = $this->getUniqueID();
		$options['AutoPostBack'] = $this->getAutoPostBack();
		$options['CausesValidation'] = $this->getCausesValidation();
		$options['ValidationGroup'] = $this->getValidationGroup();
		$options['TextMode'] = $this->getTextMode();
		return $options;
	}

	/**
	 * Loads user input data.
	 * This method is primarly used by framework developers.
	 * @param string $key the key that can be used to retrieve data from the input data collection
	 * @param array $values the input data collection
	 * @return bool whether the data of the component has been changed
	 */
	public function loadPostData($key, $values)
	{
		$value = $values[$key];
		if ($this->getAutoTrim()) {
			$value = trim($value);
		}
		if (!$this->getReadOnly() && $this->getText() !== $value) {
			$this->setText($value);
			return $this->_dataChanged = true;
		} else {
			return false;
		}
	}

	/**
	 * Returns a value indicating whether postback has caused the control data change.
	 * This method is required by the \Prado\Web\UI\IPostBackDataHandler interface.
	 * @return bool whether postback has caused the control data change. False if the page is not in postback mode.
	 */
	public function getDataChanged()
	{
		return $this->_dataChanged;
	}

	/**
	 * Returns the value to be validated.
	 * This methid is required by \Prado\Web\UI\IValidatable interface.
	 * @return mixed the value of the property to be validated.
	 */
	public function getValidationPropertyValue()
	{
		return $this->getText();
	}

	/**
	 * Returns true if this control validated successfully.
	 * Defaults to true.
	 * @return bool wether this control validated successfully.
	 */
	public function getIsValid()
	{
		return $this->_isValid;
	}
	/**
	 * @param bool $value wether this control is valid.
	 */
	public function setIsValid($value)
	{
		$this->_isValid = TPropertyValue::ensureBoolean($value);
	}

	/**
	 * Raises <b>OnTextChanged</b> event.
	 * This method is invoked when the value of the {@see getText Text}
	 * property changes on postback.
	 * If you override this method, be sure to call the parent implementation to ensure
	 * the invocation of the attached event handlers.
	 * @param \Prado\TEventParameter $param event parameter to be passed to the event handlers
	 */
	public function onTextChanged($param)
	{
		$this->raiseEvent('OnTextChanged', $this, $param);
	}

	/**
	 * Raises postdata changed event.
	 * This method is required by {@see \Prado\Web\UI\IPostBackDataHandler} interface.
	 * It is invoked by the framework when {@see getText Text} property
	 * is changed on postback.
	 * This method is primarly used by framework developers.
	 */
	public function raisePostDataChangedEvent()
	{
		if ($this->getAutoPostBack() && $this->getCausesValidation()) {
			$this->getPage()->validate($this->getValidationGroup());
		}
		$this->onTextChanged(null);
	}

	/**
	 * Renders the body content of the textbox when it is in MultiLine text mode.
	 * @param \Prado\Web\UI\THtmlWriter $writer the writer for rendering
	 */
	public function renderContents($writer)
	{
		if ($this->getTextMode() === TTextBoxMode::MultiLine) {

			$writer->write(THttpUtility::htmlEncode($this->getText()));
		}
	}

	/**
	 * Renders an additional line-break after the opening tag when it
	 * is in MultiLine text mode.
	 * @param \Prado\Web\UI\THtmlWriter $writer the writer used for the rendering purpose^M
	 */
	public function renderBeginTag($writer)
	{
		parent::renderBeginTag($writer);
		if ($this->getTextMode() === TTextBoxMode::MultiLine) {

			$writer->write("\n");
		}
	}

	/**
	 * @return TTextBoxAutoCompleteType the AutoComplete type of the textbox
	 */
	public function getAutoCompleteType()
	{
		return $this->getViewState('AutoCompleteType', TTextBoxAutoCompleteType::None);

	}

	/**
	 * @param TTextBoxAutoCompleteType $value the AutoComplete type of the textbox, default value is TTextBoxAutoCompleteType::None.
	 * @throws TInvalidDataValueException if the input parameter is not a valid AutoComplete type
	 */
	public function setAutoCompleteType($value)
	{
		$this->setViewState('AutoCompleteType', TPropertyValue::ensureEnum($value, TTextBoxAutoCompleteType::class), TTextBoxAutoCompleteType::None);
	}

	/**
	 * @return bool a value indicating whether an automatic postback to the server
	 * will occur whenever the user modifies the text in the TTextBox control and
	 * then tabs out of the component. Defaults to false.
	 */
	public function getAutoPostBack()
	{
		return $this->getViewState('AutoPostBack', false);
	}

	/**
	 * Sets the value indicating if postback automatically.
	 * An automatic postback to the server will occur whenever the user
	 * modifies the text in the TTextBox control and then tabs out of the component.
	 * @param bool $value the value indicating if postback automatically
	 */
	public function setAutoPostBack($value)
	{
		$this->setViewState('AutoPostBack', TPropertyValue::ensureBoolean($value), false);
	}

	/**
	 * @return bool a value indicating whether the input text should be trimmed spaces. Defaults to false.
	 */
	public function getAutoTrim()
	{
		return $this->getViewState('AutoTrim', false);
	}

	/**
	 * Sets the value indicating if the input text should be trimmed spaces
	 * @param bool $value the value indicating if the input text should be trimmed spaces
	 */
	public function setAutoTrim($value)
	{
		$this->setViewState('AutoTrim', TPropertyValue::ensureBoolean($value), false);
	}

	/**
	 * @return bool whether postback event trigger by this text box will cause input validation, default is true.
	 */
	public function getCausesValidation()
	{
		return $this->getViewState('CausesValidation', true);
	}

	/**
	 * @param bool $value whether postback event trigger by this text box will cause input validation.
	 */
	public function setCausesValidation($value)
	{
		$this->setViewState('CausesValidation', TPropertyValue::ensureBoolean($value), true);
	}

	/**
	 * @return int the display width of the text box in characters, default is 0 meaning not set.
	 */
	public function getColumns()
	{
		return $this->getViewState('Columns', 0);
	}

	/**
	 * Sets the display width of the text box in characters.
	 * @param int $value the display width, set it 0 to clear the setting
	 */
	public function setColumns($value)
	{
		$this->setViewState('Columns', TPropertyValue::ensureInteger($value), 0);
	}

	/**
	 * @return int the maximum number of characters allowed in the text box, default is 0 meaning not set.
	 */
	public function getMaxLength()
	{
		return $this->getViewState('MaxLength', 0);
	}

	/**
	 * Sets the maximum number of characters allowed in the text box.
	 * @param int $value the maximum length,  set it 0 to clear the setting
	 */
	public function setMaxLength($value)
	{
		$this->setViewState('MaxLength', TPropertyValue::ensureInteger($value), 0);
	}

	/**
	 * @return bool whether the textbox is read only, default is false.
	 */
	public function getReadOnly()
	{
		return $this->getViewState('ReadOnly', false);
	}

	/**
	 * @param bool $value whether the textbox is read only
	 */
	public function setReadOnly($value)
	{
		$this->setViewState('ReadOnly', TPropertyValue::ensureBoolean($value), false);
	}

	/**
	 * @return int the number of rows displayed in a multiline text box, default is 4
	 */
	public function getRows()
	{
		return $this->getViewState('Rows', self::DEFAULT_ROWS);
	}

	/**
	 * Sets the number of rows displayed in a multiline text box.
	 * @param int $value the number of rows
	 */
	public function setRows($value)
	{
		$this->setViewState('Rows', TPropertyValue::ensureInteger($value), self::DEFAULT_ROWS);
	}

	/**
	 * @return bool whether password should be displayed in the textbox during postback. Defaults to false. This property only applies when TextMode='Password'.
	 */
	public function getPersistPassword()
	{
		return $this->getViewState('PersistPassword', false);
	}

	/**
	 * @param bool $value whether password should be displayed in the textbox during postback. This property only applies when TextMode='Password'.
	 */
	public function setPersistPassword($value)
	{
		$this->setViewState('PersistPassword', TPropertyValue::ensureBoolean($value), false);
	}

	/**
	 * @return string the text content of the TTextBox control.
	 */
	public function getText()
	{
		return $this->getViewState('Text', '');
	}

	/**
	 * Sets the text content of the TTextBox control.
	 * @param string $value the text content
	 */
	public function setText($value)
	{
		$this->setViewState('Text', TPropertyValue::ensureString($value), '');
		$this->_safeText = null;
	}

	/**
	 * Returns the text content of the TTextBox control.
	 * This method is required by {@see \Prado\IDataRenderer}.
	 * It is the same as {@see getText()}.
	 * @return string the text content of the TTextBox control.
	 * @see getText
	 * @since 3.1.0
	 */
	public function getData()
	{
		return $this->getText();
	}

	/**
	 * Sets the text content of the TTextBox control.
	 * This method is required by {@see \Prado\IDataRenderer}.
	 * It is the same as {@see setText()}.
	 * @param string $value the text content of the TTextBox control.
	 * @see setText
	 * @since 3.1.0
	 */
	public function setData($value)
	{
		$this->setText($value);
	}

	/**
	 * @return string safe text content with javascript stripped off
	 */
	public function getSafeText()
	{
		if ($this->_safeText === null) {
			$this->_safeText = $this->getSafeTextParser()->purify($this->getText());
		}
		return $this->_safeText;
	}

	/**
	 * @return \HTMLPurifier safe text parser
	 */
	protected function getSafeTextParser()
	{
		if (!self::$_safeTextParser) {
			self::$_safeTextParser = new \HTMLPurifier($this->getConfig());
		}
		return self::$_safeTextParser;
	}

	/**
	 * @return TTextBoxMode the behavior mode of the TTextBox component. Defaults to TTextBoxMode::SingleLine.
	 */
	public function getTextMode()
	{
		return $this->getViewState('TextMode', TTextBoxMode::SingleLine);

	}

	/**
	 * Sets the behavior mode of the TTextBox component.
	 * @param TTextBoxMode $value the text mode
	 * @throws TInvalidDataValueException if the input value is not a valid text mode.
	 */
	public function setTextMode($value)
	{
		$this->setViewState('TextMode', TPropertyValue::ensureEnum($value, TTextBoxMode::class), TTextBoxMode::SingleLine);
	}

	/**
	 * @return string the group of validators which the text box causes validation upon postback
	 */
	public function getValidationGroup()
	{
		return $this->getViewState('ValidationGroup', '');
	}

	/**
	 * @param string $value the group of validators which the text box causes validation upon postback
	 */
	public function setValidationGroup($value)
	{
		$this->setViewState('ValidationGroup', $value, '');
	}

	/**
	 * @return bool whether the text content wraps within a multiline text box. Defaults to true.
	 */
	public function getWrap()
	{
		return $this->getViewState('Wrap', true);
	}

	/**
	 * Sets the value indicating whether the text content wraps within a multiline text box.
	 * @param bool $value whether the text content wraps within a multiline text box.
	 */
	public function setWrap($value)
	{
		$this->setViewState('Wrap', TPropertyValue::ensureBoolean($value), true);
	}

	/**
	 * Sets a custom configuration for HTMLPurifier.
	 * @param \HTMLPurifier_Config $value custom configuration
	 */
	public function setConfig(\HTMLPurifier_Config $value)
	{
		$this->setViewState('Config', $value, null);
	}

	/**
	 * @return \HTMLPurifier_Config Configuration for HTMLPurifier.
	 */
	public function getConfig()
	{
		$config = $this->getViewState('Config', null);
		if ($config === null) {
			$path = Prado::getApplication()->getRuntimePath() . DIRECTORY_SEPARATOR . 'htmlpurifier';
			if (!is_dir($path)) {
				if (@mkdir($path) === false) {
					throw new TConfigurationException(
						'htmlpurifier_source_path_failed',
						$path
					);
				}
				chmod($path, Prado::getDefaultDirPermissions());
			}
			$config = \HTMLPurifier_Config::createDefault();
			$config->set(
				'Cache.SerializerPath',
				$path
			);
		}
		return $config;
	}
}

pradosoft / prado

TTextBox::addAttributesToRender() F last analyzed 2025-05-21 15:52 UTC

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

TTextBox::addAttributesToRender() F
last analyzed 2025-05-21 15:52 UTC
