core_search\area_category Class Reference

Search area category. More...

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

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.

Copyright

Dmitrii Metelkin dmitr.nosp@m.iim@.nosp@m.catal.nosp@m.yst-.nosp@m.au.ne.nosp@m.t

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	$name	Unique name of the category.
string	$visiblename	Visible name of the category.
int	$order	Category position in the list (smaller numbers will be displayed first).
core_search\base[]	$areas	A 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

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:

• search/classes/area_category.php