[DOCU-579] Document not clear on the requirement of custom filter having to extend MgnlFilter Created: 11/Sep/15 Updated: 15/Sep/15 Resolved: 14/Sep/15 |
|
| Status: | Closed |
| Project: | Documentation |
| Component/s: | content |
| Affects Version/s: | short term, mid term, long term |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Neutral |
| Reporter: | Martin Ma | Assignee: | Christoph Meier |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | customization, documentation,, filter | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Description |
|
On https://documentation.magnolia-cms.com/display/DOCS/Request+processing+and+filters#Requestprocessingandfilters-Extensionpoints, the table does hint that AbstractMgnlFilter can be extended but the requirement for such extension is obscure. Something like "custom filters must extend AbstractMgnlFilter" or "custom filters must implement MgnlFilter" in the document would be much clearer to developers. I basically spent quite some time trying and couldn't figure out why the configuration workspace wouldn't successfully add my custom filter into Magnolia's filter chain. So it turned out that they must implement MgnlFilter. This is the reason for raising an improvement on the document. |
| Comments |
| Comment by Christoph Meier [ 14/Sep/15 ] |
|
Please also read forum post about filter configuration: it provides another approach how filters are added to the Magnolia filter chain without implementing MgnlFilter. However i document now the 2 approaches on documentation |
| Comment by Christoph Meier [ 14/Sep/15 ] |
|
See https://documentation.magnolia-cms.com/display/DOCS/Custom+filters |
| Comment by Martin Ma [ 15/Sep/15 ] |
|
Hi Christoph, It's much clearer now. Thanks for the prompt response & enhanced documentation. |