model/modx/filters/modinputfilter.class.php
- package
- modx
- subpackage
- filters
- Classes
- modInputFilter
Description
Provides the default input filter implementation for modElement processing.
\modInputFilter
- package
- modx
- subpackage
- filters
- Properties
- $_commands
- $_modifiers
- $modx
- Methods
- __construct
- filter
- getCommands
- getModifiers
- hasCommands
Description
Base input filter implementation for modElement processing, based on phX.
Properties
$_commands
array $_commands = 'null'
Details
- array
An array of filter commands. - visibility
- private
- default
- null
- final
- false
- static
- false
$_modifiers
array $_modifiers = 'null'
Details
- array
An array of filter modifiers. - visibility
- private
- default
- null
- final
- false
- static
- false
$modx
Methods
__construct
__construct(
\modX $modx
)
:
Constructor for modInputFilter
Arguments
- $modx
- \modX
A reference to the modX instance.
Details
- visibility
- public
- final
- false
- static
- false
filter
filter(
\modElement $element
)
:
Filters a modElement before it is processed.
Arguments
- $element
- \modElement
&$element The element to apply filtering to.
Details
- visibility
- public
- final
- false
- static
- false
getCommands
getCommands(
)
:
array|nullReturns a list of filter input commands to be applied through output filtering.
Output
- array|null
- An array of filter commands or null if no commands exist.
Details
- visibility
- public
- final
- false
- static
- false
getModifiers
getModifiers(
)
:
array|nullReturns a list of filter input modifiers corresponding to the input commands.
Output
- array|null
- An array of filter modifiers for corresponding commands.
Details
- visibility
- public
- final
- false
- static
- false
hasCommands
hasCommands(
)
:
booleanIndicates if the element has any input filter commands.
Output
- boolean
- True if the input filter has commands to execute.
Details
- visibility
- public
- final
- false
- static
- false