HtmlEditorConfig::enablePlugins() - Code Metrics - Inspection of "Add new committers" - sminnee/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — new-committers ( 29cb6f...bcba16 )

by Sam

created 2016-04-19 10:25 UTC

HtmlEditorConfig::enablePlugins() B

↳ Parent: HtmlEditorConfig

Complexity

Conditions	5
Paths	10

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	13
rs	8.8571
cc	5
eloc	9
nc	10
nop	0

<?php

/**
 * A PHP version of TinyMCE's configuration, to allow various parameters to be configured on a site or section basis
 *
 * There can be multiple HtmlEditorConfig's, which should always be created / accessed using HtmlEditorConfig::get.
 * You can then set the currently active config using set_active. Whichever config is active when
 * HtmlEditorField#Field is called wins.
 *
 * @author "Hamish Friedlander" <[email protected]>
 * @package forms
 * @subpackage fields-formattedinput
 */
class HtmlEditorConfig {

	private static $configs = array();

	private static $current = null;

	/**
	 * Get the HtmlEditorConfig object for the given identifier. This is a correct way to get an HtmlEditorConfig
	 * instance - do not call 'new'
	 *
	 * @param $identifier string - the identifier for the config set
	 * @return HtmlEditorConfig - the configuration object. This will be created if it does not yet exist for that
	 *                            identifier
	 */
	public static function get($identifier = 'default') {
		if (!array_key_exists($identifier, self::$configs)) self::$configs[$identifier] = new HtmlEditorConfig();
		return self::$configs[$identifier];
	}

	/**
	 * Set the currently active configuration object
	 * @param $identifier string - the identifier for the config set
	 * @return null
	 */
	public static function set_active($identifier = null) {
		self::$current = $identifier;
	}

	/**
	 * Get the currently active configuration identifier
	 * @return String - the active configuration identifier
	 */
	public static function get_active_identifier() {
		$identifier = self::$current ? self::$current : 'default';
		return $identifier;
	}
	/**
	 * Get the currently active configuration object
	 * @return HtmlEditorConfig - the active configuration object
	 */
	public static function get_active() {
		$identifier = self::get_active_identifier();
		return self::get($identifier);
	}

	/**
	 * Get the available configurations as a map of friendly_name to
	 * configuration name.
	 * @return array
	 */
	public static function get_available_configs_map() {
		$configs = array();

		foreach(self::$configs as $identifier => $config) {
			$configs[$identifier] = $config->getOption('friendly_name');
		}

		return $configs;
	}

	/**
	 * Holder for all TinyMCE settings _except_ plugins and buttons
	 */
	protected $settings = array(
		'friendly_name' => '(Please set a friendly name for this config)',
		'priority' => 0,
		'mode' => "none", // initialized through HtmlEditorField.js redraw() logic
		'editor_selector' => "htmleditor",
		'width' => "100%",
		'auto_resize' => false,
		'update_interval' => 5000, // Ensure update of this data every 5 seconds to the underlying textarea
		'theme' => "advanced",

		'theme_advanced_layout_manager' => "SimpleLayout",
		'theme_advanced_toolbar_location' => "top",
		'theme_advanced_toolbar_align' => "left",
		'theme_advanced_toolbar_parent' => "right",

		'blockquote_clear_tag' => "p",
		'table_inline_editing' => true,

		'safari_warning' => false,
		'relative_urls' => true,
		'verify_html' => true,
		'browser_spellcheck' => true,
	);

	/**
	 * Holder list of enabled plugins
	 */
	protected $plugins = array(
		'contextmenu' => null,
		'table' => null,
		'emotions' => null,
		'paste' => null,
	);

	/**
	 * Holder list of buttons, organised by line
	 */
	protected $buttons = array(
		1 => array('bold','italic','underline','strikethrough','separator',
			'justifyleft','justifycenter','justifyright','justifyfull','formatselect','separator',
			'bullist','numlist','outdent','indent','blockquote','hr','charmap'),
		2 => array('undo','redo','separator','cut','copy','paste','pastetext','pasteword','separator',
			'advcode','search','replace','selectall','visualaid','separator','tablecontrols'),
		3 => array()
	);

	/**
	 * Get the current value of an option
	 * @param $k string - The key of the option to get
	 * @return mixed - The value of the specified option
	 */
	public function getOption($k) {
		if(isset($this->settings[$k])) return $this->settings[$k];
	}

	/**
	 * Set the value of one option
	 * @param $k string - The key of the option to set
	 * @param $v mixed - The value of the option to set
	 * @return HtmlEditorConfig
	 */
	public function setOption($k,$v) {
		$this->settings[$k] = $v;
		return $this;
	}

	/**
	 * Set multiple options
	 * @param $a array - The options to set, as keys and values of the array
	 * @return HtmlEditorConfig
	 */
	public function setOptions($a) {
		foreach ($a as $k=>$v) {
			$this->settings[$k] = $v;
		}
		return $this;
	}

	/**
	 * Enable one or several plugins. Will maintain unique list if already
	 * enabled plugin is re-passed. If passed in as a map of plugin-name to path,
	 * the plugin will be loaded by tinymce.PluginManager.load() instead of through tinyMCE.init().
	 * Keep in mind that these externals plugins require a dash-prefix in their name.
	 *
	 * @see http://wiki.moxiecode.com/index.php/TinyMCE:API/tinymce.PluginManager/load
	 *
	 * @param String [0..] a string, or several strings, or a single array of strings - The plugins to enable
	 * @return HtmlEditorConfig
	 */
	public function enablePlugins() {
		$plugins = func_get_args();
		if (is_array(current($plugins))) $plugins = current($plugins);
		foreach ($plugins as $plugin => $path) {
			// if plugins are passed without a path
			if(is_numeric($plugin)) {
				$plugin = $path;
				$path = null;
			}
			if (!array_key_exists($plugin, $this->plugins)) $this->plugins[$plugin] = $path;
		}
		return $this;
	}

	/**
	 * Enable one or several plugins. Will properly handle being passed a plugin that is already disabled
	 * @param String [0..] a string, or several strings, or a single array of strings - The plugins to disable
	 * @return HtmlEditorConfig
	 */
	public function disablePlugins() {
		$plugins = func_get_args();
		if (is_array(current($plugins))) $plugins = current($plugins);

		foreach ($plugins as $plugin) {
			if(array_key_exists($plugin, $this->plugins)) {
				unset($this->plugins[$plugin]);
			}
		}
		return $this;
	}

	/**
	 * @return Array
	 */
	public function getPlugins() {
		return $this->plugins;
	}

	/**
	 * Totally re-set the buttons on a given line
	 *
	 * @param integer from 1..3 - The line number to redefine
	 * @param string  a string or several strings, or a single array of strings - The button names to make this line
	 *                contain
	 * @return HtmlEditorConfig
	 */
	public function setButtonsForLine() {
		if (func_num_args() == 2) {
			list($line, $buttons) = func_get_args();
		}
		else {
			$buttons = func_get_args();
			$line = array_shift($buttons);
		}
		$this->buttons[$line] = is_array($buttons) ? $buttons : array($buttons);
		return $this;
	}

	/**
	 * Add buttons to the end of a line
	 * @param integer from 1..3
	 * @param string a string, or several strings, or a single array of strings - The button names to add to the end
	 *               of this line
	 * @return HtmlEditorConfig
	 */
	public function addButtonsToLine() {
		$inserts = func_get_args();
		$line = array_shift($inserts);
		if (is_array($inserts[0])) $inserts = $inserts[0];

		foreach ($inserts as $button) {
			$this->buttons[$line][] = $button;
		}
		return $this;
	}

	/**
	 * Internal function for adding and removing buttons related to another button
	 * @param $name string - the name of the button to modify
	 * @param $offset integer - the offset relative to that button to perform an array_splice at - 0 for before $name,
	 *                          1 for after
	 * @param $del integer - the number of buttons to remove at the position given by index(string) + offset
	 * @param $add mixed - an array or single item to insert at the position given by index(string) + offset,
	 *                     or null for no insertion
	 * @return boolean - true if $name matched a button, false otherwise
	 */
	protected function modifyButtons($name, $offset, $del=0, $add=null) {
		foreach ($this->buttons as &$buttons) {
			if (($idx = array_search($name, $buttons)) !== false) {
				if ($add) array_splice($buttons, $idx+$offset, $del, $add);
				else     array_splice($buttons, $idx+$offset, $del, $add);
				return true;
			}
		}
		return false;
	}

