\Charcoal\Admin\UiCollectionContainerTrait

setView()

setView(\Charcoal\View\ViewInterface|array  $view) : \Charcoal\Admin\Ui\CollectionContainerInterface

Parameters

Returns

Chainable

view()

view() : \Charcoal\View\ViewInterface

Throws

\Exception

If the view instance is not previously set / injected.

Returns

The object's view.

setModelFactory()

setModelFactory(\Charcoal\Factory\FactoryInterface  $factory) : \Charcoal\Admin\Ui\CollectionContainerInterface

Parameters

Returns

Chainable

setCollectionLoader()

setCollectionLoader(\Charcoal\Loader\CollectionLoader  $loader) : \Charcoal\Admin\Ui\CollectionContainerInterface

Parameters

Returns

Chainable

setObjType()

setObjType(string  $objType) : \Charcoal\Admin\Ui\CollectionContainerInterface

Parameters

Throws

\InvalidArgumentException

If provided argument is not of type 'string'.

Returns

Chainable

objType()

objType() : string

Returns

setCollectionIdent()

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

Set the key for the collection structure to use.

Parameters

Throws

\InvalidArgumentException

If the identifier argument is not a string.

Returns

Chainable

collectionIdentFallback()

collectionIdentFallback() : string

Retrieve a key for the collection structure to use.

If the collection key is undefined, resolve a fallback.

Returns

collectionIdent()

collectionIdent() : string|null

Retrieve the key for the collection structure to use.

Returns

collectionMetadata()

collectionMetadata() : array

Return the current collection metadata.

Returns

collectionConfig()

collectionConfig() : array|null

Retrieve the collection configset.

Returns

setCollectionConfig()

setCollectionConfig(mixed  $config) : \Charcoal\Admin\Ui\CollectionContainerInterface

Replace the collection's configset with the given parameters.

Parameters

Returns

Chainable

mergeCollectionConfig()

mergeCollectionConfig(array  $config) : self

Merge given parameters into the collection's configset.

Parameters

Returns

page()

page() : integer

Returns

numPerPage()

numPerPage() : integer

Returns

numPages()

numPages() : integer

Returns

setCollection()

setCollection(mixed  $collection) : \Charcoal\Admin\Ui\CollectionContainerInterface

Parameters

Returns

Chainable

collection()

collection() : \Charcoal\Model\Collection

Returns

createCollection()

createCollection(array  $data = null) : \Charcoal\Loader\CollectionLoader

Parameters

Throws

\Exception

If the object type of the colletion has not been set.

Returns

objects()

objects() : array

Returns

sortObjects()

sortObjects() : array

Sort the objects before they are displayed as rows.

This method is useful for classes using this trait.

Returns

sortProperties()

sortProperties() : array

Sort the properties before they are displayed as columns.

This method is useful for classes using this trait.

Returns

objectRows()

objectRows() : array

Supplies properties for objects in table template specific to object configuration.

Returns

This metod is a generator.

hasObjects()

hasObjects() : boolean

Returns

numObjects()

numObjects() : integer

Returns

numTotal()

numTotal() : integer

Throws

\Exception

If obj type was not set.

Returns

proto()

proto(boolean  $reload = false) : object

Parameters

Throws

\InvalidArgumentException

If the object type is not defined / can not create prototype.

Returns

modelFactory()

modelFactory() : \Charcoal\Factory\FactoryInterface

Model Factory getter.

Throws

\Exception

If the model factory was not previously set.

Returns

collectionLoader()

collectionLoader() : \Charcoal\Loader\CollectionLoader

Safe Collection Loader getter.

Create the loader if it was not set / injected.

Returns

createCollectionLoader()

createCollectionLoader() : \Charcoal\Loader\CollectionLoader

Create a collection loader.

Returns

parseCollectionConfig()

parseCollectionConfig(array  $config) : array

Stub: Parse given parameters into the collection's config set.

Parameters

Returns

defaultCollectionConfig()

defaultCollectionConfig() : array|null

Retrieve the default collection configuration.

The default configset is determined by the collection ident and object type, if assigned.

Returns

createCollectionConfig()

createCollectionConfig() : mixed

Stub: reimplement in classes using this trait.

Returns

setupDisplayPropertyValue()

setupDisplayPropertyValue(\Charcoal\Model\ModelInterface  $object, \Charcoal\Property\PropertyInterface  $property) : void

Setup the property's display value before its assigned to the object row.

This method is useful for classes using this trait.

Parameters

parsePropertyCell()

parsePropertyCell(\Charcoal\Model\ModelInterface  $object, \Charcoal\Property\PropertyInterface  $property, string  $propertyValue) : array

Filter the property before its assigned to the object row.

This method is useful for classes using this trait.

Parameters

Returns

parseObjectRow()

parseObjectRow(\Charcoal\Model\ModelInterface  $object, array  $objectProperties) : array

Filter the object before its assigned to the row.

This method is useful for classes using this trait.

Parameters

Returns

setPropertyDisplayFactory()

setPropertyDisplayFactory(\Charcoal\Factory\FactoryInterface  $factory) : \Charcoal\Admin\Ui\CollectionContainerInterface

Parameters

Returns

Chainable

propertyDisplayFactory()

propertyDisplayFactory() : \Charcoal\Factory\FactoryInterface

Throws

\Exception

If the property display factory was not previously injected / set.

Returns