Configurator
class Configurator extends ConfiguratorBase implements ArrayAccess, Countable, Iterator
Traits
Allows an object to act as a proxy for a NormalizedCollection stored in $this->collection
Properties
| protected Configurator | $configurator | from ConfiguratorBase | |
| protected | $quickMatch | {@inheritdoc} | |
| protected int | $regexpLimit | from ConfiguratorBase | |
| BBCodeCollection | $collection | ||
| BBCodeMonkey | $bbcodeMonkey | ||
| protected | $regexp | {@inheritdoc} | |
| RepositoryCollection | $repositories |
Methods
Plugin setup
No description
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
Forward all unknown method calls to $this->collection
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Add an item to this collection
Test whether a given value is present in this collection
Delete an item from this collection
Test whether an item of given key exists
Return a value from this collection
Find the index of a given value
Normalize an item's key
Normalize a value for storage
is called with a key that already exists
Set and overwrite a value in this collection
Add a BBCode from a repository
Add a BBCode and its tag based on the return config from BBCodeMonkey
Empty this collection
Details
in
ConfiguratorBase at line 42
final
__construct(Configurator $configurator, array $overrideProps = [])
No description
at line 84
protected
setUp()
Plugin setup
in
ConfiguratorBase 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 50
array
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
ConfiguratorBase 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
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
in
CollectionProxy at line 36
mixed
__call(string $methodName, array $args)
Forward all unknown method calls to $this->collection
at line 50
bool
offsetExists(string|int $offset)
No description
at line 50
mixed
offsetGet(string|int $offset)
No description
at line 50
void
offsetSet(string|int $offset, mixed $value)
No description
at line 50
void
offsetUnset(string|int $offset)
No description
at line 50
int
count()
No description
at line 50
mixed
current()
No description
at line 50
int|string
key()
No description
at line 50
mixed
next()
No description
at line 50
void
rewind()
No description
at line 50
bool
valid()
No description
at line 50
mixed
add(string $key, mixed $value)
Add an item to this collection
at line 50
bool
contains(mixed $value)
Test whether a given value is present in this collection
at line 50
void
delete(string $key)
Delete an item from this collection
at line 50
bool
exists(string $key)
Test whether an item of given key exists
at line 50
mixed
get(string $key)
Return a value from this collection
at line 50
mixed
indexOf(mixed $value)
Find the index of a given value
at line 50
string
normalizeKey(string $key)
Normalize an item's key
at line 50
mixed
normalizeValue(mixed $value)
Normalize a value for storage
at line 50
string
onDuplicate(string|null $action) Query and set the action to take when add()
is called with a key that already exists
at line 50
mixed
set(string $key, mixed $value)
Set and overwrite a value in this collection
at line 102
BBCode
addCustom(string $usage, string|Template $template, array $options = [])
Add a BBCode using their human-readable representation
at line 127
BBCode
addFromRepository(string $name, mixed $repository = 'default', array $vars = [])
Add a BBCode from a repository
at line 149
protected BBCode
addFromConfig(array $config)
Add a BBCode and its tag based on the return config from BBCodeMonkey
at line 50
void
clear()
Empty this collection