CRUDKit Developer API Doc v1.0.0-beta.2
\
Alddesign
Crudkit
Classes
Controllers

\Alddesign\Crudkit\ClassesPageStore

Object to store an access all the pages (bundeling)

Summary

Methods
Properties
Constants
__construct()
addMenuLink()
setCategoryFaIcon()
addPageDescriptor()
getPageDescriptors()
getPageDescriptor()
getPageMap()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
insertMenuLink()
$pageDescriptors
$menuLinks
$categoryIcons
N/A

Properties

$menuLinks

$menuLinks :

Type

$categoryIcons

$categoryIcons :

Type

Methods

__construct()

__construct(array<mixed,\Alddesign\Crudkit\Classes\PageDescriptor>  $pageDescriptors = array())

Constructor

Parameters

array<mixed,\Alddesign\Crudkit\Classes\PageDescriptor> $pageDescriptors

addMenuLink()

addMenuLink(string  $name, string  $url, string  $position = '', string  $pageId = '', string  $category = '', string  $id = '') : \Alddesign\Crudkit\Classes\PageStore

Parameters

string $name

The name of the link
string $url
string $position

'before'|'after'|'' (use empty if there is no reference page - for example if its the only link present)
string $pageId

The id of the page in combination with $position sets the position of the menu link
string $category

Name of the category. A category groups one or more links in a named submenu.
string $id

If this id matches a crudkit pageId, then the link will be marked as active on the page with this id

Returns

\Alddesign\Crudkit\Classes\PageStore

setCategoryFaIcon()

setCategoryFaIcon(string  $category, string  $faIcon) : \Alddesign\Crudkit\Classes\PageStore

Parameters

string $category

The name of the category
string $faIcon

The name of the font awesome icon

Returns

\Alddesign\Crudkit\Classes\PageStore

addPageDescriptor()

addPageDescriptor(array<mixed,\Alddesign\Crudkit\Classes\PageDescriptor>  $pageDescriptor)

Adds a single page.

Parameters

array<mixed,\Alddesign\Crudkit\Classes\PageDescriptor> $pageDescriptor

getPageDescriptor()

getPageDescriptor(string  $pageId = '', boolean  $errorIfPageNotFound = false) : \Alddesign\Crudkit\Classes\PageDescriptor

Gets a page

Parameters

string $pageId

ID of the Page
boolean $errorIfPageNotFound

Throw an Error if the page is not found

Returns

\Alddesign\Crudkit\Classes\PageDescriptor

getPageMap()

getPageMap() : array<mixed,string>

Gets an array of pages with and without categories.

Returns

array<mixed,string>

insertMenuLink()

insertMenuLink(array  $pageMap, \Alddesign\Crudkit\Classes\string  $pageId, \Alddesign\Crudkit\Classes\string  $position, \Alddesign\Crudkit\Classes\string  $category, \Alddesign\Crudkit\Classes\bool  $direct = false)

Parameters

array $pageMap
\Alddesign\Crudkit\Classes\string $pageId
\Alddesign\Crudkit\Classes\string $position
\Alddesign\Crudkit\Classes\string $category
\Alddesign\Crudkit\Classes\bool $direct