\Charcoal\Admin\WidgetSearchWidget

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

setDependencies()

setDependencies(\Pimple\Container  $container) : void

Parameters

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

setData()

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

Parameters

Returns

Chainable

dataFromObject()

dataFromObject() : array

Fetch metadata from current obj_type

Returns

List of metadata.

properties()

properties() : array

Sets and returns properties

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

Returns

jsonPropertiesList()

jsonPropertiesList() : string

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

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

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

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

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

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