Prado\Web\UI\WebControls\THtmlArea5

Complexity

Total Complexity

63

Size/Duplication

Total Lines	361
Duplicated Lines	0 %

Importance

Changes

0

27 Methods

Rating	Name	Duplication	Size	Complexity
A	getClientClassName()	0	3	1
A	copyLangs()	0	9	3
B	loadAvailableLanguages()	0	13	8
A	loadAvailableThemes()	0	12	6
A	getCustomPluginPath()	0	3	1
A	loadJavascriptLibrary()	0	6	1
A	getLanguageSuffix()	0	19	6
A	setEnableVisualEdit()	0	3	1
A	setCulture()	0	3	1
A	getCulture()	0	3	1
A	getAvailableThemes()	0	4	1
A	getEnableVisualEdit()	0	3	1
A	setOptions()	0	3	1
A	registerEditorClientScript()	0	12	1
A	getAutoPostBack()	0	3	2
A	setTextMode()	0	3	1
A	__construct()	0	5	1
A	parseEditorOptions()	0	18	5
A	getAvailableLanguages()	0	4	1
A	getTextMode()	0	3	1
A	getAvailablePlugins()	0	4	1
A	setCustomPluginPath()	0	3	1
A	loadAvailablePlugins()	0	12	6
A	getEditorOptions()	0	20	2
A	getOptions()	0	3	1
A	addAttributesToRender()	0	8	3
A	copyCustomPlugins()	0	10	5

<?php
/**
 * THtmlArea5 class file.
 *
 * @author Fabio Bas <ctrlaltca[at]gmail[dot]com>
 * @link https://github.com/pradosoft/prado
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 */

namespace Prado\Web\UI\WebControls;

use Prado\Exceptions\TInvalidOperationException;
use Prado\Prado;
use Prado\TApplicationMode;
use Prado\TPropertyValue;
use Prado\Web\Javascripts\TJavaScript;

/**
 * THtmlArea5 class
 *
 * THtmlArea5 wraps the visual editing functionalities provided by the
 * version 5 of TinyMCE project {@link http://tinymce.com/}. It has been
 * developed as a plug'n'play substitute for {@link THtmlArea}, that is
 * based on a previous iteration (version 3) of the same project.
 * Please note that both components can't be used together in the same page.
 *
 * THtmlArea displays a WYSIWYG text area on the Web page for user input
 * in the HTML format. The text displayed in the THtmlArea component is
 * specified or determined by using the <b>Text</b> property.
 *
 * To enable the visual editting on the client side, set the property
 * <b>EnableVisualEdit</b> to true (which is default value).
 * To set the size of the editor when the visual editting is enabled,
 * set the <b>Width</b> and <b>Height</b> properties instead of
 * <b>Columns</b> and <b>Rows</b> because the latter has no meaning
 * under the situation.
 *
 * The default editor gives only the basic tool bar. To change or add
 * additional tool bars, use the {@link setOptions Options} property to add additional
 * editor options with each options on a new line.
 * See http://www.tinymce.com/wiki.php/Configuration
 * for a list of options. The options can be change/added as shown in the
 * following example.
 * <code>
 * <com:THtmlArea5>
 *       <prop:Options>
 *         language : "de"
 *         plugins: "advlist anchor autolink autoresize autosave charmap code directionality emoticons fullscreen hr image importcss insertdatetime link lists media nonbreaking noneditable pagebreak paste preview print save searchreplace tabfocus table template visualblocks visualchars wordcount"
 *         toolbar: "undo redo | styleselect | bold italic | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image     | print preview media",
 *         statusbar: false
 *      </prop:Options>
 * </com:THtmlArea5>
 * </code>
 *
 * @author Wei Zhuo <weizhuo[at]gmail[dot]com>
 * @since 4.2
 */
class THtmlArea5 extends TTextBox
{
	/**
	 * @var array list of available language files
	 */
	private static $_langs;

	/**
	 * @var array list of available plugins
	 */
	private static $_plugins;

	/**
	 * @var array list of available themes
	 */
	private static $_themes;

	/**
	 * Constructor.
	 * Sets default width and height.
	 */
	public function __construct()
	{
		$this->setWidth('600px');
		$this->setHeight('250px');
		parent::__construct();
	}

	protected function loadAvailableLanguages()
	{
		if(self::$_langs === null) {

The condition self::_langs === null is always false.

			self::$_langs = [];
			$path = Prado::getPathOfNameSpace('Vendor\\pradosoft\\tinymce-langs');
			$files = scandir($path);
			if($files !== false) {
				foreach ($files as $f) {
					if ($f === '.' || $f === '..' || strlen($f) < 4 || substr($f, -3) != '.js') {
						continue;
					}
					$filename = substr($f, 0, -3);
					self::$_langs[] = $filename;
				}
			}
		}
	}

