class ShortcodeParser

A simple parser that allows you to map BBCode-like "shortcodes" to an arbitrary callback.

It is a simple regex based parser that allows you to replace simple bbcode-like tags within a DBHTMLText or DBHTMLVarchar field when rendered into a template. The API is inspired by and very similar to the Wordpress implementation of shortcodes.

Traits

A class that can be instantiated or replaced via DI
Provides extensions to this object to integrate it with standard config API methods.
Allows an object to have extensions applied to it.
Allows an object to declare a set of custom methods

Constants

WARN

STRIP

LEAVE

ERROR

BEFORE

AFTER

SPLIT

INLINE

Properties

static $error_behavior

Methods

static Injectable
create(array $args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

static Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .

mixed
stat(string $name) deprecated

Get inherited config value

mixed
uninherited(string $name)

Gets the uninherited value for the given config option

$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

mixed
__call(string $method, array $arguments)

Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located

bool
hasMethod(string $method)

Return TRUE if a method exists on this object

array
allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

static bool
add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

static 
remove_extension(string $extension)

Remove an extension from a class.

static array
get_extensions(string $class = null, bool $includeArgumentString = false)

No description

static array|null
get_extra_config_sources(string $class = null)

Get extra config sources for this class

static bool
has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)

Return TRUE if a class has a specified extension.

array
invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

array
extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

Extension|null
getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

bool
hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.

getExtensionInstances()

Get all extension instances for this specific object instance.

__construct()

No description

img_shortcode($attrs)

No description

static ShortcodeParser
get(string $identifier = 'default')

Get the {@link ShortcodeParser} instance that is attached to a particular identifier.

static ShortcodeParser
get_active()

Get the currently active/default {@link ShortcodeParser} instance.

static 
set_active(string $identifier)

Set the identifier to use for the current active/default {@link ShortcodeParser} instance.

$this
register(string $shortcode, callback $callback)

Register a shortcode, and attach it to a PHP callback.

bool
registered(string $shortcode)

Check if a shortcode has been registered.

unregister(string $shortcode)

Remove a specific registered shortcode.

array
getRegisteredShortcodes()

Get an array containing information about registered shortcodes

clear()

Remove all registered shortcodes.

mixed
callShortcode(string $tag, array $attributes, string $content, array $extra = array())

Call a shortcode and return its replacement text Returns false if the shortcode isn't registered

bool|mixed|string
getShortcodeReplacementText(array $tag, array $extra = array(), boolean $isHTMLAllowed = true)

Return the text to insert in place of a shoprtcode.

array
extractTags(string $content)

Look through a string that contains shortcode tags and pull out the locations and details of those tags

string
parse(string $content)

Parse a string, and replace any registered shortcodes within it with the result of the mapped callback.

Details

in Injectable at line 26
static Injectable create(array $args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();

Parameters

array $args

Return Value

Injectable

in Injectable at line 43
static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class Optional classname to create, if the called class should not be used

Return Value

Injectable The singleton instance

in Configurable at line 20
static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .

....).

Return Value

Config_ForClass

in Configurable at line 32
mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

in Configurable at line 44
mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

in Configurable at line 57
$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

in CustomMethods at line 47
mixed __call(string $method, array $arguments)

Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located

You can add extra methods to a class using {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}

Parameters

string $method
array $arguments

Return Value

mixed

Exceptions

BadMethodCallException

in CustomMethods at line 146
bool hasMethod(string $method)

Return TRUE if a method exists on this object

This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions

Parameters

string $method

Return Value

bool

in CustomMethods at line 176
array allMethodNames(bool $custom = false)

Return the names of all the methods available on this object

Parameters

bool $custom include methods added dynamically at runtime

Return Value

array

in Extensible at line 172
static bool add_extension(string $classOrExtension, string $extension = null)

Add an extension to a specific class.

The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.

As an alternative, extensions can be added to a specific class directly in the {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).

Parameters

string $classOrExtension Class that should be extended - has to be a subclass of {@link Object}
string $extension Subclass of {@link Extension} with optional parameters as a string, e.g. "Versioned" or "Translatable('Param')"

Return Value

bool Flag if the extension was added

See also

http://doc.silverstripe.org/framework/en/trunk/reference/dataextension

in Extensible at line 236
static remove_extension(string $extension)

Remove an extension from a class.

Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.

Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.

Parameters

string $extension class name of an {@link Extension} subclass, without parameters

in Extensible at line 278
static array get_extensions(string $class = null, bool $includeArgumentString = false)

Parameters

string $class If omitted, will get extensions for the current class
bool $includeArgumentString Include the argument string in the return array, FALSE would return array("Versioned"), TRUE returns array("Versioned('Stage','Live')").

Return Value

array Numeric array of either {@link DataExtension} class names, or eval'ed class name strings with constructor arguments.

in Extensible at line 312
static array|null get_extra_config_sources(string $class = null)

