\Alddesign\Crudkit\ClassesPageDescriptor

__construct()

__construct(string  $name, string  $id, \Alddesign\Crudkit\Classes\TableDescriptor  $table, boolean  $menu = true, string  $category = '') : \Alddesign\Crudkit\Classes\PageDescriptor

Constructor

Parameters

Returns

getLookupsCalculated()

getLookupsCalculated(array  $record) : array<mixed,\Alddesign\Crudkit\Classes\Lookup>

Gets the Lookup columns and with calculated values.

Parameters

Returns

getMultipleLookupsCalculated()

getMultipleLookupsCalculated(array  $records) : array

Gets the Lookup columns and with calculated values for multiple records

Parameters

Returns

getJs()

getJs() : array

Returns

getCss()

getCss() : array

Returns

setAllowCreate()

setAllowCreate(\Alddesign\Crudkit\Classes\bool  $value = true) 

Allow/deny to create new records (default = true)

Parameters

setAllowUpdate()

setAllowUpdate(\Alddesign\Crudkit\Classes\bool  $value = true) 

Allow/deny to update records (default = true)

Parameters

setAllowDelete()

setAllowDelete(\Alddesign\Crudkit\Classes\bool  $value = true) 

Allow/deny to delete records (default = true)

Parameters

setAllowExport()

setAllowExport(\Alddesign\Crudkit\Classes\bool  $value = true) 

Allow/deny to export records to csv/xml (default = true)

Parameters

setAllowChart()

setAllowChart(\Alddesign\Crudkit\Classes\bool  $value = true) 

Allow/deny to show records as chart (default = true)

Parameters

setAllowCard()

setAllowCard(\Alddesign\Crudkit\Classes\bool  $value = true) 

Allow/deny to show records as card page (default = true)

Parameters

setConfirmDelete()

setConfirmDelete(\Alddesign\Crudkit\Classes\bool  $value = true) 

Show confirmation dialog before deleting a record (default = true)

Parameters

setCategory()

setCategory(\Alddesign\Crudkit\Classes\string  $value = '') 

Name of the category in the menu where this page will be shown

Parameters

setIcon()

setIcon(\Alddesign\Crudkit\Classes\string  $value = '') 

Fowt Awesome icon name of this page (visible in menu)

Parameters

setMenu()

setMenu(\Alddesign\Crudkit\Classes\bool  $value = true) 

Show in Menu or not

Parameters

setItemsPerPage()

setItemsPerPage(\Alddesign\Crudkit\Classes\int  $value = -1) 

Set number of records per page (overrides the crudkit config value). -1 = use curdkit config

Parameters

setSummaryColumns()

setSummaryColumns(array<mixed,string>  $summaryColumnNames) : \Alddesign\Crudkit\Classes\PageDescriptor

Defines which columns are shown in which order on list pages (defaul = all, order = as defined in tables).

Parameters

Returns

setCardLinkColumns()

setCardLinkColumns(array<mixed,string>  $cardLinkColumnNames) : \Alddesign\Crudkit\Classes\PageDescriptor

Defines which columns are shown as link form list to card page (defaul = first column of Tables PK)

$pageDescriptor->setCardLinkColumns(["id", "name"]);

Parameters

Returns

setTitleText()

setTitleText(string  $text, array<mixed,string>  $pageTypes = array()) : \Alddesign\Crudkit\Classes\PageDescriptor

Defines the title text for specific page types

$pageDescriptor
->setTitleText('Book'); //For all pages
->setTitleText('New Book', ['create']); //Specific page

Parameters

Returns

addLookupColumn()

addLookupColumn(string  $id, \Alddesign\Crudkit\Classes\Lookup  $lookup) : \Alddesign\Crudkit\Classes\PageDescriptor

Parameters

Returns

addAction()

addAction(string  $id, string  $label, string  $columnLabel, callable  $callback, boolean  $onList = true, boolean  $onCard = true, string  $faIcon = '', string  $btnClass = '', string  $position = '', string  $fieldname = '', boolean  $enabled = true, boolean  $visible = true,   $data = array()) : \Alddesign\Crudkit\Classes\PageDescriptor

Add a button with a custom action to this page.

Be creative, but take care. Your can write you own php code and use all of crudkits api to manipulate data, etc... (see apidoc-dev):

$callback = function($record, $pageDescriptor, $action) { mail('ceo@mydomain.com', 'Book info', 'Check out our new book: '. $record["name"]); };
$pageDescriptor->addAction('mail', 'Send book-info mail', 'Mail', $callback, true, true, envelope, 'info');
//Next thing: drop table studends;

Parameters

Returns

addActionObject()

addActionObject(string  $id, \Alddesign\Crudkit\Classes\Action  $action) : \Alddesign\Crudkit\Classes\PageDescriptor

Add a button with a custom action to this page.

Parameters

Returns

addSection()

addSection(string  $title, string  $fromColumnName, string  $toColumnName = '', boolean  $collapsedByDefault = true) : \Alddesign\Crudkit\Classes\PageDescriptor