	protected function loadAvailablePlugins()
	{
		if(self::$_plugins === null) {

The condition self::_plugins === null is always false.

			self::$_plugins = [];
			$path = Prado::getPathOfNameSpace('Vendor\\bower-asset\\tinymce\\plugins');
			$files = scandir($path);
			if($files !== false) {
				foreach ($files as $f) {
					if ($f === '.' || $f === '..') {
						continue;
					}
					self::$_plugins[] = $f;
				}
			}
		}
	}

	protected function loadAvailableThemes()
	{
		if(self::$_themes === null) {

The condition self::_themes === null is always false.

			self::$_themes = [];
			$path = Prado::getPathOfNameSpace('Vendor\\bower-asset\\tinymce\\themes');
			$files = scandir($path);
			if($files !== false) {
				foreach ($files as $f) {
					if ($f === '.' || $f === '..') {
						continue;
					}
					self::$_themes[] = $f;
				}
			}
		}
	}

	/**
	 * Overrides the parent implementation.
	 * TextMode for THtmlArea control is always 'MultiLine'
	 * @return string the behavior mode of the THtmlArea component.
	 */
	public function getTextMode()
	{
		return 'MultiLine';
	}

	/**
	 * Overrides the parent implementation.
	 * TextMode for THtmlArea is always 'MultiLine' and cannot be changed to others.
	 * @param string $value the text mode
	 */
	public function setTextMode($value)
	{
		throw new TInvalidOperationException("htmlarea_textmode_readonly");
	}

	/**
	 * @return bool whether change of the content should cause postback. Return false if EnableVisualEdit is true.
	 */
	public function getAutoPostBack()
	{
		return $this->getEnableVisualEdit() ? false : parent::getAutoPostBack();
	}

	/**
	 * @return bool whether to show WYSIWYG text editor. Defaults to true.
	 */
	public function getEnableVisualEdit()
	{
		return $this->getViewState('EnableVisualEdit', true);
	}

	/**
	 * Sets whether to show WYSIWYG text editor.
	 * @param bool $value whether to show WYSIWYG text editor
	 */
	public function setEnableVisualEdit($value)
	{
		$this->setViewState('EnableVisualEdit', TPropertyValue::ensureBoolean($value), true);
	}

	/**
	 * Gets the current culture.
	 * @return string current culture, e.g. de or it_IT.
	 */
	public function getCulture()
	{
		return $this->getViewState('Culture', '');
	}

	/**
	 * Sets the culture/language for the html area
	 * @param string $value a culture string, e.g. de or it_IT.
	 */
	public function setCulture($value)
	{
		$this->setViewState('Culture', $value, '');
	}

	/**
	 * Gets the list of options for the WYSIWYG (TinyMCE) editor
	 * @see http://www.tinymce.com/wiki.php/Configuration
	 * @return string options
	 */
	public function getOptions()
	{
		return $this->getViewState('Options', '');
	}

	/**
	 * Sets the list of options for the WYSIWYG (TinyMCE) editor
	 * @see http://www.tinymce.com/wiki.php/Configuration
	 * @param string $value options
	 */
	public function setOptions($value)
	{
		$this->setViewState('Options', $value, '');
	}

	/**
	 * @param string $value path to custom plugins to be copied.
	 */
	public function setCustomPluginPath($value)
	{
		$this->setViewState('CustomPluginPath', $value);
	}

	/**
	 * @return string path to custom plugins to be copied.
	 */
	public function getCustomPluginPath()
	{
		return $this->getViewState('CustomPluginPath');
	}

	/**
	 * Adds attribute name-value pairs to renderer.
	 * This method overrides the parent implementation by registering
	 * additional javacript code.
	 * @param \Prado\Web\UI\THtmlWriter $writer the writer used for the rendering purpose
	 */
	protected function addAttributesToRender($writer)
	{
		if ($this->getEnableVisualEdit() && $this->getEnabled(true)) {
			$writer->addAttribute('id', $this->getClientID());
			$this->registerEditorClientScript($writer);
		}

		parent::addAttributesToRender($writer);
	}

	/**
	 * Returns a list of available languages
	 * @return array list of available languages
	 */
	public function getAvailableLanguages()
	{
		$this->loadAvailableLanguages();
		return self::$_langs;
	}

	/**
	 * Returns a list of available plugins
	 * @return array list of available plugins
	 */
	public function getAvailablePlugins()
	{
		$this->loadAvailablePlugins();
		return self::$_plugins;
	}

	/**
	 * Returns a list of available themes
	 * @return array list of available themes
	 */
	public function getAvailableThemes()
	{
		$this->loadAvailableThemes();
		return self::$_themes;
	}

