1. interface
  2. PhpMyAdmin
  3. \
  4. Plugins
  5. \
  6. TransformationsInterface

TransformationsInterface

interface TransformationsInterface (View source)

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

Methods

static string
getInfo()

Gets the transformation description

static string
getMIMEType()

Gets the specific MIME type

static string
getMIMESubtype()

Gets the specific MIME subtype

static string
getName()

Gets the transformation name of the specific plugin

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

Does the actual work of each specific transformations plugin.

bool
applyTransformationNoWrap(array $options = [])

Returns true if the element requires no wrapping

Details

at line 21
static string getInfo()

Gets the transformation description

Return Value

string

at line 26
static string getMIMEType()

Gets the specific MIME type

Return Value

string

at line 31
static string getMIMESubtype()

Gets the specific MIME subtype

Return Value

string

at line 36
static string getName()

Gets the transformation name of the specific plugin

Return Value

string

at line 47
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

at line 58
bool applyTransformationNoWrap(array $options = [])

Returns true if the element requires no wrapping

Parameters

array $options

transformation options

Return Value

bool