Prado\Web\UI\ActiveControls\TActiveHtmlArea

Complexity

Total Complexity

9

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getClientSide()	0	3	1
A	__construct()	0	4	1
A	getActiveControl()	0	3	1
A	raiseCallbackEvent()	0	3	1
A	setText()	0	10	4
A	onCallback()	0	3	1

<?php

/**
 * TActiveHtmlArea class file.
 *
 * @author LANDWEHR Computer und Software GmbH <programmierung@landwehr-software.de>
 * @link https://github.com/pradosoft/prado4
 * @license https://github.com/pradosoft/prado4/blob/master/LICENSE
 */

namespace Prado\Web\UI\ActiveControls;

use Prado\Web\UI\WebControls\THtmlArea;
use Prado\Web\UI\ActiveControls\ICallbackEventHandler;
use Prado\Web\UI\ActiveControls\IActiveControl;
use Prado\Web\UI\ActiveControls\TActiveControlAdapter;

/**
 * TActiveHtmlArea class
 *
 * TActiveHtmlArea is the active counterpart to {@see \Prado\Web\UI\WebControls\THtmlArea} with added support
 * for callback handling and the possibility of setting the content of the WYSIWYG
 * text editor during callback.
 *
 * Please refer to the original documentation of {@see \Prado\Web\UI\WebControls\THtmlArea} for basic usage.
 *
 * @author LANDWEHR Computer und Software GmbH <programmierung@landwehr-software.de>
 * @since 4.0
 * @method TActiveControlAdapter getAdapter()
 */
class TActiveHtmlArea extends THtmlArea implements IActiveControl, ICallbackEventHandler
{
	/**
	 * 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 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();
	}

	/**
	 * Client-side Text property can only be updated after the OnLoad stage. Setting WYSIWYG
	 * text editor content is only available if {@see getEnableVisualEdit} is enabled.
	 * @param string $value text content for the textbox
	 */
	public function setText($value)
	{
		parent::setText($value);
		if ($this->getActiveControl()->canUpdateClientSide() && $this->getHasLoadedPostData()) {
			if ($this->getEnableVisualEdit()) {
				$value = str_ireplace(["\r\n", "\n"], "", $value);
				$command = "tinyMCE.getInstanceById('{$this->getClientID()}').execCommand('mceSetContent',false,'{$value}')";
				$this->getPage()->getCallbackClient()->evaluateScript($command);
			} else {
				$this->getPage()->getCallbackClient()->setValue($this, $value);
			}
		}
	}

	/**
	 * 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);
	}
}