Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/search/classes/ -> area_category.php (source)

[Source view]

Search area category.

Copyright: Dmitrii Metelkin <dmitriim@catalyst-au.net>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 126 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

area_category:: (6 methods):
  __construct()
  get_name()
  get_visiblename()
  get_order()
  get_areas()
  set_areas()


Class: area_category  - X-Ref

Search area category.

__construct(string $name, string $visiblename, int $order = 0, array $areas = [])   X-Ref
Constructor.

param: string $name Unique name of the category.
param: string $visiblename Visible name of the category.
param: int $order Category position in the list (smaller numbers will be displayed first).
param: \core_search\base[] $areas A list of search areas associated with this category.

get_name()   X-Ref
Get name.

return: string

get_visiblename()   X-Ref
Get visible name.

return: string

get_order()   X-Ref
Get order to display.

return: int

get_areas()   X-Ref
Return a keyed by area id list of areas for this category.

return: \core_search\base[]

set_areas(array $areas)   X-Ref
Set list of search areas for this category,

param: \core_search\base[] $areas