abstract class TransformationsPlugin implements TransformationsInterface

Provides a common interface that will have to be implemented by all of the transformations plugins.

Methods

void
applyTransformationNoWrap(array $options = [])

Does the actual work of each specific transformations plugin.

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

Details

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

Does the actual work of each specific transformations plugin.

Parameters

array $options transformation options

Return Value

void

at line 41
abstract 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

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.