IOTransformationsPlugin
abstract class IOTransformationsPlugin extends TransformationsPlugin (View source)
Provides a common interface that will have to be implemented by all of the Input/Output transformations plugins.
Properties
| protected bool | $success | Specifies whether transformation was successful or not. |
|
| protected string | $error | To store the error message in case of failed transformations. |
Methods
Returns true if the element requires no wrapping
Returns passed options or default values if they were not set
Returns the html for input field to override default textarea.
Returns the array of scripts (filename) required for plugin initialization and handling
Returns the error message
Returns the success status
Resets the object properties
Details
bool
applyTransformationNoWrap(array $options = [])
Returns true if the element requires no wrapping
array
getOptions(array $options, array $defaults)
Returns passed options or default values if they were not set
string
getInputHtml(string $columnNameAppendix, array $options, string $value, int $fieldIndex)
Returns the html for input field to override default textarea.
Note: Return empty string if default textarea is required.
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