	/**
	 * Insert buttons before the first occurance of another button
	 * @param string - the name of the button to insert other buttons before
	 * @param string a string, or several strings, or a single array of strings - the button names to insert before
	 *               that button
	 * @return boolean - true if insertion occured, false if it did not (because the given button name was not found)
	 */
	public function insertButtonsBefore() {
		$inserts = func_get_args();
		$before = array_shift($inserts);
		return $this->modifyButtons($before, 0, 0, $inserts);
	}

	/**
	 * Insert buttons after the first occurance of another button
	 * @param string - the name of the button to insert other buttons after
	 * @param string a string, or several strings, or a single array of strings - the button names to insert after
	 *               that button
	 * @return boolean - true if insertion occured, false if it did not (because the given button name was not found)
	 */
	public function insertButtonsAfter() {
		$inserts = func_get_args();
		$after = array_shift($inserts);
		return $this->modifyButtons($after, 1, 0, $inserts);
	}

	/**
	 * Remove the first occurance of buttons
	 * @param string one or more strings - the name of the buttons to remove
	 * @return null
	 */
	public function removeButtons() {
		$removes = func_get_args();
		foreach ($removes as $button) {
			$this->modifyButtons($button, 0, 1);
		}
	}

	/**
	 * Generate the JavaScript that will set TinyMCE's configuration:
	 * - Parse all configurations into JSON objects to be used in JavaScript
	 * - Includes TinyMCE and configurations using the {@link Requirements} system
	 */
	public static function require_js() {
		require_once 'tinymce/tiny_mce_gzip.php';
		$useGzip = Config::inst()->get('HtmlEditorField', 'use_gzip');

		$configs = array();
		$externalPlugins = array();
		$internalPlugins = array();
		$languages = array();

		foreach (self::$configs as $configID => $config) {
			$settings = $config->settings;
			// parse plugins
			$configPlugins = array();
			foreach($config->plugins as $plugin => $path) {
				if(!$path) {
					$configPlugins[] = $plugin;
					$internalPlugins[] = $plugin;
				} else {
					$configPlugins[] = '-' . $plugin;
					if ( !array_key_exists($plugin, $externalPlugins) )
					{
						$externalPlugins[$plugin] = sprintf(
							'tinymce.PluginManager.load("%s", "%s");',
							$plugin,
							$path
						);
					}
				}
			}

			// save config plugins settings
			$settings['plugins'] = implode(',', $configPlugins);

			// buttons
			foreach ($config->buttons as $i=>$buttons) {
				$settings['theme_advanced_buttons'.$i] = implode(',', $buttons);
			}

			// languages
			$languages[] = $config->getOption('language');

			// save this config settings
			$configs[$configID] = $settings;
		}

		// tinyMCE JS requirement
		if ( $useGzip )
		{
			$tag = TinyMCE_Compressor::renderTag(array(
				'url' => THIRDPARTY_DIR . '/tinymce/tiny_mce_gzip.php',
				'plugins' => implode(',', $internalPlugins),
				'themes' => 'advanced',
				'languages' => implode(",", array_filter($languages))
			), true);
			preg_match('/src="([^"]*)"/', $tag, $matches);
			Requirements::javascript(html_entity_decode($matches[1]));
		}
		else{
			Requirements::javascript(MCE_ROOT . 'tiny_mce_src.js');
		}

		// prepare external plugins js string
		$externalPlugins = array_values($externalPlugins);
		$externalPlugins = implode("\n	", $externalPlugins);

		// tinyMCE config object and external plugings
		$configsJS = "
if((typeof tinyMCE != 'undefined')) {
	$externalPlugins
	var ssTinyMceConfig = " . Convert::raw2json($configs) . ";
}";
		Requirements::customScript($configsJS, 'htmlEditorConfig');
	}
}


