abstract class ExternalTransformationsPlugin extends TransformationsPlugin (View source)

Provides common methods for all of the external transformations plugins.

Methods

bool
applyTransformationNoWrap(array $options = [])

Enables no-wrapping

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

static string
getInfo()

Gets the transformation description of the specific plugin

static string
getName()

Gets the transformation name of the specific plugin

Details

bool applyTransformationNoWrap(array $options = [])

Enables no-wrapping

Parameters

array $options

transformation options

Return Value

bool

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.

static string getInfo()

Gets the transformation description of the specific plugin

Return Value

string

static string getName()

Gets the transformation name of the specific plugin

Return Value

string