\Charcoal\Admin\WidgetObjectFormWidget

setObjType()

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

Set the object type.

Parameters

Throws

\InvalidArgumentException

If provided argument is not of type 'string'.

Returns

Chainable

objType()

objType() : string|null

Retrieve the object type.

Returns

setObjId()

setObjId(string|\Charcoal\Admin\Ui\numeric  $objId) : \Charcoal\Admin\Ui\ObjectContainerInterface

Set the object ID.

Parameters

Throws

\InvalidArgumentException

If provided argument is not of type 'scalar'.

Returns

Chainable

objId()

objId() : string|\Charcoal\Admin\Ui\numeric|null

Retrieve the object ID.

Returns

objIdWithSlashes()

objIdWithSlashes() : string

Retrieve the object ID and addslashes.

Used in template/charcoal/admin/template/form/js.mustache to prevent problems with ID with single or double quotes.

Returns

Escaped ID.

setObjBaseClass()

setObjBaseClass(string  $objBaseClass) : \Charcoal\Admin\Ui\ObjectContainerInterface

Parameters

Throws

\InvalidArgumentException

If provided argument is not of type 'string'.

Returns

Chainable

objBaseClass()

objBaseClass() : string|null

Returns

proto()

proto() : \Charcoal\Model\ModelInterface

Retrieve a singleton of the {self::$objType} for prototyping.

Throws

\RuntimeException

If the class has no object type.

Returns

hasObj()

hasObj() : boolean

Determine if the class has a concrete object.

Returns

obj()

obj() : \Charcoal\Model\ModelInterface

Retrieve the object.

Returns

setDependencies()

setDependencies(\Pimple\Container  $container) : void

Parameters

httpRequest()

httpRequest() : \Psr\Http\Message\RequestInterface

Retrieve the HTTP request object.

Throws

\RuntimeException

If an HTTP request was not previously set.

Returns

createFormProperty()

createFormProperty(array  $data = null) : \Charcoal\Admin\Widget\FormPropertyWidget

Parameters

Returns

setSidebars()

setSidebars(array  $sidebars) : \Charcoal\Admin\Widget\FormWidget

Parameters

Returns

Chainable

addSidebar()

addSidebar(string  $sidebarIdent, array|\Charcoal\Admin\Ui\FormSidebarInterface  $sidebar) : \Charcoal\Admin\Widget\FormWidget

Parameters

Throws

\InvalidArgumentException

If the ident is not a string or the sidebar is not valid.

Returns

Chainable

sidebars()

sidebars() : array<mixed,\Charcoal\Admin\Ui\FormSidebarInterface>|\Charcoal\Admin\Widget\Generator

Returns

setFormProperties()

setFormProperties(array  $properties) : \Charcoal\Ui\Form\FormInterface

Replace property controls to the form.

Parameters

Returns

Chainable

addFormProperties()

addFormProperties(array  $properties) : \Charcoal\Ui\Form\FormInterface

Add property controls to the form.

Parameters

Returns

Chainable

addFormProperty()

addFormProperty(string  $propertyIdent, array|\Charcoal\Admin\Widget\FormPropertyInterface  $formProperty) : \Charcoal\Ui\Form\FormInterface

Add a property control to the form.

If a given property uses a hidden form control, the form property will be added to \FormWidget::$hiddenProperties.

Parameters

Throws

\InvalidArgumentException

If the identifier or the property is invalid.

Returns

Chainable

formProperties()

formProperties(array  $group = null) : array<mixed,\Charcoal\Admin\Widget\FormPropertyWidget>|\Charcoal\Admin\Widget\Generator

Retrieve the object's properties as form controls.

Parameters

Throws

\UnexpectedValueException

If a property data is invalid.

Returns

setHiddenProperties()

setHiddenProperties(array  $properties) : \Charcoal\Ui\Form\FormInterface

Replace hidden property controls to the form.

Parameters

Returns

Chainable

addHiddenProperties()

addHiddenProperties(array  $properties) : \Charcoal\Ui\Form\FormInterface

Add hidden property controls to the form.

Parameters

Returns

Chainable

addHiddenProperty()

addHiddenProperty(string  $propertyIdent, array|\Charcoal\Admin\Widget\FormPropertyInterface  $formProperty) : \Charcoal\Ui\Form\FormInterface

Add a hidden property control to the form.

Parameters

Throws

\InvalidArgumentException

If the identifier or the property is invalid.

