Prado\Web\UI\ActiveControls\TActiveRatingList

Complexity

Total Complexity

15

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getClientClassName()	0	3	1
A	callClientFunction()	0	6	2
A	raiseCallbackEvent()	0	3	1
A	setCaption()	0	9	2
A	addAttributesToRender()	0	6	1
A	setReadOnly()	0	9	2
A	onCallback()	0	3	1
A	__construct()	0	5	1
A	getActiveControl()	0	3	1
A	getClientSide()	0	3	1
A	setRating()	0	9	2

<?php

/**
 * TActiveRatingList class file.
 *
 * @author Wei Zhuo <weizhuo[at]gamil[dot]com>
 * @author Bradley Booms <bradley[dot]booms[at]gmail[dot]com>
 * @link https://github.com/pradosoft/prado
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 */

namespace Prado\Web\UI\ActiveControls;

use Prado\Web\UI\WebControls\TRatingList;

/**
 * TActiveRatingList Class
 *
 * Displays clickable images that represent a TRadioButtonList
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @author Bradley Booms <bradley[dot]booms[at]gmail[dot]com>
 * @since 3.1
 * @method TActiveControlAdapter getAdapter()
 */
class TActiveRatingList extends TRatingList implements IActiveControl, ICallbackEventHandler
{
	/**
	 * Creates a new callback control, sets the adapter to
	 * TActiveListControlAdapter. If you override this class, be sure to set the
	 * adapter appropriately by, for example, by calling this constructor.
	 */
	public function __construct()
	{
		$this->setAdapter(new TActiveListControlAdapter($this));
		$this->setAutoPostBack(true);
		parent::__construct();
	}

	/**
	 * @return TBaseActiveCallbackControl standard callback 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.

	}

	/**
	 * @return TCallbackClientSide client side request options.
	 */
	public function getClientSide()
	{
		return $this->getActiveControl()->getClientSide();
	}

	/**
	 * Raises the callback event. This method is required by {@see
	 * ICallbackEventHandler} interface.
	 * This method is mainly used by framework and control developers.
	 * @param TCallbackEventParameter $param the event parameter
	 */
	public function raiseCallbackEvent($param)
	{
		$this->onCallback($param);
	}

	/**
	 * This method is invoked when a callback is requested. The method raises
	 * 'OnCallback' event to fire up the event handlers. If you override this
	 * method, be sure to call the parent implementation so that the event
	 * handler can be invoked.
	 * @param TCallbackEventParameter $param event parameter to be passed to the event handlers
	 */
	public function onCallback($param)
	{
		$this->raiseEvent('OnCallback', $this, $param);
	}

	/**
	 * @param bool $value whether the items in the column can be edited
	 */
	public function setReadOnly($value)
	{
		if (parent::getReadOnly() === $value) {
			return;
		}

		parent::setReadOnly($value);
		$value = $this->getReadOnly();
		$this->callClientFunction('setReadOnly', $value);
	}

	/**
	 * @param float $value rating value, also sets the selected Index
	 */
	public function setRating($value)
	{
		if (parent::getRating() === $value) {
			return;
		}

		parent::setRating($value);
		$value = $this->getRating();
		$this->callClientFunction('setRating', $value);
	}

	/**
	 * Calls the client-side static method for this control class.
	 * @param string $func static method name
	 * @param mixed $value method parmaeter
	 */
	protected function callClientFunction($func, $value)
	{
		if ($this->getActiveControl()->canUpdateClientSide()) {
			$client = $this->getPage()->getCallbackClient();
			$code = 'Prado.Registry[\'' . $this->getClientID() . '\'].' . $func . '(' . $value . ')';
			$client->evaluateScript($code);
		}
	}

	/**
	 * @param string $value caption text
	 */
	public function setCaption($value)
	{
		if (parent::getCaption() === $value) {
			return;
		}

		parent::setCaption($value);
		// if it's an active control, this should not be needed.
		$this->callClientFunction('setCaption', $value);
	}

	/**
	 * Ensure that the ID attribute is rendered and registers the javascript code
	 * for initializing the active control.
	 * @param mixed $writer
	 */
	protected function addAttributesToRender($writer)
	{
		parent::addAttributesToRender($writer);
		$this->getActiveControl()->registerCallbackClientScript(
			$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.TActiveRatingList';
	}
}