Configurator
class Configurator extends AbstractConfigurator
Properties
| protected Configurator | $configurator | from ConfiguratorBase | |
| protected | $quickMatch | from AbstractConfigurator | |
| protected int | $regexpLimit | from ConfiguratorBase | |
| array | $fileExtensions | ||
| protected | $attrName | ||
| protected | $regexp | from AbstractConfigurator | |
| protected | $tagName |
Methods
Return a list of base properties meant to be added to asConfig()'s return
Set $this->attrName with given attribute name, normalized
Set $this->tagName with given tag name, normalized
No description
Details
in
ConfiguratorBase at line 42
final
__construct(Configurator $configurator, array $overrideProps = [])
No description
in
AbstractConfigurator at line 42
protected
setUp()
Creates the tag used by this plugin
in
AbstractConfigurator at line 25
finalize()
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
in
ConfiguratorBase at line 91
array|Dictionary|null
asConfig()
No description
in
ConfiguratorBase at line 109
final array
getBaseProperties()
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
in
ConfiguratorBase at line 131
array
getJSHints()
Return additional hints used in the JavaScript parser
in
AbstractConfigurator at line 30
string|null
getJSParser()
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
in
ConfiguratorBase at line 167
Tag
getTag()
Return the tag associated with this plugin, if applicable
in
ConfiguratorBase at line 186
void
disableQuickMatch()
Disable quickMatch
in
ConfiguratorBase at line 197
protected void
setAttrName(string $attrName)
Set $this->attrName with given attribute name, normalized
in
ConfiguratorBase at line 213
void
setQuickMatch(string $quickMatch)
Set the quickMatch string
in
ConfiguratorBase at line 229
void
setRegexpLimit(int $limit)
Set the maximum number of regexp matches
in
ConfiguratorBase at line 247
protected void
setTagName(string $tagName)
Set $this->tagName with given tag name, normalized
at line 18
protected string
getTemplate()
No description
in
AbstractConfigurator at line 65
protected void
updateRegexp()
No description