Returns

Chainable

hiddenProperties()

hiddenProperties() : array<mixed,\Charcoal\Admin\Widget\FormPropertyWidget>|\Charcoal\Admin\Widget\Generator

Yield the form's hidden property controls.

Returns

submitLabel()

submitLabel() : \Charcoal\Admin\Widget\Translation|string|null

Retrieve the label for the form submission button.

Returns

defaultSubmitLabel()

defaultSubmitLabel() : \Charcoal\Admin\Widget\Translation|string|null

Retrieve the default label for the form submission button.

Returns

defaultGroupType()

defaultGroupType() : string

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

widgetType()

widgetType() : string

Returns

setData()

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

Parameters

Returns

Chainable

setFormIdent()

setFormIdent(string  $formIdent) : \Charcoal\Admin\Widget\ObjectForm

Set the key for the form structure to use.

Parameters

Throws

\InvalidArgumentException

If the identifier is not a string.

Returns

Chainable

formIdentFallback()

formIdentFallback() : string

Retrieve a key for the form structure to use.

If the form key is undefined, resolve a fallback.

Returns

formIdent()

formIdent() : string

Retrieve the key for the form structure to use.

Returns

setNextUrl()

setNextUrl(string  $url) : \Charcoal\Admin\Widget\ActionInterface

Parameters

Throws

\InvalidArgumentException

If argument is not a string.

Returns

Chainable

action()

action() : string

Form action (target URL)

Returns

Relative URL

formProperty()

formProperty(string  $propertyIdent) : \Charcoal\Admin\Widget\FormPropertyWidget

Retrieve an object property as a form control.

Parameters

Throws

\InvalidArgumentException

If the property identifier is not a string.

\UnexpectedValueException

If a property data is invalid.

Returns

setFormData()

setFormData(array  $data) : \Charcoal\Admin\Widget\ObjectFormWidget

Set the form's auxiliary data.

This method is called via \self::setData() if a "form_data" parameter is present on the HTTP request.

Parameters

Returns

Chainable.

formData()

formData() : array

Retrieve the form's auxiliary data.

Returns

objData()

objData() : array

Object data.

Returns

Object data.

setModelFactory()

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

Parameters

Returns

Chainable

modelFactory()

modelFactory() : \Charcoal\Factory\FactoryInterface

Returns

The model factory.

createOrLoadObj()

createOrLoadObj() : \Charcoal\Model\ModelInterface

Create or load the object.

Returns

cloneObj()

cloneObj() : \Charcoal\Model\ModelInterface

Throws

\Exception

If the object is not valid.

Returns

createObjFromBluePrint()

createObjFromBluePrint() : \Charcoal\Model\ModelInterface

Throws

\Exception

If the object is not valid.

Returns

createObj()

createObj() : \Charcoal\Model\ModelInterface

Throws

\Exception

If the object is not valid.

Returns

loadObj()

loadObj() : \Charcoal\Model\ModelInterface

Returns

The loaded object

validateObjType()

validateObjType() : boolean

Throws

\RuntimeException

If the object is invalid.

Returns

validateObjBaseClass()

validateObjBaseClass(mixed  $obj) : boolean

Parameters

Returns

setHttpRequest()

setHttpRequest(\Psr\Http\Message\RequestInterface  $request) : self

Set an HTTP request object.

Parameters

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

dataFromRequest()

dataFromRequest() : array

Fetch metadata from the current request.

Returns

acceptedRequestData()

acceptedRequestData() : array

Retrieve the accepted metadata from the current request.

Returns

sortSidebarsByPriority()

sortSidebarsByPriority(\Charcoal\Admin\Ui\FormSidebarInterface  $a, \Charcoal\Admin\Ui\FormSidebarInterface  $b) : integer

To be called with uasort().

Parameters

Returns

Sorting value: -1, 0, or 1

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

dataFromObject()

dataFromObject() : array

Fetch metadata from the current object type.

Returns

createFormGroup()

createFormGroup(array|null  $data = null) : \Charcoal\Ui\FormGroup\FormGroupInterface

Create a new form group widget.

Parameters

Returns

updateFormGroup()

updateFormGroup(\Charcoal\Ui\FormGroup\FormGroupInterface  $group, array|null  $groupData = null, string|null  $groupIdent = null) : \Charcoal\Ui\FormGroup\FormGroupInterface

Update the given form group widget.

Parameters

Returns