ConfiguratorBase::setAttrName() - Code Metrics - Inspection of "WiP" - s9e/TextFormatter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — phpdbg (d0bf38)

by Josh

created 2018-01-25 00:53 UTC

ConfiguratorBase::setAttrName() A

↳ Parent: ConfiguratorBase

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	4
cts	4
cp	1
rs	9.6666
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	1
crap	2

<?php

/**
* @package   s9e\TextFormatter
* @copyright Copyright (c) 2010-2018 The s9e Authors
* @license   http://www.opensource.org/licenses/mit-license.php The MIT License
*/
namespace s9e\TextFormatter\Plugins;

use InvalidArgumentException;
use RuntimeException;
use s9e\TextFormatter\Configurator;
use s9e\TextFormatter\Configurator\ConfigProvider;
use s9e\TextFormatter\Configurator\Helpers\ConfigHelper;
use s9e\TextFormatter\Configurator\JavaScript\Code;
use s9e\TextFormatter\Configurator\Validators\AttributeName;
use s9e\TextFormatter\Configurator\Validators\TagName;

abstract class ConfiguratorBase implements ConfigProvider
{
	/**
	* @var Configurator
	*/
	protected $configurator;

	/**
	* @var mixed Ignored if FALSE. Otherwise, this plugin's parser will only be executed if this
	*            string is present in the original text
	*/
	protected $quickMatch = false;

	/**
	* @var integer Maximum amount of matches to process - used by the parser when running the global
	*              regexp
	*/
	protected $regexpLimit = 50000;

	/**
	* @param Configurator $configurator
	* @param array        $overrideProps Properties of the plugin will be overwritten with those
	*/
	final public function __construct(Configurator $configurator, array $overrideProps = [])
	{
		$this->configurator = $configurator;

		foreach ($overrideProps as $k => $v)
		{
			$methodName = 'set' . ucfirst($k);

			if (method_exists($this, $methodName))
			{
				$this->$methodName($v);
			}
			elseif (property_exists($this, $k))
			{
				$this->$k = $v;
			}
			else
			{
				throw new RuntimeException("Unknown property '" . $k . "'");
			}
		}

		$this->setUp();
	}

	/**
	* Executed by this plugin's constructor
	*/
	protected function setUp()
	{
	}

	/**
	* Finalize this plugin's configuration
	*
	* Executed by the configurator whenever the tags' config must be in a usable state:
	*  - before the parser's config is generated
	*  - before the renderer's stylesheet is generated
	*  - before HTML5 rules are generated
	*
	* As such, this method may be called multiple times during configuration
	*/
	public function finalize()
	{
	}

	/**
	* @return array|null This plugin's config, or NULL to disable this plugin
	*/
	public function asConfig()
	{
		$properties = get_object_vars($this);
		unset($properties['configurator']);

		return ConfigHelper::toArray($properties);
	}

	/**
	* Return a list of base properties meant to be added to asConfig()'s return
	*
	* NOTE: this final method exists so that the plugin's configuration can always specify those
	*       base properties, even if they're omitted from asConfig(). Going forward, this ensure
	*       that new base properties added to ConfiguratorBase appear in the plugin's config without
	*       having to update every plugin
	*
	* @return array
	*/
	final public function getBaseProperties()
	{
		$config = [
			'className'   => preg_replace('/Configurator$/', 'Parser', get_class($this)),
			'quickMatch'  => $this->quickMatch,
			'regexpLimit' => $this->regexpLimit
		];

		$js = $this->getJSParser();
		if (isset($js))
		{
			$config['js'] = new Code($js);
		}

		return $config;
	}

	/**
	* Return additional hints used in the JavaScript parser
	*
	* @return array Hint names and values
	*/
	public function getJSHints()
	{
		return [];
	}

	/**
	* Return this plugin's JavaScript parser
	*
	* This is the base implementation, meant to be overridden by custom plugins. By default it
	* returns the Parser.js file from stock plugins' directory, if available
	*
	* @return string|null JavaScript source, or NULL if no JS parser is available
	*/
	public function getJSParser()
	{
		$className = get_class($this);
		if (strpos($className, 's9e\\TextFormatter\\Plugins\\') === 0)
		{
			$p = explode('\\', $className);
			$pluginName = $p[3];

			$filepath = __DIR__ . '/' . $pluginName . '/Parser.js';
			if (file_exists($filepath))
			{
				return file_get_contents($filepath);
			}
		}

		return null;
	}

	/**
	* Return the tag associated with this plugin, if applicable
	*
	* @return \s9e\TextFormatter\Configurator\Items\Tag
	*/
	public function getTag()
	{
		if (!isset($this->tagName))
		{
			throw new RuntimeException('No tag associated with this plugin');
		}

		return $this->configurator->tags[$this->tagName];
	}

	//==========================================================================
	// Setters
	//==========================================================================

	/**
	* Disable quickMatch
	*
	* @return void
	*/
	public function disableQuickMatch()
	{
		$this->quickMatch = false;
	}

	/**
	* Set $this->attrName with given attribute name, normalized
	*
	* @param  string $attrName New attribute name
	* @return void
	*/
	protected function setAttrName($attrName)
	{
		if (!property_exists($this, 'attrName'))
		{
			throw new RuntimeException("Unknown property 'attrName'");
		}

		$this->attrName = AttributeName::normalize($attrName);
	}

	/**
	* Set the quickMatch string
	*
	* @param  string $quickMatch
	* @return void
	*/
	public function setQuickMatch($quickMatch)
	{
		if (!is_string($quickMatch))
		{
			throw new InvalidArgumentException('quickMatch must be a string');
		}

		$this->quickMatch = $quickMatch;
	}

	/**
	* Set the maximum number of regexp matches
	*
	* @param  integer $limit
	* @return void
	*/
	public function setRegexpLimit($limit)
	{
		$limit = (int) $limit;

		if ($limit < 1)
		{
			throw new InvalidArgumentException('regexpLimit must be a number greater than 0');
		}

		$this->regexpLimit = $limit;
	}

	/**
	* Set $this->tagName with given tag name, normalized
	*
	* @param  string $tagName New tag name
	* @return void
	*/
	protected function setTagName($tagName)
	{
		if (!property_exists($this, 'tagName'))
		{
			throw new RuntimeException("Unknown property 'tagName'");
		}

		$this->tagName = TagName::normalize($tagName);
	}
}

