API Documentation
\
Charcoal
Admin
Action
Account
Object
System
Widget
Table
Object
Property
Display
Input
Selectize
Script
Notification
Object
Table
Translation
User
AclRole
Service
ServiceProvider
Template
Account
Object
System
Ui
Sidemenu
User
Widget
Dialog
FormGroup
Graph

\Charcoal\Admin\UiCollectionContainerInterface

Collection Container Interface

Summary

Methods
Constants
setObjType()
objType()
setCollectionIdent()
collectionIdent()
setCollectionConfig()
collectionConfig()
page()
numPerPage()
numPages()
setCollection()
collection()
objects()
hasObjects()
numObjects()
numTotal()
proto()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

objType()

objType() : string

Returns

string

setCollectionIdent()

setCollectionIdent(string  $collectionIdent) : \Charcoal\Admin\Ui\CollectionContainerInterface

Parameters

string $collectionIdent

The collection identifier.

Returns

\Charcoal\Admin\Ui\CollectionContainerInterface —

Chainable

collectionIdent()

collectionIdent() : string|null

Returns

string|null

collectionConfig()

collectionConfig() : mixed

Returns

mixed

page()

page() : integer

Returns

integer

numPerPage()

numPerPage() : integer

Returns

integer

numPages()

numPages() : integer

Returns

integer

collection()

collection() : \Charcoal\Admin\Ui\Collection

Returns

\Charcoal\Admin\Ui\Collection

objects()

objects() : array

Returns

array

hasObjects()

hasObjects() : boolean

Returns

boolean

numObjects()

numObjects() : integer

Returns

integer

numTotal()

numTotal() : integer

Returns

integer

proto()

proto() : object

Returns

object