Class representing a string filter.
More...
|
| add_filter_value ($value) |
| Add a value to the filter.
|
|
| count () |
| Return the number of contexts.
|
|
| current () |
| Return the current filter value.
|
|
| get_filter_values () |
| Return the current filter values.
|
|
| get_join_type () |
| Return the currently specified join type.
|
|
| get_name () |
| Return the name of the filter.
|
|
| jsonSerialize () |
| Serialize filter.
|
|
| key () |
| Returns the current position of the iterator.
|
|
| next () |
| Move to the next value in the list.
|
|
| reset_iterator () |
| Reset the iterator position.
|
|
| rewind () |
| Rewind the Iterator position to the start.
|
|
| set_join_type (int $jointype) |
| Specify the type of join to employ for the filter.
|
|
| valid () |
| Check if the current position is valid.
|
|
|
int const | JOINTYPE_ALL = 2 |
| All of the following match.
|
|
int const | JOINTYPE_ANY = 1 |
| Any of the following match.
|
|
int const | JOINTYPE_DEFAULT = 1 |
| The default filter type (ANY)
|
|
int const | JOINTYPE_NONE = 0 |
| None of the following match.
|
|
|
| sort_filter_values () |
| Sort the filter values to ensure reliable, and consistent output.
|
|
|
array | $filtervalues = [] |
| The list of active filter values.
|
|
int | $iteratorposition = null |
| The current iterator position.
|
|
int | $jointype = self::JOINTYPE_DEFAULT |
| The join type currently in use.
|
|
int[] | $jointypes |
| valid join types
|
|
string | $name = null |
| The name of this filter.
|
|
Class representing a string filter.
- Copyright
- 2020 Simey Lameze simey.nosp@m.@moo.nosp@m.dle.c.nosp@m.om
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ add_filter_value()
core_table\local\filter\string_filter::add_filter_value |
( |
| $value | ) |
|
◆ count()
core_table\local\filter\filter::count |
( |
| ) |
|
|
inherited |
Return the number of contexts.
- Return values
-
◆ get_filter_values()
core_table\local\filter\filter::get_filter_values |
( |
| ) |
|
|
inherited |
Return the current filter values.
- Return values
-
◆ get_join_type()
core_table\local\filter\filter::get_join_type |
( |
| ) |
|
|
inherited |
Return the currently specified join type.
- Return values
-
◆ get_name()
core_table\local\filter\filter::get_name |
( |
| ) |
|
|
inherited |
Return the name of the filter.
- Return values
-
◆ jsonSerialize()
core_table\local\filter\filter::jsonSerialize |
( |
| ) |
|
|
inherited |
Serialize filter.
- Return values
-
◆ key()
core_table\local\filter\filter::key |
( |
| ) |
|
|
inherited |
Returns the current position of the iterator.
- Return values
-
◆ set_join_type()
core_table\local\filter\filter::set_join_type |
( |
int | $jointype | ) |
|
|
inherited |
Specify the type of join to employ for the filter.
- Parameters
-
int | $jointype | The join type to use using one of the supplied constants |
- Return values
-
◆ valid()
core_table\local\filter\filter::valid |
( |
| ) |
|
|
inherited |
Check if the current position is valid.
- Return values
-
◆ $jointypes
int [] core_table\local\filter\filter::$jointypes |
|
protectedinherited |
Initial value:= [
]
int const JOINTYPE_ALL
All of the following match.
Definition filter.php:54
int const JOINTYPE_ANY
Any of the following match.
Definition filter.php:51
int const JOINTYPE_NONE
None of the following match.
Definition filter.php:48
valid join types
The documentation for this class was generated from the following file:
- lib/table/classes/local/filter/string_filter.php