Class Navigation
-
Model
-
AppModel
-
Navigation
Methods summary
public
|
#
__construct( )
Initialize Navigation
Overrides
|
public
array
|
#
getPrimary( string $base_uri )
Retrieves the primary navigation
Retrieves the primary navigation
Parameters
- $base_uri
string $base_uri The base_uri for the currently logged in user
Returns
array An array of main navigation elements in key/value pairs where each key is the
URI and each value is an array representing that element including: - name The
name of the link - active True if the element is active - sub An array of subnav
elements (optional) following the same indexes as above
|
public
array
|
#
getPrimaryClient( string $base_uri )
Retrieves the primary navigation for the client interface
Retrieves the primary navigation for the client interface
Parameters
- $base_uri
string $base_uri The base_uri for the currently logged in user
Returns
array An array of main navigation elements in key/value pairs where each key is the
URI and each value is an array representing that element including: - name The
name of the link - active True if the element is active - sub An array of subnav
elements (optional) following the same indexes as above
|
public
array
|
#
getCompany( string $base_uri )
Retrieves the navigation for company settings
Retrieves the navigation for company settings
Parameters
- $base_uri
string $base_uri The base_uri for the currently logged in user
Returns
array A numerically-indexed array of the company settings navigation where each
element contains an array which includes: - name The name of the element - class
The CSS class name for the element - uri The URI for the element - children An
array of child elements which follow the same indexes as above
|
public
array
|
#
getSystem( string $base_uri )
Retrieves the navigation for system settings
Retrieves the navigation for system settings
Parameters
- $base_uri
string $base_uri The base_uri for the currently logged in user
Returns
array A numerically-indexed array of the system settings navigation where each element
contains an array which includes: - name The name of the element - class The CSS
class name for the element - uri The URI for the element - children An array of
child elements which follow the same indexes as above
|
public
array
|
#
getSearchOptions( )
Fetches all search options available to the current company
Fetches all search options available to the current company
Returns
array An array of search items in key/value pairs, where each key is the search type
and each value is the language for the search type
|
public
array
|
#
getPluginNav( string $location )
Returns all plugin navigation for the requested location
Returns all plugin navigation for the requested location
Parameters
- $location
string $location The location to fetch plugin navigation for
Returns
array An array of plugin navigation
|
Methods inherited from AppModel
_()
,
boolToInt()
,
currencyToDecimal()
,
dateToUtc()
,
errors()
,
getPerPage()
,
ifSet()
,
loadCrypto()
,
setDefaultIfEmpty()
,
setPerPage()
,
setRulesIfSet()
,
strToBool()
,
systemDecrypt()
,
systemEncrypt()
,
systemHash()
,
truncateDecimal()
,
validateExists()
,
validateStateCountry()
Methods inherited from Model
affectedRows()
,
begin()
,
commit()
,
getConnection()
,
lastInsertId()
,
makeDSN()
,
prepare()
,
query()
,
rollBack()
,
setAttribute()
,
setFetchMode()
Magic methods summary
Properties summary
Properties inherited from AppModel
$replacement_keys