1			<?php
2
3			/**
4			* A PHP version of TinyMCE's configuration, to allow various parameters to be configured on a site or section basis
5			*
6			* There can be multiple HtmlEditorConfig's, which should always be created / accessed using HtmlEditorConfig::get.
7			* You can then set the currently active config using set_active. Whichever config is active when
8			* HtmlEditorField#Field is called wins.
9			*
10			* @author "Hamish Friedlander" <[email protected]>
11			* @package forms
12			* @subpackage fields-formattedinput
13			*/
14			class HtmlEditorConfig {
15
16			private static $configs = array();
17
18			private static $current = null;
19
20			/**
21			* Get the HtmlEditorConfig object for the given identifier. This is a correct way to get an HtmlEditorConfig
22			* instance - do not call 'new'
23			*
24			* @param $identifier string - the identifier for the config set
25			* @return HtmlEditorConfig - the configuration object. This will be created if it does not yet exist for that
26			* identifier
27			*/
28			public static function get($identifier = 'default') {
29			if (!array_key_exists($identifier, self::$configs)) self::$configs[$identifier] = new HtmlEditorConfig();
30			return self::$configs[$identifier];
31			}
32
33			/**
34			* Set the currently active configuration object
35			* @param $identifier string - the identifier for the config set
36			* @return null
37			*/
38			public static function set_active($identifier = null) {
39			self::$current = $identifier;
40			}
41
42			/**
43			* Get the currently active configuration identifier
44			* @return String - the active configuration identifier
45			*/
46			public static function get_active_identifier() {
47			$identifier = self::$current ? self::$current : 'default';
48			return $identifier;
49			}
50			/**
51			* Get the currently active configuration object
52			* @return HtmlEditorConfig - the active configuration object
53			*/
54			public static function get_active() {
55			$identifier = self::get_active_identifier();
56			return self::get($identifier);
57			}
58
59			/**
60			* Get the available configurations as a map of friendly_name to
61			* configuration name.
62			* @return array
63			*/
64			public static function get_available_configs_map() {
65			$configs = array();
66
67			foreach(self::$configs as $identifier => $config) {
68			$configs[$identifier] = $config->getOption('friendly_name');
69			}
70
71			return $configs;
72			}
73
74			/**
75			* Holder for all TinyMCE settings _except_ plugins and buttons
76			*/
77			protected $settings = array(
78			'friendly_name' => '(Please set a friendly name for this config)',
79			'priority' => 0,
80			'mode' => "none", // initialized through HtmlEditorField.js redraw() logic
81			'editor_selector' => "htmleditor",
82			'width' => "100%",
83			'auto_resize' => false,
84			'update_interval' => 5000, // Ensure update of this data every 5 seconds to the underlying textarea
85			'theme' => "advanced",
86
87			'theme_advanced_layout_manager' => "SimpleLayout",
88			'theme_advanced_toolbar_location' => "top",
89			'theme_advanced_toolbar_align' => "left",
90			'theme_advanced_toolbar_parent' => "right",
91
92			'blockquote_clear_tag' => "p",
93			'table_inline_editing' => true,
94
95			'safari_warning' => false,
96			'relative_urls' => true,
97			'verify_html' => true,
98			'browser_spellcheck' => true,
99			);
100
101			/**
102			* Holder list of enabled plugins
103			*/
104			protected $plugins = array(
105			'contextmenu' => null,
106			'table' => null,
107			'emotions' => null,
108			'paste' => null,
109			);
110
111			/**
112			* Holder list of buttons, organised by line
113			*/
114			protected $buttons = array(
115			1 => array('bold','italic','underline','strikethrough','separator',
116			'justifyleft','justifycenter','justifyright','justifyfull','formatselect','separator',
117			'bullist','numlist','outdent','indent','blockquote','hr','charmap'),
118			2 => array('undo','redo','separator','cut','copy','paste','pastetext','pasteword','separator',
119			'advcode','search','replace','selectall','visualaid','separator','tablecontrols'),
120			3 => array()
121			);
122
123			/**
124			* Get the current value of an option
125			* @param $k string - The key of the option to get
126			* @return mixed - The value of the specified option
127			*/
128			public function getOption($k) {
129			if(isset($this->settings[$k])) return $this->settings[$k];
130			}
131
132			/**
133			* Set the value of one option
134			* @param $k string - The key of the option to set
135			* @param $v mixed - The value of the option to set
136			* @return HtmlEditorConfig
137			*/
138			public function setOption($k,$v) {
139			$this->settings[$k] = $v;
140			return $this;
141			}
142
143			/**
144			* Set multiple options
145			* @param $a array - The options to set, as keys and values of the array
146			* @return HtmlEditorConfig
147			*/
148			public function setOptions($a) {
149			foreach ($a as $k=>$v) {
150			$this->settings[$k] = $v;
151			}
152			return $this;
153			}
154
155			/**
156			* Enable one or several plugins. Will maintain unique list if already
157			* enabled plugin is re-passed. If passed in as a map of plugin-name to path,
158			* the plugin will be loaded by tinymce.PluginManager.load() instead of through tinyMCE.init().
159			* Keep in mind that these externals plugins require a dash-prefix in their name.
160			*
161			* @see http://wiki.moxiecode.com/index.php/TinyMCE:API/tinymce.PluginManager/load
162			*
163			* @param String [0..] a string, or several strings, or a single array of strings - The plugins to enable
164			* @return HtmlEditorConfig
165			*/
166			public function enablePlugins() {
167			$plugins = func_get_args();
168			if (is_array(current($plugins))) $plugins = current($plugins);
169			foreach ($plugins as $plugin => $path) {
170			// if plugins are passed without a path
171			if(is_numeric($plugin)) {
172			$plugin = $path;
173			$path = null;
174			}
175			if (!array_key_exists($plugin, $this->plugins)) $this->plugins[$plugin] = $path;
176			}
177			return $this;
178			}
179
180			/**
181			* Enable one or several plugins. Will properly handle being passed a plugin that is already disabled
182			* @param String [0..] a string, or several strings, or a single array of strings - The plugins to disable
183			* @return HtmlEditorConfig
184			*/
185			public function disablePlugins() {
186			$plugins = func_get_args();
187			if (is_array(current($plugins))) $plugins = current($plugins);
188
189			foreach ($plugins as $plugin) {
190			if(array_key_exists($plugin, $this->plugins)) {
191			unset($this->plugins[$plugin]);
192			}
193			}
194			return $this;
195			}
196
197			/**
198			* @return Array
199			*/
200			public function getPlugins() {
201			return $this->plugins;
202			}
203
204			/**
205			* Totally re-set the buttons on a given line
206			*
207			* @param integer from 1..3 - The line number to redefine
208			* @param string a string or several strings, or a single array of strings - The button names to make this line
209			* contain
210			* @return HtmlEditorConfig
211			*/
212			public function setButtonsForLine() {
213			if (func_num_args() == 2) {
214			list($line, $buttons) = func_get_args();
215			}
216			else {
217			$buttons = func_get_args();
218			$line = array_shift($buttons);
219			}
220			$this->buttons[$line] = is_array($buttons) ? $buttons : array($buttons);
221			return $this;
222			}
223
224			/**
225			* Add buttons to the end of a line
226			* @param integer from 1..3
227			* @param string a string, or several strings, or a single array of strings - The button names to add to the end
228			* of this line
229			* @return HtmlEditorConfig
230			*/
231			public function addButtonsToLine() {
232			$inserts = func_get_args();
233			$line = array_shift($inserts);
234			if (is_array($inserts[0])) $inserts = $inserts[0];
235
236			foreach ($inserts as $button) {
237			$this->buttons[$line][] = $button;
238			}
239			return $this;
240			}
241
242			/**
243			* Internal function for adding and removing buttons related to another button
244			* @param $name string - the name of the button to modify
245			* @param $offset integer - the offset relative to that button to perform an array_splice at - 0 for before $name,
246			* 1 for after
247			* @param $del integer - the number of buttons to remove at the position given by index(string) + offset
248			* @param $add mixed - an array or single item to insert at the position given by index(string) + offset,
249			* or null for no insertion
250			* @return boolean - true if $name matched a button, false otherwise
251			*/
252			protected function modifyButtons($name, $offset, $del=0, $add=null) {
253			foreach ($this->buttons as &$buttons) {
254			if (($idx = array_search($name, $buttons)) !== false) {
255			if ($add) array_splice($buttons, $idx+$offset, $del, $add);
256			else array_splice($buttons, $idx+$offset, $del, $add);
257			return true;
258			}
259			}
260			return false;
261			}
262
263			/**
264			* Insert buttons before the first occurance of another button
265			* @param string - the name of the button to insert other buttons before
266			* @param string a string, or several strings, or a single array of strings - the button names to insert before
267			* that button
268			* @return boolean - true if insertion occured, false if it did not (because the given button name was not found)
269			*/
270			public function insertButtonsBefore() {
271			$inserts = func_get_args();
272			$before = array_shift($inserts);
273			return $this->modifyButtons($before, 0, 0, $inserts);
274			}
275
276			/**
277			* Insert buttons after the first occurance of another button
278			* @param string - the name of the button to insert other buttons after
279			* @param string a string, or several strings, or a single array of strings - the button names to insert after
280			* that button
281			* @return boolean - true if insertion occured, false if it did not (because the given button name was not found)
282			*/
283			public function insertButtonsAfter() {
284			$inserts = func_get_args();
285			$after = array_shift($inserts);
286			return $this->modifyButtons($after, 1, 0, $inserts);
287			}
288
289			/**
290			* Remove the first occurance of buttons
291			* @param string one or more strings - the name of the buttons to remove
292			* @return null
293			*/
294			public function removeButtons() {
295			$removes = func_get_args();
296			foreach ($removes as $button) {
297			$this->modifyButtons($button, 0, 1);
298			}
299			}
300
301			/**
302			* Generate the JavaScript that will set TinyMCE's configuration:
303			* - Parse all configurations into JSON objects to be used in JavaScript
304			* - Includes TinyMCE and configurations using the {@link Requirements} system
305			*/
306			public static function require_js() {
307			require_once 'tinymce/tiny_mce_gzip.php';
308			$useGzip = Config::inst()->get('HtmlEditorField', 'use_gzip');
309
310			$configs = array();
311			$externalPlugins = array();
312			$internalPlugins = array();
313			$languages = array();
314
315			foreach (self::$configs as $configID => $config) {
316			$settings = $config->settings;
317			// parse plugins
318			$configPlugins = array();
319			foreach($config->plugins as $plugin => $path) {
320			if(!$path) {
321			$configPlugins[] = $plugin;
322			$internalPlugins[] = $plugin;
323			} else {
324			$configPlugins[] = '-' . $plugin;
325			if ( !array_key_exists($plugin, $externalPlugins) )
326			{
327			$externalPlugins[$plugin] = sprintf(
328			'tinymce.PluginManager.load("%s", "%s");',
329			$plugin,
330			$path
331			);
332			}
333			}
334			}
335
336			// save config plugins settings
337			$settings['plugins'] = implode(',', $configPlugins);
338
339			// buttons
340			foreach ($config->buttons as $i=>$buttons) {
341			$settings['theme_advanced_buttons'.$i] = implode(',', $buttons);
342			}
343
344			// languages
345			$languages[] = $config->getOption('language');
346
347			// save this config settings
348			$configs[$configID] = $settings;
349			}
350
351			// tinyMCE JS requirement
352			if ( $useGzip )
353			{
354			$tag = TinyMCE_Compressor::renderTag(array(
355			'url' => THIRDPARTY_DIR . '/tinymce/tiny_mce_gzip.php',
356			'plugins' => implode(',', $internalPlugins),
357			'themes' => 'advanced',
358			'languages' => implode(",", array_filter($languages))
359			), true);
360			preg_match('/src="([^"]*)"/', $tag, $matches);
361			Requirements::javascript(html_entity_decode($matches[1]));
362			}
363			else{
364			Requirements::javascript(MCE_ROOT . 'tiny_mce_src.js');
365			}
366
367			// prepare external plugins js string
368			$externalPlugins = array_values($externalPlugins);
369			$externalPlugins = implode("\n ", $externalPlugins);
370
371			// tinyMCE config object and external plugings
372			$configsJS = "
373			if((typeof tinyMCE != 'undefined')) {
374			$externalPlugins
375			var ssTinyMceConfig = " . Convert::raw2json($configs) . ";
376			}";
377			Requirements::customScript($configsJS, 'htmlEditorConfig');
378			}
379			}
380

sminnee / silverstripe-framework

Push — new-committers ( 29cb6f...bcba16 )

HtmlEditorConfig::enablePlugins() B

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like