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.
/lib/ -> searchlib.php (source)

[Source view]

Differences Between: [Versions 39 and 311] [Versions 39 and 400] [Versions 39 and 401] [Versions 39 and 402] [Versions 39 and 403]

(no description)

Copyright: 1999 onwards Martin Dougiamas {@link http://moodle.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 516 lines (18 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 5 classes

search_token:: (2 methods):
  __construct()
  search_token()

name:: (3 methods):
  sanitize()
  getValue()
  getType()

search_lexer:: (2 methods):
  __construct()
  search_lexer()

name:: (3 methods):
  sanitize()
  getValue()
  getType()

search_parser:: (15 methods):
  get_parsed_array()
  accept()
  indatefrom()
  indateto()
  intags()
  ininstance()
  inuserid()
  inusername()
  inmeta()
  inrequired()
  inexcluded()
  inquotedstring()
  plainstring()
  search_generate_text_SQL()
  search_generate_SQL()


Class: search_token  - X-Ref

Class to hold token/value pairs after they're parsed.

__construct($type,$value)   X-Ref
No description

search_token($type, $value)   X-Ref
Old syntax of class constructor. Deprecated in PHP7.


Class: name  - X-Ref

sanitize($userstring)   X-Ref
No description

getValue()   X-Ref
No description

getType()   X-Ref
No description

Class: search_lexer  - X-Ref

This class does the heavy lifting of lexing the search string into tokens.
Using a full-blown lexer is probably overkill for this application, but
might be useful for other tasks.

__construct(&$parser)   X-Ref
No description

search_lexer(&$parser)   X-Ref
Old syntax of class constructor. Deprecated in PHP7.


Class: name  - X-Ref

sanitize($userstring)   X-Ref
No description

getValue()   X-Ref
No description

getType()   X-Ref
No description

Class: search_parser  - X-Ref

This class takes care of sticking the proper token type/value pairs into
the parsed token  array.
Most functions in this class should only be called by the lexer, the
one exception being getParseArray() which returns the result.

get_parsed_array()   X-Ref
No description

accept()   X-Ref
No description

indatefrom($content)   X-Ref
No description

indateto($content)   X-Ref
No description

intags($content)   X-Ref
No description

ininstance($content)   X-Ref
No description

inuserid($content)   X-Ref
No description

inusername($content)   X-Ref
No description

inmeta($content)   X-Ref
No description

inrequired($content)   X-Ref
No description

inexcluded($content)   X-Ref
No description

inquotedstring($content)   X-Ref
No description

plainstring($content)   X-Ref
No description

search_generate_text_SQL($parsetree, $datafield, $metafield, $mainidfield, $useridfield,$userfirstnamefield, $userlastnamefield, $timefield, $instancefield)   X-Ref
Primitive function to generate a SQL string from a parse tree
using TEXT indexes. If searches aren't suitable to use TEXT
this function calls the default search_generate_SQL() one.


search_generate_SQL($parsetree, $datafield, $metafield, $mainidfield, $useridfield,$userfirstnamefield, $userlastnamefield, $timefield, $instancefield,$tagfields = [])   X-Ref
Primitive function to generate a SQL string from a parse tree.
Parameters:

$parsetree should be a parse tree generated by a
search_lexer/search_parser combination.
Other fields are database table names to search.