abstract class ConfiguratorBase implements ConfigProvider

Properties

protected Configurator $configurator
protected mixed $quickMatch
protected int $regexpLimit

Methods

__construct(Configurator $configurator, array $overrideProps = [])

No description

setUp()

Executed by this plugin's constructor

finalize()

Finalize this plugin's configuration

array|Dictionary|null
asConfig()

No description

array
getBaseProperties()

Return a list of base properties meant to be added to asConfig()'s return

array
getJSHints()

Return additional hints used in the JavaScript parser

string|null
getJSParser()

Return this plugin's JavaScript parser

Tag
getTag()

Return the tag associated with this plugin, if applicable

void
disableQuickMatch()

Disable quickMatch

void
setAttrName(string $attrName)

Set $this->attrName with given attribute name, normalized

void
setQuickMatch(string $quickMatch)

Set the quickMatch string

void
setRegexpLimit(int $limit)

Set the maximum number of regexp matches

void
setTagName(string $tagName)

Set $this->tagName with given tag name, normalized

Details

at line 42
final __construct(Configurator $configurator, array $overrideProps = [])

No description

Parameters

Configurator $configurator
array $overrideProps

Properties of the plugin will be overwritten with those

at line 70
protected setUp()

Executed by this plugin's constructor

at line 84
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

at line 91
array|Dictionary|null asConfig()

No description

Return Value

array|Dictionary|null

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

Return Value

array

at line 131
array getJSHints()

Return additional hints used in the JavaScript parser

Return Value

array

Hint names and values

at line 144
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

Return Value

string|null

JavaScript source, or NULL if no JS parser is available

at line 167
Tag getTag()

Return the tag associated with this plugin, if applicable

Return Value

Tag

at line 186
void disableQuickMatch()

Disable quickMatch

Return Value

void

at line 197
protected void setAttrName(string $attrName)

Set $this->attrName with given attribute name, normalized

Parameters

string $attrName

New attribute name

Return Value

void

at line 213
void setQuickMatch(string $quickMatch)

Set the quickMatch string

Parameters

string $quickMatch

Return Value

void

at line 229
void setRegexpLimit(int $limit)

Set the maximum number of regexp matches

Parameters

int $limit

Return Value

void

at line 247
protected void setTagName(string $tagName)

Set $this->tagName with given tag name, normalized

Parameters

string $tagName

New tag name

Return Value

void