Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_search\area_category Class Reference

Search area category. More...

Public Member Functions

 __construct (string $name, string $visiblename, int $order=0, array $areas=[])
 Constructor.
 
 get_areas ()
 Return a keyed by area id list of areas for this category.
 
 get_name ()
 Get name.
 
 get_order ()
 Get order to display.
 
 get_visiblename ()
 Get visible name.
 
 set_areas (array $areas)
 Set list of search areas for this category,.
 

Protected Attributes

core_search base[] $areas = []
 Category areas.
 
string $name
 Category name.
 
int $order = 0
 Category order.
 
string $visiblename
 Category visible name.
 

Detailed Description

Search area category.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

core_search\area_category::__construct ( string $name,
string $visiblename,
int $order = 0,
array $areas = [] )

Constructor.

Parameters
string$nameUnique name of the category.
string$visiblenameVisible name of the category.
int$orderCategory position in the list (smaller numbers will be displayed first).
core_search\base[]$areasA list of search areas associated with this category.

Member Function Documentation

◆ get_areas()

core_search\area_category::get_areas ( )

Return a keyed by area id list of areas for this category.

Return values
core_search\base[]

◆ get_name()

core_search\area_category::get_name ( )

Get name.

Return values
string

◆ get_order()

core_search\area_category::get_order ( )

Get order to display.

Return values
int

◆ get_visiblename()

core_search\area_category::get_visiblename ( )

Get visible name.

Return values
string

◆ set_areas()

core_search\area_category::set_areas ( array $areas)

Set list of search areas for this category,.

Parameters
core_search\base[]$areas

The documentation for this class was generated from the following file: