\Charcoal\Admin\WidgetTableGridWidget

setDependencies()

setDependencies(\Pimple\Container  $container) : void

Parameters

propertyFactory()

propertyFactory() : \Charcoal\Factory\FactoryInterface

Throws

\RuntimeException

If the property factory was not previously set / injected.

Returns

setData()

setData(array  $data) : \Charcoal\Admin\Widget\TableWidget

Parameters

Returns

Chainable

dataFromRequest()

dataFromRequest() : array

Fetch metadata from the current request.

Returns

acceptedRequestData()

acceptedRequestData() : array

Retrieve the accepted metadata from the current request.

Returns

dataFromObject()

dataFromObject() : array

Fetch metadata from the current object type.

Returns

properties()

properties() : array<mixed,\Charcoal\Admin\Widget\FormPropertyWidget>

Sets and returns properties

Manages which to display, and their order, as set in object metadata

Returns

setSortable()

setSortable(boolean  $sortable) : \Charcoal\Admin\Widget\TableWidget

Parameters

Returns

Chainable

sortable()

sortable() : boolean

Returns

propertiesOptions()

propertiesOptions() : array|null

Retrieve the property customizations for the collection.

Returns

viewOptions()

viewOptions(string  $propertyIdent) : array

Retrieve the view options for the given property.

Parameters

Returns

collectionProperties()

collectionProperties() : array|\Charcoal\Admin\Widget\Generator

Properties to display in collection template, and their order, as set in object metadata

Returns

setShowObjectActions()

setShowObjectActions(boolean  $show) : \Charcoal\Admin\Widget\TableWidget

Show/hide the table's object actions.

Parameters

Returns

Chainable

showObjectActions()

showObjectActions() : boolean

Determine if the table's object actions should be shown.

Returns

objectActions()

objectActions() : array

Retrieve the table's object actions.

Returns

setObjectActions()

setObjectActions(array  $actions) : \Charcoal\Admin\Widget\TableWidget

Set the table's object actions.

Parameters

Returns

Chainable.

createObjectActions()

createObjectActions(array  $actions) : array

Build the table's object actions (row).

Object actions should come from the collection settings defined by the "collection_ident". It is still possible to completly override those externally by setting the "object_actions" with the \self::setObjectActions() method.

Parameters

Returns

Object actions.

showEmptyListActions()

showEmptyListActions() : boolean

Determine if the table's empty collection actions should be shown.

Returns

emptyListActions()

emptyListActions() : array

Retrieve the table's empty collection actions.

Returns

setShowListActions()

setShowListActions(boolean  $show) : \Charcoal\Admin\Widget\TableWidget

Show/hide the table's collection actions.

Parameters

Returns

Chainable

showListActions()

showListActions() : boolean

Determine if the table's collection actions should be shown.

Returns

listActions()

listActions() : array

Retrieve the table's collection actions.

Returns

paginationWidget()

paginationWidget() : \Charcoal\Admin\Widget\PaginationWidget

Returns

setShowTableHeader()

setShowTableHeader(boolean  $show) : \Charcoal\Admin\Widget\TableWidget

Parameters

Returns

Chainable

showTableHeader()

showTableHeader() : boolean

Returns

setShowTableHead()

setShowTableHead(boolean  $show) : \Charcoal\Admin\Widget\TableWidget

Parameters

Returns

Chainable

showTableHead()

showTableHead() : boolean

Returns

setShowTableFoot()

setShowTableFoot(boolean  $show) : \Charcoal\Admin\Widget\TableWidget

Parameters

Returns

Chainable

showTableFoot()

showTableFoot() : boolean

Returns

jsActionPrefix()

jsActionPrefix() : string

Returns

objectEditUrl()

objectEditUrl() : string

Generate URL for editing an object

Returns

objectCreateUrl()

objectCreateUrl() : string

Generate URL for creating an object

Returns

isObjCreatable()

isObjCreatable() : boolean

Determine if the object can be created.

If TRUE, the "Create" button is shown. Objects can still be inserted programmatically or via direct action on the database.

Returns

isObjEditable()

isObjEditable() : boolean

Determine if the object can be modified.

If TRUE, the "Modify" button is shown. Objects can still be updated programmatically or via direct action on the database.

Returns

isObjDeletable()

isObjDeletable() : boolean

Determine if the object can be deleted.

If TRUE, the "Delete" button is shown. Objects can still be deleted programmatically or via direct action on the database.

Returns

isObjViewable()

isObjViewable() : boolean

Determine if the object can be viewed (on the front-end).

If TRUE, any "View" button is shown. The object can still be saved programmatically.

Returns

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.

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

setTemplate()

setTemplate(string  $template) : \Charcoal\Admin\UiItemInterface

Parameters

Throws

\InvalidArgumentException

If the template identifier is not a string.

Returns

Chainable

template()

template() : string

Returns

setWidgetId()

setWidgetId(string  $widgetId) : \Charcoal\Admin\AdminWidget

Parameters

Returns

Chainable

widgetId()

widgetId() : string

Returns

setType()

setType(string  $type) : \Charcoal\Admin\AdminWidget

Parameters

Throws

\InvalidArgumentException

If the argument is not a string.

Returns

Chainable

type()

type() : string

