NavigationGroups
in package
Menu groups for front end main navigation
Table of Contents
Properties
- $extras : mixed
- $fallback_names : mixed
- $names : mixed
Methods
- getAllExtrasAdmin() : mixed
- Get all extras, grouped by top parent page id ADMIN ONLY METHOD
- getAllGroupsAdmin() : mixed
- Get all group details, grouped by top parent page id ADMIN ONLY METHOD
- getAllNames() : mixed
- Returns an array of position -> name for all groups for a page
- getAllNamesAdmin() : mixed
- Get all group names, grouped by top parent page id ADMIN ONLY METHOD
- getExtras() : array<string|int, mixed>
- Return an array of extra menu details for a top-level nav items
- getGroupsAdmin() : array<string|int, mixed>
- Return an array of group names to use for a given top parent ADMIN ONLY METHOD
- getId() : mixed
- Return the group id for a given page and position
- getItems() : mixed
- Return an array of Treenode instances for the items in this group
- getName() : mixed
- Return the group name for a given page and position
- loadGroupNames() : mixed
Properties
$extras
private
static mixed
$extras
= array()
$fallback_names
private
static mixed
$fallback_names
= array(1 => 'One', 2 => 'Two', 3 => 'Three', 4 => 'Four', 5 => 'Five', 6 => 'Six', 7 => 'Seven')
$names
private
static mixed
$names
= array()
Methods
getAllExtrasAdmin()
Get all extras, grouped by top parent page id ADMIN ONLY METHOD
public
static getAllExtrasAdmin() : mixed
getAllGroupsAdmin()
Get all group details, grouped by top parent page id ADMIN ONLY METHOD
public
static getAllGroupsAdmin() : mixed
getAllNames()
Returns an array of position -> name for all groups for a page
public
static getAllNames(mixed $page_id) : mixed
Parameters
- $page_id : mixed
getAllNamesAdmin()
Get all group names, grouped by top parent page id ADMIN ONLY METHOD
public
static getAllNamesAdmin() : mixed
getExtras()
Return an array of extra menu details for a top-level nav items
public
static getExtras(int $page_id) : array<string|int, mixed>
Return keys: text Description image Image filename
Parameters
- $page_id : int
-
Top-level page ID
Return values
array<string|int, mixed>getGroupsAdmin()
Return an array of group names to use for a given top parent ADMIN ONLY METHOD
public
static getGroupsAdmin(int $page_id) : array<string|int, mixed>
Parameters
- $page_id : int
-
The top-parent page id
Return values
array<string|int, mixed> —Group IDs and names
getId()
Return the group id for a given page and position
public
static getId(mixed $page_id, mixed $position) : mixed
Parameters
- $page_id : mixed
- $position : mixed
getItems()
Return an array of Treenode instances for the items in this group
public
static getItems(mixed $page_id, mixed $position[, mixed $limit = null ]) : mixed
Parameters
- $page_id : mixed
- $position : mixed
- $limit : mixed = null
getName()
Return the group name for a given page and position
public
static getName(mixed $page_id, mixed $position) : mixed
Parameters
- $page_id : mixed
- $position : mixed
loadGroupNames()
private
static & loadGroupNames([mixed $subsite_id = null ]) : mixed
Parameters
- $subsite_id : mixed = null