Category filter.
Copyright: | 2017 The Open University |
License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
File Size: | 98 lines (3 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
category:: (4 methods):
get_filter_name()
get_filter_options()
filter_matches()
check_contexts()
get_filter_name() X-Ref |
The name of the filter. return: string |
get_filter_options() X-Ref |
Retrieve the list of available filter options. return: array An array whose keys are the valid options |
filter_matches(tour $tour, context $context) X-Ref |
Check whether the filter matches the specified tour and/or context. param: tour $tour The tour to check param: context $context The context to check return: boolean |
check_contexts(context $context, $values) X-Ref |
Recursive function allows checking of parent categories. param: context $context param: array $values return: boolean |