	protected function loadJavascriptLibrary()
	{
		$scripts = $this->getPage()->getClientScript();
		$scripts->registerPradoScript('htmlarea5');
		$this->copyLangs();
		$this->copyCustomPlugins();
	}

	/**
	 * Registers the editor javascript file and code to initialize the editor.
	 * @param mixed $writer
	 */
	protected function registerEditorClientScript($writer)

The parameter $writer is not used and could be removed.

	{
		$this->loadJavascriptLibrary();
		$scripts = $this->getPage()->getClientScript();
		$options = [
			'ID' => $this->getClientID(),
			'EditorOptions' => $this->getEditorOptions()
		];

		$options = TJavaScript::encode($options, true, true);
		$script = "new {$this->getClientClassName()}($options)";
		$scripts->registerEndScript('prado:THtmlArea5' . $this->getClientID(), $script);
	}

	protected function copyCustomPlugins()
	{
		if ($plugins = $this->getCustomPluginPath()) {
			$basepath = $this->getPage()->getClientScript()->getPradoScriptAssetPath('tinymce');
			$assets = $this->getApplication()->getAssetManager();
			$path = is_dir($plugins) ? $plugins : Prado::getPathOfNameSpace($plugins);
			$name = basename($path);

It seems like $path can also be of type null; however, parameter $path of basename() does only seem to accept string, maybe add an additional type check?

			$dest = $basepath . '/plugins/' . $name;
			if (!is_dir($dest) || $this->getApplication()->getMode() !== TApplicationMode::Performance) {
				$assets->copyDirectory($path, $dest);
			}
		}
	}

	protected function copyLangs()
	{
		$basepath = $this->getPage()->getClientScript()->getPradoScriptAssetPath('tinymce');
		$assets = $this->getApplication()->getAssetManager();
		$path = Prado::getPathOfNameSpace('Vendor\\pradosoft\\tinymce-langs');
		$name = basename($path);

It seems like $path can also be of type null; however, parameter $path of basename() does only seem to accept string, maybe add an additional type check?

The assignment to $name is dead and can be removed.

		$dest = $basepath . '/langs';
		if (!is_dir($dest) || $this->getApplication()->getMode() !== TApplicationMode::Performance) {
			$assets->copyDirectory($path, $dest);
		}
	}

	/**
	 * Default editor options gives basic tool bar only.
	 * @return array editor initialization options.
	 */
	protected function getEditorOptions()
	{
		$options['selector'] = '#' . $this->getClientID();

$options was never initialized. Although not strictly required by PHP, it is generally a good practice to add $options = array(); before regardless.

		$options['language'] = $this->getLanguageSuffix($this->getCulture());
		$options['theme'] = 'silver';
		$options['width'] = $this->getWidth();
		$options['height'] = $this->getHeight();
		$options['resize'] = 'both';
		$options['menubar'] = false;
		if ($this->getReadOnly()) {
			$options['readonly'] = true;
			$options['toolbar'] = false;
			$options['menubar'] = false;
			$options['statusbar'] = false;
		}

		$options['extended_valid_elements'] = 'a[name|href|target|title|onclick],img[class|src|border=0|alt|title|hspace|vspace|width|height|align|onmouseover|onmouseout|name],hr[class|width|size|noshade],font[face|size|color|style],span[class|align|style]';

		$options = array_merge($options, $this->parseEditorOptions($this->getOptions()));
		return $options;
	}

	/**
	 * Parse additional options set in the Options property.
	 * @param mixed $string
	 * @return array additional custom options
	 */
	protected function parseEditorOptions($string)
	{
		$options = [];
		$substrings = preg_split('/,\s*\n|\n/', trim($string));
		foreach ($substrings as $bits) {
			$option = explode(":", $bits, 2);

			if (count($option) == 2) {
				$value = trim(trim($option[1]), "'\"");
				if (($s = strtolower($value)) === 'false') {
					$value = false;
				} elseif ($s === 'true') {
					$value = true;
				}
				$options[trim($option[0])] = $value;
			}
		}
		return $options;
	}

	/**
	 * @param mixed $culture
	 * @return string localized editor interface language extension.
	 */
	protected function getLanguageSuffix($culture)
	{
		$app = $this->getApplication()->getGlobalization();
		if (empty($culture) && ($app !== null)) {
			$culture = $app->getCulture();
		}
		$variants = [];
		if ($app !== null) {
			$variants = $app->getCultureVariants($culture);
		}

		$langs = $this->getAvailableLanguages();
		foreach ($variants as $variant) {
			if (in_array($variant, $langs)) {
				return $variant;
			}
		}

		return 'en';
	}

	/**
	 * 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.THtmlArea5';
	}
}