Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Advanced Tables - Table Plus
heading0
enableHeadingAttributesfalse
enableSortingfalse
classm5-configuration-tree
enableHighlightingfalse

Node name


Mgnl f
filters


Mgnl f
anotherFilter


Mgnl p
class

info.magnolia.cms.filters.FilterDecorator

Mgnl n
decoratedFilter


Mgnl p
class

info.magnolia.documentation.examples.templates.AnotherFilter

Mgnl n
config


Mgnl p
myInitParam

some value

class

required

In this case class must be info.magnolia.cms.filters.FilterDecorator.

decoratedFilter

required

class

required

The fully qualified class name of your custom filter (which does not implement

Javadoc
0info.magnolia.cms.filters.AbstractMgnlFilter
).

config

optional

A map to add filter init parameters. You may add as many parameters as required. The init parameters can be read in the init method of the filter (see below).

...

Filters are executed in the order they are in the chain, from top to bottom. If you do not care about execution order, you can skip this section, otherwise make sure the filter is in the right position in the chain. 

Magnolia provides task classes to adapt the order of the filter via module version handler. Use 

Javadoc resource link
rangeHigherVersion5.7
classNameinfo.magnolia.module.delta.FilterOrderingTask
renderTypeasynchronous
 or 
Javadoc resource link
rangeHigherVersion5.7
classNameinfo.magnolia.module.delta.OrderFilterBeforeTask
renderTypeasynchronous
. The code example below is using the FilterOrderingTask.

Anchor
anc-moduleVersionHandler-to-change-filterPosition
anc-moduleVersionHandler-to-change-filterPosition
 When When installing a module, you can define the position with ModuleVersionHandler#getExtraInstallTasks.

...