abstract class ExternalTransformationsPlugin extends TransformationsPlugin

Provides common methods for all of the external transformations plugins.

Methods

void
applyTransformationNoWrap(array $options = [])

Enables no-wrapping

string
applyTransformation(string $buffer, array $options = [], stdClass|null $meta = null)

Does the actual work of each specific transformations plugin.

array
getOptions(array $options, array $defaults)

Returns passed options or default values if they were not set

static string
getInfo()

Gets the transformation description of the specific plugin

static string
getName()

Gets the transformation name of the specific plugin

Details

at line 52
void applyTransformationNoWrap(array $options = [])

Enables no-wrapping

Parameters

array $options transformation options

Return Value

void

at line 74
string applyTransformation(string $buffer, array $options = [], stdClass|null $meta = null)

Does the actual work of each specific transformations plugin.

Parameters

string $buffer text to be transformed
array $options transformation options
stdClass|null $meta meta information

Return Value

string the transformed text

in TransformationsPlugin at line 55
array getOptions(array $options, array $defaults)

Returns passed options or default values if they were not set

Parameters

array $options List of passed options
array $defaults List of default values

Return Value

array List of options possibly filled in by defaults.

at line 27
static string getInfo()

Gets the transformation description of the specific plugin

Return Value

string

at line 155
static string getName()

Gets the transformation name of the specific plugin

Return Value

string