CRM_Core_Menu

class CRM_Core_Menu

Class CRM_Core_Menu.

Constants

MENU_ITEM

Properties

static array $_items The list of menu items.
static array $_permissionedItems The list of permissioned menu items.
static $_serializedElements
static $_menuCache

Methods

static array
xmlItems(bool $fetchFromXML = FALSE)

This function fetches the menu items from xml and xmlMenu hooks.

static 
read(string $name, array $menu)

Read menu.

static 
readXML(SimpleXMLElement $xml, array $menu)

No description

static array
items(bool $fetchFromXML = FALSE)

This function defines information for various menu items.

static bool
isArrayTrue(array $values)

Is array true (whatever that means!).

static 
fillMenuValues(array $menu, string $path)

Fill menu values.

static 
build(array $menu)

We use this function to.

static 
store(bool $truncate = TRUE)

This function recomputes menu from xml and populates civicrm_menu.

static 
buildAdminLinks(array $menu)

Build admin links.

static null
getAdminLinks()

Get admin links.

static array
buildBreadcrumb(array $menu, string $path)

Get the breadcrumb for a given path.

static 
buildReturnUrl($menu, $path)

No description

static array
getReturnUrl($menu, $path)

No description

static 
fillComponentIds($menu, $path)

No description

static array
get($path)

No description

static mixed
getArrayForPathArgs($pathArgs)

No description

Details

at line 75
static array xmlItems(bool $fetchFromXML = FALSE)

This function fetches the menu items from xml and xmlMenu hooks.

Parameters

bool $fetchFromXML Fetch the menu items from xml and not from cache.

Return Value

array

at line 114
static read(string $name, array $menu)

Read menu.

Parameters

string $name File name
array $menu An alterable list of menu items.

Exceptions

Exception

at line 125
static readXML(SimpleXMLElement $xml, array $menu)

Parameters

SimpleXMLElement $xml An XML document defining a list of menu items.
array $menu An alterable list of menu items.

at line 197
static array items(bool $fetchFromXML = FALSE)

This function defines information for various menu items.

Parameters

bool $fetchFromXML Fetch the menu items from xml and not from cache.

Return Value

array

at line 208
static bool isArrayTrue(array $values)

Is array true (whatever that means!).

Parameters

array $values

Return Value

bool

at line 225
static fillMenuValues(array $menu, string $path)

Fill menu values.

Parameters

array $menu
string $path

Exceptions

Exception

at line 279
static build(array $menu)

We use this function to.

  1. Compute the breadcrumb
  2. Compute local tasks value if any
  3. Propagate access argument, access callback, page callback to the menu item
  4. Build the global navigation block

Parameters

array $menu

at line 300
static store(bool $truncate = TRUE)

This function recomputes menu from xml and populates civicrm_menu.

Parameters

bool $truncate

Build admin links.

Parameters

array $menu

Get admin links.

Return Value

null

at line 433
static array buildBreadcrumb(array $menu, string $path)

Get the breadcrumb for a given path.

Parameters

array $menu An array of all the menu items.
string $path Path for which breadcrumb is to be build.

Return Value

array The breadcrumb for this path

at line 481
static buildReturnUrl($menu, $path)

Parameters

$menu
$path

at line 493
static array getReturnUrl($menu, $path)

Parameters

$menu
$path

Return Value

array

at line 521
static fillComponentIds($menu, $path)

Parameters

$menu
$path

at line 561
static array get($path)

Parameters

$path string Path of menu item to retrieve.

Return Value

array Menu entry array.

at line 659
static mixed getArrayForPathArgs($pathArgs)

Parameters

$pathArgs

Return Value

mixed