core/model/modx/filters/modinputfilter.class.php

Show:

inherited

Table of Contents

Provides the default input filter implementation for modElement processing.

\modInputFilter
jump to top

Package: modx\filters

Base input filter implementation for modElement processing, based on phX.

array
                 $_commands= 'null'

An array of filter commands.

Default valuenullDetails

array
                 $_modifiers= 'null'

An array of filter modifiers.

Default valuenullDetails

\modX
                 $modx= 'null'

A reference to the modX instance.

Default valuenullDetails

__construct(
          \modX $modx
          )
        
        :
          void

Constructor for modInputFilter

Parameters

Name	Type	Description
$modx	\modX	A reference to the modX instance.

filter(
          \modElement $element
          )
        
        :
          void

Filters a modElement before it is processed.

Parameters

Name	Type	Description
$element	\modElement	&$element The element to apply filtering to.

getCommands(
          
          )
        
        :
          array | null

Returns a list of filter input commands to be applied through output filtering.

Returns

Type	Description
array \| null	An array of filter commands or null if no commands exist.

getModifiers(
          
          )
        
        :
          array | null

Returns a list of filter input modifiers corresponding to the input commands.

Returns

Type	Description
array \| null	An array of filter modifiers for corresponding commands.

hasCommands(
          
          )
        
        :
          boolean

Indicates if the element has any input filter commands.

Returns

Type	Description
boolean	True if the input filter has commands to execute.