| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Source view] [Print] [Project Stats]
Search base class to be extended by search areas.
| Copyright: | 2015 David Monllao {@link http://www.davidmonllao.com} |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 292 lines (10 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| __construct() X-Ref |
| Constructor. return: void |
| get_levels() X-Ref |
| Returns context levels property. return: int |
| get_area_id() X-Ref |
| Returns the area id. return: string |
| get_component_name() X-Ref |
| Returns the moodle component name. It might be the plugin name (whole frankenstyle name) or the core subsystem name. return: string |
| get_component_type() X-Ref |
| Returns the component type. It might be a plugintype or 'core' for core subsystems. return: string |
| get_visible_name($lazyload = false) X-Ref |
| Returns the area visible name. param: bool $lazyload Usually false, unless when in admin settings. return: string |
| get_config_var_name() X-Ref |
| Returns the config var name. It depends on whether it is a moodle subsystem or a plugin as plugin-related config should remain in their own scope. return: string Config var path including the plugin (or component) and the varname |
| get_config() X-Ref |
| Returns all the search area configuration. return: array |
| is_enabled() X-Ref |
| Is the search component enabled by the system administrator? return: bool |
| set_enabled($isenabled) X-Ref |
| No description |
| uses_file_indexing() X-Ref |
| Returns true if this area uses file indexing. return: bool |
| attach_files($document) X-Ref |
| Add any files to the document that should be indexed. param: document $document The current document return: void |
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |