Menu

## PageDescriptor
in package

PageDescriptor.php : 21

Definition of a webpage (UI).

Examples for usage are provided in the documentation for CrudkitServiceProvider. Important: all methods marked with "@stackable" (like the constructor and all set methods) can be used like this

    $page = new PageDesriptor(...)
    		->setTitleText(...)
    		->addAction(...)
    		->...

...easy

##### Tags

see
  CrudkitServiceProvider

### Table of Contents

PAGE_TYPES = ['list', 'card', 'create', 'update', 'chart']
$actions : array<string|int, Action>
$callbacks : array<string|int, callable>
$cardAllowed : mixed
$cardLinkColumns : mixed
$category : mixed
$chartAllowed : mixed
$confirmDelete : mixed
$createAllowed : mixed
$css : mixed
$deleteAllowed : mixed
$exportAllowed : mixed
$icon : mixed
$id : mixed
$itemsPerPage : mixed
$js : mixed
$lookups : array<string|int, Lookup>
$menu : mixed
$name : mixed
$sections : array<string|int, Section>
$summaryColumns : mixed
$table : mixed
$titleTexts : mixed
$updateAllowed : mixed
__construct() : PageDescriptor
  Constructor
addAction() : PageDescriptor
  Add a button with a custom action to this page.
addActionObject() : PageDescriptor
  Add a button with a custom action to this page.
addCss() : PageDescriptor
  Adds a custom CSS file to pages.
addJs() : PageDescriptor
  Adds a custom JS file to pages.
addLookupColumn() : PageDescriptor
addSection() : PageDescriptor
  Adds a section (foldable area with a title) to the card page.
getActions() : Action|array<string|int, Action>
  Retruns on or all actions for this page.
getCardAllowed() : mixed
getCardLinkColumns() : array<string|int, string>|array<string|int, SQLColumn>
  Gets either an array of column names or SqlColumn objects with the card link columns.
getCategory() : mixed
getChartAllowed() : mixed
getConfirmDelete() : mixed
getCreateAllowed() : mixed
getCss() : array<string|int, mixed>
getDeleteAllowed() : mixed
getExportAllowed() : mixed
getIcon() : mixed
getId() : mixed
getItemsPerPage() : mixed
getJs() : array<string|int, mixed>
getLookupsCalculated() : array<string|int, Lookup>
  Gets the Lookup columns and with calculated values.
getMenu() : mixed
getMultipleLookupsCalculated() : array<string|int, mixed>
  Gets the Lookup columns and with calculated values for multiple records
getName() : mixed
getSections() : mixed
getSummaryColumns() : array<string|int, string>|array<string|int, SQLColumn>
  Gets either an array of column names or SqlColumn objects with the list page columns.
getTable() : TableDescriptor
  Get the table to this page.
getTitleText() : mixed
getUpdateAllowed() : mixed
onAfterCreate() : mixed
  Register event handler. Occours after a record has been inserted into the database.
onAfterDelete() : mixed
  Register event handler. Occours after a record has been deleted from the database.
onAfterUpdate() : mixed
  Register event handler. Occours after a record has been updated in the database.
onBeforeCreate() : mixed
  Register event handler. Occours before a record will be inserted into the database.
onBeforeDelete() : mixed
  Register event handler. Occours before a record will be deleted from the database.
onBeforeUpdate() : mixed
  Register event handler. Occours before a record will be updated in the database.
onOpenCard() : mixed
  Register event handler. Occours before a card page is beeing openend.
onOpenChart() : mixed
  Register event handler. Occours before a page is beeing openend as a Chart.
onOpenCreate() : mixed
  Register event handler. Occours before a create page is beeing opened.
onOpenList() : mixed
  Register event handler. Occours before a list page is beeing opened.
onOpenUpdate() : mixed
  Register event handler. Occours before a update page is beeing opened.
setAllowCard() : mixed
  Allow/deny to show records as card page (default = true)
setAllowChart() : mixed
  Allow/deny to show records as chart (default = true)
setAllowCreate() : mixed
  Allow/deny to create new records (default = true)
setAllowDelete() : mixed
  Allow/deny to delete records (default = true)
setAllowExport() : mixed
  Allow/deny to export records to csv/xml (default = true)
setAllowUpdate() : mixed
  Allow/deny to update records (default = true)
setCardLinkColumns() : PageDescriptor
  Defines which columns are shown as link form the list page to the card page.
setCategory() : mixed
  Name of the category in the menu where this page will be shown
setConfirmDelete() : mixed
  Show confirmation dialog before deleting a record (default = true)
