Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/search/classes/output/ -> renderer.php (source)

[Source view]

Differences Between: [Versions 310 and 400] [Versions 311 and 400] [Versions 39 and 400]

Search renderer.

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

Defines 1 class

renderer:: (5 methods):
  render_results()
  render_top_results()
  render_result()
  render_search_disabled()
  render_index_requests_info()


Class: renderer  - X-Ref

Search renderer.

render_results($results, $page, $totalcount, $url, $cat = null)   X-Ref
Renders search results.

return: string HTML
param: \core_search\document[] $results
param: int $page Zero based page number.
param: int $totalcount Total number of results available.
param: \moodle_url $url
param: \core_search\area_category|null $cat Selected search are category or null if category functionality is disabled.

render_top_results($results)   X-Ref
Top results content

return: string content of the top result section
param: \core_search\document[] $results Search Results

render_result(\core_search\document $doc)   X-Ref
Displaying search results.

return: string HTML
param: \core_search\document Containing a single search response to be displayed.a

render_search_disabled()   X-Ref
Returns a box with a search disabled lang string.

return: string HTML

render_index_requests_info(\stdClass $info)   X-Ref
Returns information about queued index requests.

return: string HTML
param: \stdClass $info Info object from get_index_requests_info