Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Search documents factory.

Copyright: 2015 David Monllao {@link http://www.davidmonllao.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 84 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

document_factory:: (2 methods):
  instance()
  clean_static()


Class: document_factory  - X-Ref

Search document factory.

instance($itemid, $componentname, $areaname, $engine = false)   X-Ref
Returns the appropiate document object as it depends on the engine.

param: int $itemid Document itemid
param: string $componentname Document component name
param: string $areaname Document area name
param: \core_search\engine $engine Falls back to the search engine in use.
return: \core_search\document Base document or the engine implementation.

clean_static()   X-Ref
Clears static vars.

return: void