setIcon() : mixed
  Fowt Awesome icon name of this page (visible in menu)
setItemsPerPage() : mixed
  Set number of records per page (overrides the crudkit config value). -1 = use curdkit config
setMenu() : mixed
  Show in Menu or not
setSummaryColumns() : PageDescriptor
  Defines which columns are shown in which order on list pages.
setTitleText() : PageDescriptor
  Defines the title text for specific page types
triggerEvent() : mixed
  Triggers an event.

### Constants

#### PAGE_TYPES

PageDescriptor.php : 23
`public mixed PAGE_TYPES = ['list', 'card', 'create', 'update', 'chart']`

##### Tags

internal

### Properties

#### $actions

PageDescriptor.php : 56
`private array<string|int, Action> $actions = []`

Adding Buttons with special callback functions to listview/cardview

##### Tags

internal

#### $callbacks

PageDescriptor.php : 70
`private array<string|int, callable> $callbacks = []`

Event callback function. [Key => Event name, Value => Callback function ]

##### Tags

internal

#### $cardAllowed

PageDescriptor.php : 64
`private mixed $cardAllowed = true`

##### Tags

internal

#### $cardLinkColumns

PageDescriptor.php : 33
`private mixed $cardLinkColumns = []`

##### Tags

internal

#### $category

PageDescriptor.php : 27
`private mixed $category = ''`

##### Tags

internal

#### $chartAllowed

PageDescriptor.php : 63
`private mixed $chartAllowed = true`

##### Tags

internal

#### $confirmDelete

PageDescriptor.php : 61
`private mixed $confirmDelete = true`

##### Tags

internal

#### $createAllowed

PageDescriptor.php : 58
`private mixed $createAllowed = true`

##### Tags

internal

#### $css

PageDescriptor.php : 36
`private mixed $css = []`

##### Tags

internal

#### $deleteAllowed

PageDescriptor.php : 60
`private mixed $deleteAllowed = true`

##### Tags

internal

#### $exportAllowed

PageDescriptor.php : 62
`private mixed $exportAllowed = true`

##### Tags

internal

#### $icon

PageDescriptor.php : 28
`private mixed $icon = ''`

##### Tags

internal

#### $id

PageDescriptor.php : 25
`private mixed $id = ''`

##### Tags

internal

#### $itemsPerPage

PageDescriptor.php : 37
`private mixed $itemsPerPage = -1`

##### Tags

internal

#### $js

PageDescriptor.php : 35
`private mixed $js = []`

##### Tags

internal

#### $lookups

PageDescriptor.php : 44
`private array<string|int, Lookup> $lookups = []`

Lookup fields

##### Tags

internal

#### $menu

PageDescriptor.php : 34
`private mixed $menu = false`

##### Tags

internal

#### $name

PageDescriptor.php : 26
`private mixed $name = ''`

##### Tags

internal

#### $sections

PageDescriptor.php : 50
`private array<string|int, Section> $sections = []`

Displaying fields in separated areas called "Sections."

##### Tags

internal

#### $summaryColumns

PageDescriptor.php : 32
`private mixed $summaryColumns = []`

##### Tags

internal

#### $table

PageDescriptor.php : 31
`private mixed $table = null`

##### Tags

internal

#### $titleTexts

PageDescriptor.php : 29
`private mixed $titleTexts = []`

##### Tags

internal

#### $updateAllowed

PageDescriptor.php : 59
`private mixed $updateAllowed = true`

##### Tags

internal

### Methods

#### __construct()

PageDescriptor.php : 83

Constructor

`public __construct(string $name, string $id, TableDescriptor $table[, bool $menu = true ][, string $category = '' ]) : PageDescriptor`

##### Parameters

$name : string

  Display name

$id : string

  Unique name of the page. Allowed characters: a-z, A-Z, 0-9, "_", "-"

$table : TableDescriptor

  Table which is the basis of this page

$menu : bool = true

  Show in menu

$category : string = ''

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

##### Tags

stackable

##### Return values

PageDescriptor —

#### addAction()

PageDescriptor.php : 498

Add a button with a custom action to this page.

`public addAction(string $id, string $label, string $columnLabel, callable $callback[, bool $onList = true ][, bool $onCard = true ][, string $faIcon = '' ][, string $btnClass = '' ][, string $position = '' ][, string $fieldname = '' ][, bool $enabled = true ][, bool $visible = true ][, mixed $data = [] ]) : PageDescriptor`

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

$id : string

  a identifier for this action (unique per page)

$label : string

  Label of the button

$columnLabel : string

  Label of the column in list view

$callback : callable

  Callback function to execute when pressing the button. This callback has $record, $pageDescriptor, $action(this is what you definde here) as parameters.

$onList : bool = true

  (optional) Show on list page

$onCard : bool = true

  (optional) Show on card page

$faIcon : string = ''

  (optional) Icon for the Button. (Font Awesome icon name)

$btnClass : string = ''

  (optional) ''|'default'|'primary'|'info'|'success'|'danger'|'warning'. (Admin LTE Button class)

$position : string = ''

  (optional) 'top'|'bottom'|'both'|'before-field'|'after-field'|'to-field'. Position on card pages.

$fieldname : string = ''

  (optional) The reference fieldname for $postion ('before-field'|'after-field'|'to-field')

$enabled : bool = true

  (optional) If the button is enabled

$visible : bool = true

  (optional) If the button is visible

$data : mixed = []

##### Tags

stackable

##### Return values

PageDescriptor —

#### addActionObject()

PageDescriptor.php : 522

Add a button with a custom action to this page.

`public addActionObject(string $id, Action $action) : PageDescriptor`

##### Parameters

$id : string

  a identifier for this action (unique per page)

$action : Action

  The Action

##### Tags

stackable

##### Return values

PageDescriptor —

#### addCss()

PageDescriptor.php : 628

Adds a custom CSS file to pages.

`public addCss(string $url[, array<string|int, mixed> $pageTypes = [] ][, bool $isAssetUrl = true ]) : PageDescriptor`

##### Parameters

$url : string

  Absolute or relative URL to the CSS file

$pageTypes : array<string|int, mixed> = []

  Array of page type names fore the CSS file to add

$isAssetUrl : bool = true

  Indicates if its a URL to the Laravel asset directory (/public)

##### Return values

PageDescriptor —

#### addJs()

PageDescriptor.php : 611

Adds a custom JS file to pages.

`public addJs(string $url[, array<string|int, mixed> $pageTypes = [] ][, bool $isAssetUrl = true ]) : PageDescriptor`

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

##### Parameters

$url : string

  Absolute or relative URL to the JS file

$pageTypes : array<string|int, mixed> = []

  Array of page type names fore the JS file to add

$isAssetUrl : bool = true

  Indicates if its a URL to the Laravel asset directory (/public)

##### Return values

PageDescriptor —

#### addLookupColumn()

PageDescriptor.php : 452
`public addLookupColumn(string $id, Lookup $lookup) : PageDescriptor`

##### Parameters

$id : string

  a identifier for this lookup on the (unique per page)

$lookup : Lookup

  The lookup object

##### Tags

stackable

##### Return values

PageDescriptor —

#### addSection()

PageDescriptor.php : 550

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

`public addSection(string $title, string $fromColumnName[, string $toColumnName = '' ][, bool $collapsedByDefault = true ]) : PageDescriptor`

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

##### Parameters

$title : string

  The title to display (unique)

$fromColumnName : string
$toColumnName : string = ''
$collapsedByDefault : bool = true

##### Return values

PageDescriptor —

#### getActions()

PageDescriptor.php : 131

Retruns on or all actions for this page.

`public getActions([string $name = '' ]) : Action|array<string|int, Action>`

##### Parameters

$name : string = ''

##### Tags

internal

##### Return values

Action|array<string|int, Action> —

#### getCardAllowed()

PageDescriptor.php : 118
`public getCardAllowed() : mixed`

##### Tags

internal

##### Return values

mixed —

#### getCardLinkColumns()

PageDescriptor.php : 182

Gets either an array of column names or SqlColumn objects with the card link columns.

`public getCardLinkColumns([bool $namesOnly = false ]) : array<string|int, string>|array<string|int, SQLColumn>`

##### Parameters

$namesOnly : bool = false

##### Tags

internal

##### Return values

array<string|int, string>|array<string|int, SQLColumn> —

#### getCategory()

PageDescriptor.php : 120
`public getCategory() : mixed`

##### Tags

internal

##### Return values

mixed —

#### getChartAllowed()

PageDescriptor.php : 117
`public getChartAllowed() : mixed`

##### Tags

internal

##### Return values

mixed —

#### getConfirmDelete()

PageDescriptor.php : 119
`public getConfirmDelete() : mixed`

##### Tags

internal

##### Return values

mixed —

#### getCreateAllowed()

PageDescriptor.php : 113
`public getCreateAllowed() : mixed`

##### Tags

internal

##### Return values

mixed —

#### getCss()

PageDescriptor.php : 328
`public getCss() : array<string|int, mixed>`

##### Return values

array<string|int, mixed> —

#### getDeleteAllowed()

PageDescriptor.php : 115
`public getDeleteAllowed() : mixed`

##### Tags

internal

##### Return values

mixed —

#### getExportAllowed()

PageDescriptor.php : 116
`public getExportAllowed() : mixed`

##### Tags

internal

##### Return values

mixed —

#### getIcon()

PageDescriptor.php : 121
`public getIcon() : mixed`

##### Tags

internal

##### Return values

mixed —

#### getId()

PageDescriptor.php : 112
`public getId() : mixed`

##### Tags

internal

##### Return values

mixed —

#### getItemsPerPage()

PageDescriptor.php : 124
`public getItemsPerPage() : mixed`

##### Tags

internal

##### Return values

mixed —

#### getJs()

PageDescriptor.php : 322
`public getJs() : array<string|int, mixed>`

##### Return values

array<string|int, mixed> —

#### getLookupsCalculated()

PageDescriptor.php : 223

Gets the Lookup columns and with calculated values.

`public getLookupsCalculated(array<string|int, mixed> $record) : array<string|int, Lookup>`

##### Parameters

$record : array<string|int, mixed>

##### Return values

array<string|int, Lookup> —

#### getMenu()

PageDescriptor.php : 123
`public getMenu() : mixed`

##### Tags

internal

##### Return values

mixed —

#### getMultipleLookupsCalculated()

PageDescriptor.php : 243

Gets the Lookup columns and with calculated values for multiple records

`public getMultipleLookupsCalculated(array<string|int, mixed> $records) : array<string|int, mixed>`

##### Parameters

$records : array<string|int, mixed>

##### Return values

array<string|int, mixed> —

#### getName()

PageDescriptor.php : 111
`public getName() : mixed`

##### Tags

internal

##### Return values

mixed —

#### getSections()

PageDescriptor.php : 122
`public getSections() : mixed`

##### Tags

internal

##### Return values

mixed —

#### getSummaryColumns()

PageDescriptor.php : 160

Gets either an array of column names or SqlColumn objects with the list page columns.

`public getSummaryColumns([bool $namesOnly = false ]) : array<string|int, string>|array<string|int, SQLColumn>`

##### Parameters

$namesOnly : bool = false

##### Tags

internal

##### Return values

array<string|int, string>|array<string|int, SQLColumn> —

#### getTable()

PageDescriptor.php : 149

Get the table to this page.

`public getTable() : TableDescriptor`

##### Tags

internal

##### Return values

TableDescriptor —

#### getTitleText()

PageDescriptor.php : 200
`public getTitleText(string $pageType) : mixed`

##### Parameters

$pageType : string

##### Tags

internal

##### Return values

mixed —

#### getUpdateAllowed()

PageDescriptor.php : 114
`public getUpdateAllowed() : mixed`

##### Tags

internal

##### Return values

mixed —

#### onAfterCreate()

PageDescriptor.php : 773

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

`public onAfterCreate(callable $callback) : mixed`

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

##### Parameters

$callback : callable

##### Tags

event

##### Return values

mixed —

#### onAfterDelete()

PageDescriptor.php : 841

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

`public onAfterDelete(callable $callback) : mixed`

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

##### Parameters

$callback : callable

  Callback function which is beeing called if this event occours.

##### Tags

event

##### Return values

mixed —

#### onAfterUpdate()

PageDescriptor.php : 807

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

`public onAfterUpdate(callable $callback) : mixed`

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

##### Parameters

$callback : callable

##### Tags

event

##### Return values

mixed —

#### onBeforeCreate()

PageDescriptor.php : 756

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

`public onBeforeCreate(callable $callback) : mixed`

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

##### Parameters

$callback : callable

##### Tags

event

##### Return values

mixed —

#### onBeforeDelete()

PageDescriptor.php : 824

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

`public onBeforeDelete(callable $callback) : mixed`

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

##### Parameters

$callback : callable

##### Tags

event

##### Return values

mixed —

#### onBeforeUpdate()

PageDescriptor.php : 790

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

`public onBeforeUpdate(callable $callback) : mixed`

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

##### Parameters

$callback : callable

##### Tags

event

##### Return values

mixed —

#### onOpenCard()

PageDescriptor.php : 686

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

`public onOpenCard(callable $callback) : mixed`

    //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

$callback : callable

##### Tags

event

##### Return values

mixed —

#### onOpenChart()

PageDescriptor.php : 739

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

`public onOpenChart(callable $callback) : mixed`

    //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

$callback : callable

##### Tags

event

##### Return values

mixed —

#### onOpenCreate()

PageDescriptor.php : 704

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

`public onOpenCreate(callable $callback) : mixed`

    //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

$callback : callable

##### Tags

event

##### Return values

mixed —

#### onOpenList()

PageDescriptor.php : 668

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

`public onOpenList(callable $callback) : mixed`

    //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

$callback : callable

##### Tags

event

##### Return values

mixed —

#### onOpenUpdate()

PageDescriptor.php : 722

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

`public onOpenUpdate(callable $callback) : mixed`

    //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

$callback : callable

##### Tags

event

##### Return values

mixed —

#### setAllowCard()

PageDescriptor.php : 352

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

`public setAllowCard([bool $value = true ]) : mixed`

##### Parameters

$value : bool = true

##### Tags

stackable

##### Return values

mixed —

#### setAllowChart()

PageDescriptor.php : 349

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

`public setAllowChart([bool $value = true ]) : mixed`

##### Parameters

$value : bool = true

##### Tags

stackable

##### Return values

mixed —

#### setAllowCreate()

PageDescriptor.php : 337

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

`public setAllowCreate([bool $value = true ]) : mixed`

##### Parameters

$value : bool = true

##### Tags

stackable

##### Return values

mixed —

#### setAllowDelete()

PageDescriptor.php : 343

Allow/deny to delete records (default = true)

`public setAllowDelete([bool $value = true ]) : mixed`

##### Parameters

$value : bool = true

##### Tags

stackable

##### Return values

mixed —

#### setAllowExport()

PageDescriptor.php : 346

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

`public setAllowExport([bool $value = true ]) : mixed`

##### Parameters

$value : bool = true

##### Tags

stackable

##### Return values

mixed —

#### setAllowUpdate()

PageDescriptor.php : 340

Allow/deny to update records (default = true)

`public setAllowUpdate([bool $value = true ]) : mixed`

##### Parameters

$value : bool = true

##### Tags

stackable

##### Return values

mixed —

#### setCardLinkColumns()

PageDescriptor.php : 402

Defines which columns are shown as link form the list page to the card page.

`public setCardLinkColumns(array<string|int, string> $cardLinkColumnNames) : PageDescriptor`

By the default its the first column of the table´s primary key.

##### Parameters

$cardLinkColumnNames : array<string|int, string>

  Array of column names

##### Tags

stackable

##### Return values

PageDescriptor —

#### setCategory()

PageDescriptor.php : 358

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

`public setCategory([string $value = '' ]) : mixed`

##### Parameters

$value : string = ''

##### Tags

stackable

##### Return values

mixed —

#### setConfirmDelete()

PageDescriptor.php : 355

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

`public setConfirmDelete([bool $value = true ]) : mixed`

##### Parameters

$value : bool = true

##### Tags

stackable

##### Return values

mixed —

#### setIcon()

PageDescriptor.php : 361

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

`public setIcon([string $value = '' ]) : mixed`

##### Parameters

$value : string = ''

##### Tags

stackable

##### Return values

mixed —

#### setItemsPerPage()

PageDescriptor.php : 367

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

`public setItemsPerPage([int $value = -1 ]) : mixed`

##### Parameters

$value : int = -1

##### Tags

stackable

##### Return values

mixed —

#### setMenu()

PageDescriptor.php : 364

Show in Menu or not

`public setMenu([bool $value = true ]) : mixed`

##### Parameters

$value : bool = true

##### Tags

stackable

##### Return values

mixed —

#### setSummaryColumns()

PageDescriptor.php : 379

Defines which columns are shown in which order on list pages.

`public setSummaryColumns(array<string|int, string> $summaryColumnNames) : PageDescriptor`

By default all columns are shown in the order they are defined in the table.

##### Parameters

$summaryColumnNames : array<string|int, string>

  Array of column names.

##### Tags

stackable

##### Return values

PageDescriptor —

#### setTitleText()

PageDescriptor.php : 429

Defines the title text for specific page types

`public setTitleText(string $text[, array<string|int, string> $pageTypes = [] ]) : PageDescriptor`

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

##### Parameters

$text : string

  The text to display

$pageTypes : array<string|int, string> = []

  (optional) specifies on which page types ('list', 'card', 'create', 'update', 'chart') this text will be shown.

##### Tags

stackable

##### Return values

PageDescriptor —

#### triggerEvent()

PageDescriptor.php : 644

Triggers an event.

`public triggerEvent(string $name[, mixed &$param1 = null ]) : mixed`

##### Parameters

$name : string

  Name of the Event

$param1 : mixed = null

  Additional parameter

##### Tags

internal

##### Return values

mixed —

## Search results