[ Index ]

PHP Cross Reference of phpBB-3.3.2-deutsch




/vendor/s9e/text-formatter/src/Plugins/ -> ConfiguratorBase.php (summary)

(no description)

Copyright: Copyright (c) 2010-2020 The s9e authors
License: http://www.opensource.org/licenses/mit-license.php The MIT License
File Size: 256 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 13 functions


Functions that are not part of a class:

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

param: Configurator $configurator
param: array        $overrideProps Properties of the plugin will be overwritten with those

setUp()   X-Ref
Executed by this plugin's constructor

finalize()   X-Ref
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

asConfig()   X-Ref

return: array|null This plugin's config, or NULL to disable this plugin

getBaseProperties()   X-Ref
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

getJSHints()   X-Ref
Return additional hints used in the JavaScript parser

return: array Hint names and values

getJSParser()   X-Ref
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

getTag()   X-Ref
Return the tag associated with this plugin, if applicable

return: \s9e\TextFormatter\Configurator\Items\Tag

disableQuickMatch()   X-Ref
Disable quickMatch

return: void

setAttrName($attrName)   X-Ref
Set $this->attrName with given attribute name, normalized

param: string $attrName New attribute name
return: void

setQuickMatch($quickMatch)   X-Ref
Set the quickMatch string

param: string $quickMatch
return: void

setRegexpLimit($limit)   X-Ref
Set the maximum number of regexp matches

param: integer $limit
return: void

setTagName($tagName)   X-Ref
Set $this->tagName with given tag name, normalized

param: string $tagName New tag name
return: void

Generated: Wed Nov 11 20:28:18 2020 Cross-referenced by PHPXref 0.7.1