abstract class RegexValidationTransformationsPlugin extends IOTransformationsPlugin (View source)

Provides common methods for all of the regex validation input transformations plugins.

Properties

protected bool $success

Specifies whether transformation was successful or not.

from  IOTransformationsPlugin
protected string $error

To store the error message in case of failed transformations.

from  IOTransformationsPlugin

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

string
getInputHtml(array $column, int $row_id, string $column_name_appendix, array $options, string $value, string $text_dir, int $tabindex, int $tabindex_for_value, int $idindex)

Returns the html for input field to override default textarea.

array
getScripts()

Returns the array of scripts (filename) required for plugin initialization and handling

string
getError()

Returns the error message

bool
isSuccess()

Returns the success status

void
reset()

Resets the object properties

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 = [])

Does the actual work of each specific transformations plugin.

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.

string getInputHtml(array $column, int $row_id, string $column_name_appendix, array $options, string $value, string $text_dir, int $tabindex, int $tabindex_for_value, int $idindex)

Returns the html for input field to override default textarea.

Note: Return empty string if default textarea is required.

Parameters

array $column

column details

int $row_id

row number

string $column_name_appendix

the name attribute

array $options

transformation options

string $value

Current field value

string $text_dir

text direction

int $tabindex

tab index

int $tabindex_for_value

offset for the values tabindex

int $idindex

id index

Return Value

string

the html for input field

array getScripts()

Returns the array of scripts (filename) required for plugin initialization and handling

Return Value

array

javascripts to be included

string getError()

Returns the error message

Return Value

string error

bool isSuccess()

Returns the success status

Return Value

bool

void reset()

Resets the object properties

Return Value

void

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