public function __get($name)Inherited
| $name |
| wild |
public function __set($name, $value)Inherited
| $name | ||
| $value |
| wild |
public function current()Inherited
| wild |
public function key()Inherited
| wild |
public function next()Inherited
| wild |
public function rewind()Inherited
| wild |
public function valid()Inherited
| wild |
private function throwOnAttemptedIteration()Inherited
| wild |
public function getPhobjectClassConstant($key, $byte_limit)Inherited
Read the value of a class constant.
This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.
| string | $key | Name of the constant. |
| int|null | $byte_limit | Maximum number of bytes permitted in the value. |
| string | Value of the constant. |
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.
| string | $key | Key to set in the configuration dictionary. |
| string | $value | Value to set. |
| this |
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.
| string | $key | Key to retrieve from metadata. |
| mixed | $default | Default value to return if the key is not available. |
| mixed | Metadata property, or default value. |
abstract public function markupText($text)
| $text |
| wild |