1		<?php
2
3		/**
4		* @package s9e\TextFormatter
5		* @copyright Copyright (c) 2010-2018 The s9e Authors
6		* @license http://www.opensource.org/licenses/mit-license.php The MIT License
7		*/
8		namespace s9e\TextFormatter\Plugins;
9
10		use InvalidArgumentException;
11		use RuntimeException;
12		use s9e\TextFormatter\Configurator;
13		use s9e\TextFormatter\Configurator\ConfigProvider;
14		use s9e\TextFormatter\Configurator\Helpers\ConfigHelper;
15		use s9e\TextFormatter\Configurator\JavaScript\Code;
16		use s9e\TextFormatter\Configurator\Validators\AttributeName;
17		use s9e\TextFormatter\Configurator\Validators\TagName;
18
19		abstract class ConfiguratorBase implements ConfigProvider
20		{
21		/**
22		* @var Configurator
23		*/
24		protected $configurator;
25
26		/**
27		* @var mixed Ignored if FALSE. Otherwise, this plugin's parser will only be executed if this
28		* string is present in the original text
29		*/
30		protected $quickMatch = false;
31
32		/**
33		* @var integer Maximum amount of matches to process - used by the parser when running the global
34		* regexp
35		*/
36		protected $regexpLimit = 50000;
37
38		/**
39		* @param Configurator $configurator
40		* @param array $overrideProps Properties of the plugin will be overwritten with those
41		*/
42	26	final public function __construct(Configurator $configurator, array $overrideProps = [])
43		{
44	26	$this->configurator = $configurator;
45
46	26	foreach ($overrideProps as $k => $v)
47		{
48	8	$methodName = 'set' . ucfirst($k);
49
50	8	if (method_exists($this, $methodName))
51		{
52	5	$this->$methodName($v);
53		}
54	3	elseif (property_exists($this, $k))
55		{
56	2	$this->$k = $v;
57		}
58		else
59		{
60	6	throw new RuntimeException("Unknown property '" . $k . "'");
61		}
62		}
63
64	23	$this->setUp();
65		}
66
67		/**
68		* Executed by this plugin's constructor
69		*/
70		protected function setUp()
71		{
72		}
73
74		/**
75		* Finalize this plugin's configuration
76		*
77		* Executed by the configurator whenever the tags' config must be in a usable state:
78		* - before the parser's config is generated
79		* - before the renderer's stylesheet is generated
80		* - before HTML5 rules are generated
81		*
82		* As such, this method may be called multiple times during configuration
83		*/
84		public function finalize()
85		{
86		}
87
88		/**
89		* @return array\|null This plugin's config, or NULL to disable this plugin
90		*/
91	1	public function asConfig()
92		{
93	1	$properties = get_object_vars($this);
94	1	unset($properties['configurator']);
95
96	1	return ConfigHelper::toArray($properties);
97		}
98
99		/**
100		* Return a list of base properties meant to be added to asConfig()'s return
101		*
102		* NOTE: this final method exists so that the plugin's configuration can always specify those
103		* base properties, even if they're omitted from asConfig(). Going forward, this ensure
104		* that new base properties added to ConfiguratorBase appear in the plugin's config without
105		* having to update every plugin
106		*
107		* @return array
108		*/
109	4	final public function getBaseProperties()
110		{
111		$config = [
112	4	'className' => preg_replace('/Configurator$/', 'Parser', get_class($this)),
113	4	'quickMatch' => $this->quickMatch,
114	4	'regexpLimit' => $this->regexpLimit
115		];
116
117	4	$js = $this->getJSParser();
118	4	if (isset($js))
119		{
120	1	$config['js'] = new Code($js);
121		}
122
123	4	return $config;
124		}
125
126		/**
127		* Return additional hints used in the JavaScript parser
128		*
129		* @return array Hint names and values
130		*/
131	1	public function getJSHints()
132		{
133	1	return [];
134		}
135
136		/**
137		* Return this plugin's JavaScript parser
138		*
139		* This is the base implementation, meant to be overridden by custom plugins. By default it
140		* returns the Parser.js file from stock plugins' directory, if available
141		*
142		* @return string\|null JavaScript source, or NULL if no JS parser is available
143		*/
144	6	public function getJSParser()
145		{
146	6	$className = get_class($this);
147	6	if (strpos($className, 's9e\\TextFormatter\\Plugins\\') === 0)
148		{
149	2	$p = explode('\\', $className);
150	2	$pluginName = $p[3];
151
152	2	$filepath = __DIR__ . '/' . $pluginName . '/Parser.js';
153	2	if (file_exists($filepath))
154		{
155	1	return file_get_contents($filepath);
156		}
157		}
158
159	5	return null;
160		}
161
162		/**
163		* Return the tag associated with this plugin, if applicable
164		*
165		* @return \s9e\TextFormatter\Configurator\Items\Tag
166		*/
167	2	public function getTag()
168		{
169	2	if (!isset($this->tagName))
170		{
171	1	throw new RuntimeException('No tag associated with this plugin');
172		}
173
174	1	return $this->configurator->tags[$this->tagName];
175		}
176
177		//==========================================================================
178		// Setters
179		//==========================================================================
180
181		/**
182		* Disable quickMatch
183		*
184		* @return void
185		*/
186	1	public function disableQuickMatch()
187		{
188	1	$this->quickMatch = false;
189		}
190
191		/**
192		* Set $this->attrName with given attribute name, normalized
193		*
194		* @param string $attrName New attribute name
195		* @return void
196		*/
197	2	protected function setAttrName($attrName)
198		{
199	2	if (!property_exists($this, 'attrName'))
200		{
201	1	throw new RuntimeException("Unknown property 'attrName'");
202		}
203
204	1	$this->attrName = AttributeName::normalize($attrName);
205		}
206
207		/**
208		* Set the quickMatch string
209		*
210		* @param string $quickMatch
211		* @return void
212		*/
213	3	public function setQuickMatch($quickMatch)
214		{
215	3	if (!is_string($quickMatch))
216		{
217	1	throw new InvalidArgumentException('quickMatch must be a string');
218		}
219
220	2	$this->quickMatch = $quickMatch;
221		}
222
223		/**
224		* Set the maximum number of regexp matches
225		*
226		* @param integer $limit
227		* @return void
228		*/
229	2	public function setRegexpLimit($limit)
230		{
231	2	$limit = (int) $limit;
232
233	2	if ($limit < 1)
234		{
235	1	throw new InvalidArgumentException('regexpLimit must be a number greater than 0');
236		}
237
238	1	$this->regexpLimit = $limit;
239		}
240
241		/**
242		* Set $this->tagName with given tag name, normalized
243		*
244		* @param string $tagName New tag name
245		* @return void
246		*/
247	2	protected function setTagName($tagName)
248		{
249	2	if (!property_exists($this, 'tagName'))
250		{
251	1	throw new RuntimeException("Unknown property 'tagName'");
252		}
253
254	1	$this->tagName = TagName::normalize($tagName);
255		}
256		}

s9e / TextFormatter

Branch — phpdbg (d0bf38)

ConfiguratorBase::setAttrName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like