abstract public function setConfig($key, $value)
abstract public function setConfig($key, $value)
Set a configuration parameter which the engine can read to customize how the text is marked up. This is a generic interface; consult the documentation for specific rules and blocks for what options are available for configuration.
Parameters
| string | $key | Key to set in the configuration dictionary. |
| string | $value | Value to set. |
Return
| this |
abstract public function getTextMetadata($key, $default)
abstract public function getTextMetadata($key, $default)
After text has been marked up with markupText(), you can retrieve any metadata the markup process generated by calling this method. This is a generic interface that allows rules to export extra information about text; consult the documentation for specific rules and blocks to see what metadata may be available in your configuration.
Parameters
| string | $key | Key to retrieve from metadata. |
| mixed | $default | Default value to return if the key is not available. |
Return
| mixed | Metadata property, or default value. |
abstract public function markupText($text)
abstract public function markupText($text)
Parameters
| $text |
Return
| wild |