Base class for all filters. More...
#include <cutelee/filter.h>
Public Member Functions | |
| virtual | ~Filter () |
| SafeString | conditionalEscape (const SafeString &input) const |
| virtual QVariant | doFilter (const QVariant &input, const QVariant &argument={}, bool autoescape={}) const =0 |
| SafeString | escape (const QString &input) const |
| SafeString | escape (const SafeString &input) const |
| virtual bool | isSafe () const |
Detailed Description
The Filter class can be implemented in plugin libraries to make additional functionality available to templates.
Developers are required only to implement the doFilter method and integrate the filter as part of a custom plugin, but will never create or access filters directly in application code.
The FilterExpression class is the access interface to a chain of Filter objects.
The escape and conditionalEscape methods are available for escaping data where needed.
- See also
- Filters
Constructor & Destructor Documentation
◆ ~Filter()
|
virtual |
Destructor.
Definition at line 6 of file filter.cpp.
Member Function Documentation
◆ conditionalEscape()
| SafeString Filter::conditionalEscape | ( | const SafeString & | input | ) | const |
Escapes input if not already safe from further escaping and returns it. The OutputStream::escape method is used to escape input.
Definition at line 22 of file filter.cpp.
References Cutelee::SafeString::isSafe().
Referenced by JoinFilter::doFilter(), LineBreaksBrFilter::doFilter(), and LineBreaksFilter::doFilter().
◆ doFilter()
|
pure virtual |
Reimplement to filter input given argument.
autoescape determines whether the autoescape feature is currently on or off. Most filters will not use this.
- See also
- Autoescaping and safe-ness
Implemented in AddFilter, AddSlashesFilter, CapFirstFilter, CenterFilter, CutFilter, DateFilter, DefaultFilter, DefaultIfNoneFilter, DictSortFilter, DivisibleByFilter, EscapeFilter, EscapeJsFilter, FileSizeFormatFilter, FirstFilter, FixAmpersandsFilter, FloatFormatFilter, ForceEscapeFilter, GetDigitFilter, JoinFilter, LastFilter, LengthFilter, LengthIsFilter, LineBreaksBrFilter, LineBreaksFilter, LineNumbersFilter, LJustFilter, LowerFilter, MakeListFilter, RandomFilter, RemoveTagsFilter, RJustFilter, SafeFilter, SafeSequenceFilter, ScriptableFilter, SliceFilter, SlugifyFilter, StringFormatFilter, StripTagsFilter, TimeFilter, TimeSinceFilter, TimeUntilFilter, TitleFilter, TruncateCharsFilter, TruncateWordsFilter, UnorderedListFilter, UpperFilter, WordCountFilter, WordWrapFilter, and YesNoFilter.
◆ escape() [1/2]
| SafeString Filter::escape | ( | const QString & | input | ) | const |
Escapes and returns input. The OutputStream::escape method is used to escape input.
Definition at line 10 of file filter.cpp.
Referenced by EscapeJsFilter::doFilter(), ForceEscapeFilter::doFilter(), and LineNumbersFilter::doFilter().
◆ escape() [2/2]
| SafeString Filter::escape | ( | const SafeString & | input | ) | const |
Escapes and returns input. The OutputStream::escape method is used to escape input.
Definition at line 15 of file filter.cpp.
References Cutelee::SafeString::IsSafe, and Cutelee::SafeString::isSafe().
◆ isSafe()
|
virtual |
Reimplement to return whether this filter is safe.
Reimplemented in AddSlashesFilter, CapFirstFilter, CenterFilter, DictSortFilter, EscapeFilter, FileSizeFormatFilter, FixAmpersandsFilter, FloatFormatFilter, ForceEscapeFilter, JoinFilter, LengthFilter, LengthIsFilter, LineBreaksBrFilter, LineBreaksFilter, LineNumbersFilter, LJustFilter, LowerFilter, MakeListFilter, RandomFilter, RJustFilter, SafeFilter, SafeSequenceFilter, ScriptableFilter, SliceFilter, SlugifyFilter, StringFormatFilter, TitleFilter, TruncateCharsFilter, TruncateWordsFilter, UnorderedListFilter, UpperFilter, WordCountFilter, and WordWrapFilter.
Definition at line 29 of file filter.cpp.