Returns

setIdent()

setIdent(string  $ident) : \Charcoal\Admin\AdminWidget

Parameters

Throws

\InvalidArgumentException

If the ident is not a string.

Returns

(Chainable)

ident()

ident() : string

Returns

setDataSources()

setDataSources(mixed  $sources) : \Charcoal\Admin\AdminWidget

Set extra data sources to merge when setting data on an entity.

Parameters

Returns

Chainable

dataSources()

dataSources() : array<mixed,string>

Retrieve the extra data sources to merge when setting data on an entity.

Returns

dataSourceFilter()

dataSourceFilter(string  $sourceIdent) : callable|null

Retrieve the callable filter for the given data source.

Parameters

Throws

\InvalidArgumentException

If the data source is invalid.

Returns

Returns a callable variable.

setLabel()

setLabel(mixed  $label) : \Charcoal\Admin\AdminWidget

Parameters

Returns

Chainable

label()

label() : \Charcoal\Translator\Translation|string|null

Returns

actions()

actions() : array

Returns

setShowActions()

setShowActions(boolean  $show) : \Charcoal\Admin\AdminWidget

Parameters

Returns

Chainable

showActions()

showActions() : boolean

Returns

setShowLabel()

setShowLabel(boolean  $show) : \Charcoal\Admin\AdminWidget

Parameters

Returns

Chainable

showLabel()

showLabel() : boolean

Returns

adminUrl()

adminUrl() : \Psr\Http\Message\UriInterface|string

Retrieve the base URI of the administration area.

Returns

setBaseUrl()

setBaseUrl(\Psr\Http\Message\UriInterface|string  $uri) : self

Set the base URI of the application.

Parameters

Returns

baseUrl()

baseUrl() : \Psr\Http\Message\UriInterface|string

Retrieve the base URI of the application.

Returns

setPriority()

setPriority(integer  $priority) : \Charcoal\Admin\AdminWidget

Parameters

Returns

Chainable

priority()

priority() : integer

Returns

setWidgetFactory()

setWidgetFactory(\Charcoal\Factory\FactoryInterface  $factory) : self

Set an widget factory.

Parameters

Returns

widgetFactory()

widgetFactory() : \Charcoal\Factory\FactoryInterface

Retrieve the widget factory.

Throws

\RuntimeException

If the widget factory was not previously set.

Returns

setPropertyFactory()

setPropertyFactory(\Charcoal\Factory\FactoryInterface  $factory) : \Charcoal\Admin\Widget\TableWidget

Parameters

Returns

Chainable

resolveDataSourceFilter()

resolveDataSourceFilter(mixed  $toResolve) : callable|null

Retrieve the default data source filters (when setting data on an entity).

Note: Adapted from \Slim\CallableResolver.

Parameters

Returns

defaultPropertiesOptions()

defaultPropertiesOptions() : array|null

Retrieve the default property customizations.

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

Returns

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

parsePropertyCellClasses()

parsePropertyCellClasses(\Charcoal\Property\PropertyInterface  $property, \Charcoal\Model\ModelInterface|null  $object = null) : array

Filter the table cell's CSS classes before the property is 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

parseAsObjectActions()

parseAsObjectActions(array  $actions) : array

Parse the given actions as (row) object actions.

Parameters

Returns

defaultObjectActions()

defaultObjectActions() : array

Retrieve the table's default object actions.

Returns

setListActions()

setListActions(array  $actions) : \Charcoal\Admin\Widget\TableWidget

Set the table's collection actions.

Parameters

Returns

Chainable.

createListActions()

createListActions(array  $actions) : array

Build the table collection actions.

List actions should come from the collection settings defined by the "collection_ident". It is still possible to completly override those externally by setting the "list_actions" with the \self::setListActions() method.

Parameters

Returns

List actions.

parseAsListActions()

parseAsListActions(array  $actions) : array

Parse the given actions as collection actions.

Parameters

Returns

defaultListActions()

defaultListActions() : array

Retrieve the table's default collection actions.

Returns

setModelFactory()

setModelFactory(\Charcoal\Factory\FactoryInterface  $factory) : \Charcoal\Admin\AdminScript

Parameters

Returns

Chainable

modelFactory()

modelFactory() : \Charcoal\Factory\FactoryInterface

Returns

The model factory.

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

addDataSources()

addDataSources(mixed  $sourceIdent, mixed  $sourceFilter = null) : \Charcoal\Admin\AdminWidget

Set extra data sources to merge when setting data on an entity.

Parameters

Throws

\InvalidArgumentException

If the data source is invalid.

Returns

Chainable

acceptedDataSources()

acceptedDataSources() : array<mixed,string>

Retrieve the available data sources (when setting data on an entity).

Returns

defaultDataSources()

defaultDataSources() : array<mixed,string>

Retrieve the default data sources (when setting data on an entity).

Returns

defaultDataSourceFilters()

defaultDataSourceFilters() : array

Retrieve the default data source filters (when setting data on an entity).

Returns

mergeDataSources()

mergeDataSources(array|\Charcoal\Admin\ArrayInterface  $dataset = null) : \Charcoal\Admin\AdminWidget

Retrieve the available data sources (when setting data on an entity).

Parameters

Returns

Chainable

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