Adds a section (foldable area with a title) to the card page.

Make sure multiple sections do no overlap. Order of from/toColumnName are interchangeable.

Parameters

Returns

addJs()

addJs(string  $url, array  $pageTypes = array(), boolean  $isAssetUrl = true) : \Alddesign\Crudkit\Classes\PageDescriptor

Adds a custom JS file to pages.

Hint: when programming in JS you can get data from the global var "curdkit"

Parameters

Returns

addCss()

addCss(string  $url, array  $pageTypes = array(), boolean  $isAssetUrl = true) : \Alddesign\Crudkit\Classes\PageDescriptor

Adds a custom CSS file to pages.

Parameters

Returns

onOpenList()

onOpenList(callable  $callback) 

Register event handler. Occours before a list page is beeing opened.

//Reference parametes (&) can be modified inside the function. Very powerfull.
//$viewData is an array with all the data sent to the view. Too much to explain. $viewData['records'] for example is interesting
$callback = function(&$pageDescriptor, &$tableDescriptor, &$viewData){...};
$pageDescriptor->onOpenList($callback);

Parameters

onOpenCard()

onOpenCard(callable  $callback) 

Register event handler. Occours before a card page is beeing openend.

//Reference parametes (&) can be modified inside the function. Very powerfull.
//$viewData is an array with all the data sent to the view. Too much to explain. $viewData['record'] for example is interesting
$callback = function(&$pageDescriptor, &$tableDescriptor, &$viewData){...};
$pageDescriptor->onOpenCard($callback);

Parameters

onOpenCreate()

onOpenCreate(callable  $callback) 

Register event handler. Occours before a create page is beeing opened.

//Reference parametes (&) can be modified inside the function. Very powerfull.
//$viewData is an array with all the data sent to the view. Too much to explain. $viewData['record'] for example is interesting
$callback = function(&$pageDescriptor, &$tableDescriptor, &$viewData){...};
$pageDescriptor->onOpenCreate($callback);

Parameters

onOpenUpdate()

onOpenUpdate(callable  $callback) 

Register event handler. Occours before a update page is beeing opened.

//Reference parametes (&) can be modified inside the function. Very powerfull.
//$viewData is an array with all the data sent to the view. Too much to explain. $viewData['record'] for example is interesting
$callback = function(&$pageDescriptor, &$tableDescriptor, &$viewData){...};
$pageDescriptor->onOpenUpdate($callback);

Parameters

onOpenChart()

onOpenChart(callable  $callback) 

Register event handler. Occours before a page is beeing openend as a Chart.

//Reference parametes (&) can be modified inside the function. Very powerfull.
//$viewData is an array with all the data sent to the view. Too much to explain. $viewData['record'] for example is interesting
$callback = function(&$pageDescriptor, &$tableDescriptor, &$viewData){...};
$pageDescriptor->onOpenChart($callback);

Parameters

onBeforeCreate()

onBeforeCreate(callable  $callback) 

Register event handler. Occours before a record will be inserted into the database.

//Reference parametes (&) can be modified inside the function. Very powerfull.
$callback = function(&$pageDescriptor, &$tableDescriptor, &$records){...};
$pageDescriptor->onBeforeCreate($callback);

Parameters

onAfterCreate()

onAfterCreate(callable  $callback) 

Register event handler. Occours after a record has been inserted into the database.

//Reference parametes (&) can be modified inside the function. Very powerfull.
$callback = function(&$pageDescriptor, &$tableDescriptor, &$records){...};
$pageDescriptor->onAfterCreate($callback);

Parameters

onBeforeUpdate()

onBeforeUpdate(callable  $callback) 

Register event handler. Occours before a record will be updated in the database.

//Reference parametes (&) can be modified inside the function. Very powerfull.
$callback = function(&$pageDescriptor, &$tableDescriptor, &$records){...};
$pageDescriptor->onBeforeUpdate($callback);

Parameters

onAfterUpdate()

onAfterUpdate(callable  $callback) 

Register event handler. Occours after a record has been updated in the database.

//Reference parametes (&) can be modified inside the function. Very powerfull.
$callback = function(&$pageDescriptor, &$tableDescriptor, &$records){...};
$pageDescriptor->onAfterUpdate($callback);

Parameters

onBeforeDelete()

onBeforeDelete(callable  $callback) 

Register event handler. Occours before a record will be deleted from the database.

//Reference parametes (&) can be modified inside the function. Very powerfull.
$callback = function(&$pageDescriptor, &$tableDescriptor, &$records){...};
$pageDescriptor->onBeforeDelete($callback);

Parameters

onAfterDelete()

onAfterDelete(callable  $callback) 

Register event handler. Occours after a record has been deleted from the database.

//Reference parametes (&) can be modified inside the function. Very powerfull.
$callback = function(&$pageDescriptor, &$tableDescriptor, &$records){...};
$pageDescriptor->onAfterDelete($callback);

Parameters