Get extra config sources for this class

Parameters

string $class Name of class. If left null will return for the current class

Return Value

array|null

in Extensible at line 373
static bool has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)

Return TRUE if a class has a specified extension.

This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))

Parameters

string $classOrExtension Class to check extension for, or the extension name to check if the second argument is null.
string $requiredExtension If the first argument is the parent class, this is the extension to check. If left null, the first parameter will be treated as the extension.
boolean $strict if the extension has to match the required extension and not be a subclass

Return Value

bool Flag if the extension exists

in Extensible at line 415
array invokeWithExtensions(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array

Parameters

string $method the method name to call
mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array List of results with nulls filtered out

in Extensible at line 450
array extend(string $method, mixed $a1 = null, mixed $a2 = null, mixed $a3 = null, mixed $a4 = null, mixed $a5 = null, mixed $a6 = null, mixed $a7 = null)

Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed

Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.

The extension methods are defined during {@link __construct()} in {@link defineMethods()}.

Parameters

string $method the name of the method to call on each extension
mixed $a1
mixed $a2
mixed $a3
mixed $a4
mixed $a5
mixed $a6
mixed $a7

Return Value

array

in Extensible at line 497
Extension|null getExtensionInstance(string $extension)

Get an extension instance attached to this object by name.

Parameters

string $extension

Return Value

Extension|null

in Extensible at line 526
bool hasExtension(string $extension)

Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.

Caution: Don't use singleton()->hasExtension() as it will give you inconsistent results based on when the singleton was first accessed.

Parameters

string $extension Classname of an {@link Extension} subclass without parameters

Return Value

bool

in Extensible at line 540
Extension[] getExtensionInstances()

Get all extension instances for this specific object instance.

See {@link get_extensions()} to get all applied extension classes for this class (not the instance).

This method also provides lazy-population of the extension_instances property.

Return Value

Extension[] Map of {@link DataExtension} instances, keyed by classname.

at line 27
__construct()

at line 31
img_shortcode($attrs)

Parameters

$attrs

at line 59
static ShortcodeParser get(string $identifier = 'default')

Get the {@link ShortcodeParser} instance that is attached to a particular identifier.

Parameters

string $identifier Defaults to "default".

Return Value

ShortcodeParser

at line 73
static ShortcodeParser get_active()

Get the currently active/default {@link ShortcodeParser} instance.

Return Value

ShortcodeParser

at line 83
static set_active(string $identifier)

Set the identifier to use for the current active/default {@link ShortcodeParser} instance.

Parameters

string $identifier

at line 105
$this register(string $shortcode, callback $callback)

Register a shortcode, and attach it to a PHP callback.

The callback for a shortcode will have the following arguments passed to it: - Any parameters attached to the shortcode as an associative array (keys are lower-case). - Any content enclosed within the shortcode (if it is an enclosing shortcode). Note that any content within this will not have been parsed, and can optionally be fed back into the parser. - The {@link ShortcodeParser} instance used to parse the content. - The shortcode tag name that was matched within the parsed content. - An associative array of extra information about the shortcode being parsed.

Parameters

string $shortcode The shortcode tag to map to the callback - normally in lowercase_underscore format.
callback $callback The callback to replace the shortcode with.

Return Value

$this

at line 121
bool registered(string $shortcode)

Check if a shortcode has been registered.

Parameters

string $shortcode

Return Value

bool

at line 131
unregister(string $shortcode)

Remove a specific registered shortcode.

Parameters

string $shortcode

at line 143
array getRegisteredShortcodes()

Get an array containing information about registered shortcodes

Return Value

array

at line 151
clear()

Remove all registered shortcodes.

at line 166
mixed callShortcode(string $tag, array $attributes, string $content, array $extra = array())

Call a shortcode and return its replacement text Returns false if the shortcode isn't registered

Parameters

string $tag
array $attributes
string $content
array $extra

Return Value

mixed

at line 187
bool|mixed|string getShortcodeReplacementText(array $tag, array $extra = array(), boolean $isHTMLAllowed = true)

Return the text to insert in place of a shoprtcode.

Behaviour in the case of missing shortcodes depends on the setting of ShortcodeParser::$error_behavior.

Parameters

array $tag A map containing the the following keys: - 'open': The name of the tag - 'attrs': Attributes of the tag - 'content': Content of the tag
array $extra Extra-meta data
boolean $isHTMLAllowed A boolean indicating whether it's okay to insert HTML tags into the result

Return Value

bool|mixed|string

at line 320
array extractTags(string $content)

Look through a string that contains shortcode tags and pull out the locations and details of those tags

Doesn't support nested shortcode tags

Parameters

string $content

Return Value

array
  • The list of tags found. When using an open/close pair, only one item will be in the array, with "content" set to the text between the tags

at line 639
string parse(string $content)

Parse a string, and replace any registered shortcodes within it with the result of the mapped callback.

Parameters

string $content

Return Value

string