abstract class TransformationsPlugin implements TransformationsInterface (View source)

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

Methods

bool
applyTransformationNoWrap(array $options = [])

Does the actual work of each specific transformations plugin.

string
applyTransformation(string $buffer, array $options = [], FieldMetadata|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

bool applyTransformationNoWrap(array $options = [])

Does the actual work of each specific transformations plugin.

Parameters

array $options

transformation options

Return Value

bool

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

Does the actual work of each specific transformations plugin.

Parameters

string $buffer

text to be transformed

array $options

transformation options

FieldMetadata|null $meta

meta information

Return Value

string

the transformed text

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.