PHP Class Webiny\Component\TemplateEngine\Plugin

This class is used by template engines to register plugins. Based on the template engine a plugin can be a modifier, a tag, a filter or something else.
Inheritance: use trait Webiny\Component\StdLib\StdLibTrait
Show file Open project: Webiny/Framework Class Usage Examples

Public Methods

Method Description
__construct ( string $name, string $type, Closure | string $callbackFunction, array $params = [] ) Base constructor.
getAttribute ( string $key, mixed $defaultValue = false ) : mixed Return the attribute value under the defined $key.
getCallbackFunction ( ) : callable | string Get the callable function.
getName ( ) : string Get plugin name.
getParams ( ) : array Get plugin parameters.
getType ( ) : string Get plugin type.
setAttribute ( string $key, mixed $value ) Sets an optional attribute to the plugin.

Method Details

__construct() public method

Base constructor.
public __construct ( string $name, string $type, Closure | string $callbackFunction, array $params = [] )
$name string Plugin Name of the plugin.
$type string Plugin type. The type value depends on the current template engine driver. They usually have values like "function", "tag", "modifier"..etc. Basically they define the type of the plugin.
$callbackFunction Closure | string Callback function that holds the plugin logic.
$params array Optional parameters that can be passed to the plugin.

getAttribute() public method

Return the attribute value under the defined $key.
public getAttribute ( string $key, mixed $defaultValue = false ) : mixed
$key string Attribute key.
$defaultValue mixed Default value that the method should return if $key is not found among the attributes.
return mixed

getCallbackFunction() public method

Get the callable function.
public getCallbackFunction ( ) : callable | string
return callable | string Plugin callable function.

getName() public method

Get plugin name.
public getName ( ) : string
return string Plugin name.

getParams() public method

Get plugin parameters.
public getParams ( ) : array
return array Plugin params.

getType() public method

Get plugin type.
public getType ( ) : string
return string Plugin type.

setAttribute() public method

Sets an optional attribute to the plugin.
public setAttribute ( string $key, mixed $value )
$key string Attribute key.
$value mixed Attribute value.