Prado\Web\UI\ActiveControls\TActiveLabel

Complexity

Total Complexity

9

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	addAttributesToRender()	0	4	1
A	__construct()	0	4	1
A	setText()	0	9	3
A	setForControl()	0	10	3
A	getActiveControl()	0	3	1

<?php

/**
 * TActiveLabel 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\Web\UI\ActiveControls;

/**
 * Load active control adapter.
 */
use Prado\Prado;
use Prado\Web\UI\WebControls\TLabel;

/**
 * TActiveLabel class
 *
 * The active control counterpart of TLabel component. When
 * {@see \Prado\Web\UI\ActiveControls\TBaseActiveControl::setEnableUpdate ActiveControl.EnableUpdate}
 * property is true the during a callback request, setting {@see setText Text}
 * property will also set the text of the label on the client upon callback
 * completion. Similarly, setting {@see setForControl ForControl} will also set
 * the client-side "for" attribute on the label.
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @since 3.1
 * @method TActiveControlAdapter getAdapter()
 */
class TActiveLabel extends TLabel implements IActiveControl
{
	/**
	 * Creates a new callback control, sets the adapter to
	 * TActiveControlAdapter. If you override this class, be sure to set the
	 * adapter appropriately by, for example, by calling this constructor.
	 */
	public function __construct()
	{
		parent::__construct();
		$this->setAdapter(new TActiveControlAdapter($this));
	}

	/**
	 * @return TBaseActiveControl basic active control options.
	 */
	public function getActiveControl()
	{
		return $this->getAdapter()->getBaseActiveControl();

The expression return $this->getAdapter()->getBaseActiveControl() also could return the type Prado\Web\UI\ActiveControls\TBaseActiveControl which includes types incompatible with the return type mandated by Prado\Web\UI\ActiveControls\IActiveControl::getActiveControl() of Prado\Web\UI\ActiveControls\TBaseActiveCallbackControl. Consider adding a type-check to rule them out.

	}

	/**
	 * On callback response, the inner HTML of the label is updated.
	 * @param string $value the text value of the label
	 */
	public function setText($value)
	{
		if (parent::getText() === $value) {
			return;
		}

		parent::setText($value);
		if ($this->getActiveControl()->canUpdateClientSide()) {
			$this->getPage()->getCallbackClient()->update($this, $value);

$value of type string is incompatible with the type Prado\Web\UI\TControl expected by parameter $content of Prado\Web\UI\ActiveControls\TCallbackClientScript::update().

		}
	}

	/**
	 * Sets the ID of the control that the label is associated with.
	 * The control must be locatable via {@see \Prado\Web\UI\TControl::findControl} using the ID.
	 * On callback response, the For attribute of the label is updated.
	 * @param string $value the associated control ID
	 */
	public function setForControl($value)
	{
		if (parent::getForControl() === $value) {
			return;
		}

		parent::setForControl($value);
		if ($this->getActiveControl()->canUpdateClientSide()) {
			$id = $this->findControl($value)->getClientID();
			$this->getPage()->getCallbackClient()->setAttribute($this, 'for', $id);
		}
	}

	/**
	 * Adds attribute id to the renderer.
	 * @param \Prado\Web\UI\THtmlWriter $writer the writer used for the rendering purpose
	 */
	protected function addAttributesToRender($writer)
	{
		$writer->addAttribute('id', $this->getClientID());
		parent::addAttributesToRender($writer);
	}
}