\Charcoal\Admin\WidgetFormPropertyWidget

setDependencies()

setDependencies(\Pimple\Container  $container) : void

Set the widget's dependencies.

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

Retrieve the widget ID.

Returns

setType()

setType(string  $type) : \Charcoal\Admin\Widget\FormPropertyWidget

Set the widget or property type.

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\Widget\FormPropertyWidget

Show/hide the property's label.

Parameters

Returns

Chainable

showLabel()

showLabel() : boolean

Determine if the label is to be displayed.

Returns

If TRUE or unset, check if there is a label.

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

propertyFactory()

propertyFactory() : \Charcoal\Factory\FactoryInterface

Retrieve the property factory.

Throws

\RuntimeException

If the property factory is missing.

Returns

propertyInputFactory()

propertyInputFactory() : \Charcoal\Factory\FactoryInterface

Retrieve the property control factory.

Throws

\RuntimeException

If the property control factory is missing.

Returns

propertyDisplayFactory()

propertyDisplayFactory() : \Charcoal\Factory\FactoryInterface

Retrieve the property display factory.

Throws

\RuntimeException

If the property display factory is missing.

Returns

setOutputType()

setOutputType(string  $type) : \Charcoal\Admin\Widget\FormPropertyWidget

Set the model's property type.

Can be either "input" or "display". A property input or property display identifier is also accepted.

Parameters

Throws

\InvalidArgumentException

If the argument is not a string.

Returns

Chainable

outputType()

outputType() : string|null

Retrieve the widget's property output type.

Defaults to "input_type".

Throws

\LogicException

If the "input_type" and "display_type" are disabled.

Returns

supportedOutputTypes()

supportedOutputTypes() : array

Retrieve the supported property output types.

Returns

setFormGroup()

setFormGroup(\Charcoal\Ui\FormGroup\FormGroupInterface  $formGroup) : \Charcoal\Admin\Widget\FormPropertyWidget

Set the form input's parent group.

Parameters

Returns

Chainable

formGroup()

formGroup() : \Charcoal\Ui\FormGroup\FormGroupInterface

Retrieve the input's parent group.

Returns

clearFormGroup()

clearFormGroup() : \Charcoal\Admin\Widget\FormPropertyWidget

Clear the input's parent group.

Returns

Chainable

setData()

setData(array|\Charcoal\Admin\Widget\ArrayAccess  $data) : \Charcoal\Admin\Widget\FormPropertyWidget

Set the widget and property data.

Parameters

Returns

Chainable

merge()

merge(array|\Traversable  $data) : \Charcoal\Admin\Widget\FormPropertyWidget

Merge widget and property data.

Parameters

Returns

Chainable

setPropertyType()

setPropertyType(string  $type) : \Charcoal\Admin\Widget\FormPropertyWidget

Set the model's property type.

Parameters

Throws

\InvalidArgumentException

If the argument is not a string.

Returns

Chainable

propertyType()

propertyType() : string|null

Retrieve the model's property type.

Returns

setPropertyIdent()

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

Set the form's property identifier.

Parameters

Throws

\InvalidArgumentException

If the property ident is not a string.

Returns

Chainable

propertyIdent()

propertyIdent() : string|null

Retrieve the form's property identifier.

Returns

setPropertyData()

setPropertyData(array  $data) : \Charcoal\Admin\Widget\FormPropertyWidget

Set the property metadata.

Parameters

Returns

Chainable

mergePropertyData()

mergePropertyData(array  $data) : \Charcoal\Admin\Widget\FormPropertyWidget

Merge the property metadata.

Parameters

Returns

Chainable

propertyData()

propertyData() : array

Retrieve the property metadata.

Returns

setPropertyVal()

setPropertyVal(mixed  $propertyVal) : \Charcoal\Admin\Widget\FormPropertyWidget

Set the property's value.

Parameters

Returns

Chainable

propertyVal()

propertyVal() : mixed

Retrieve the property's value.

Returns

setShowDescription()

setShowDescription(boolean  $show) : \Charcoal\Admin\Widget\FormPropertyWidget

Show/hide the property's description.

Parameters

Returns

Chainable

showDescription()

showDescription() : boolean

Determine if the description is to be displayed.

Returns

If TRUE or unset, check if there is a description.

setShowNotes()

setShowNotes(boolean|string  $show) : \Charcoal\Admin\Widget\FormPropertyWidget

Show/hide the property's notes.

Parameters

Returns

Chainable

showNotes()

showNotes() : boolean

Determine if the notes is to be displayed.

Returns

If TRUE or unset, check if there are notes.

showNotesAbove()

showNotesAbove() : boolean

Returns

description()

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

Returns

notes()

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

Returns

hidden()

hidden() : boolean

Returns

inputId()

inputId() : string

Returns

inputName()

inputName() : string

Returns

displayId()

displayId() : string

Returns

displayName()

displayName() : string

Returns

setInputType()

setInputType(string  $type) : \Charcoal\Admin\Widget\FormPropertyWidget

Set the property control type.

Parameters

Throws

\InvalidArgumentException

If the argument is not a string.

Returns

Chainable

inputType()

inputType() : string

Retrieve the property control type.

Returns

setDisplayType()

setDisplayType(string  $type) : \Charcoal\Admin\Widget\FormPropertyWidget

Set the property display type.

Parameters

Throws

\InvalidArgumentException

If the argument is not a string.

Returns

Chainable

displayType()

displayType() : string

Retrieve the property display type.

Returns

setProperty()

setProperty(\Charcoal\Property\PropertyInterface  $property) : \Charcoal\Admin\Widget\FormPropertyWidget

Set the widget's model property.

Parameters

Returns

Chainable

property()

property() : \Charcoal\Property\PropertyInterface

Retrieve the widget's model property.

Returns

prop()

prop() : \Charcoal\Property\PropertyInterface

Alias of {@see self::property()}

Returns

showActiveLanguage()

showActiveLanguage() : boolean

Determine if the form control's active language should be displayed.

Returns

setL10nMode()

setL10nMode(string  $mode) : \Charcoal\Admin\Widget\FormPropertyWidget

Set the L10N display mode.

Parameters

Returns

Chainable

l10nMode()

l10nMode() : string

Retrieve the L10N display mode.

Returns

loopL10n()

loopL10n() : boolean

Determine if the property should output for each language.

Returns

l10n()

l10n() : boolean

Alias of {@see PropertyInterface::l10n()}.

Returns

input()

input() : \Charcoal\Admin\Widget\PropertyInputInterface

Retrieve the form control property.

Returns

display()

display() : \Charcoal\Admin\Widget\PropertyDisplayInterface

Retrieve the display property.

Returns

output()

output() : \Charcoal\Admin\Widget\PropertyInputInterface|\Charcoal\Admin\Widget\PropertyDisplayInterface

Yield the property output.

Either a display property or a form control property.

Returns

setModelFactory()

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

Parameters

Returns

Chainable

modelFactory()

modelFactory() : \Charcoal\Factory\FactoryInterface

Returns

The model factory.

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

setPropertyFactory()

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

Set a property factory.

Parameters

Returns

Chainable

setPropertyInputFactory()

setPropertyInputFactory(\Charcoal\Factory\FactoryInterface  $factory) : \Charcoal\Admin\Widget\FormPropertyWidget

Set a property control factory.

Parameters

Returns

Chainable

setPropertyDisplayFactory()

setPropertyDisplayFactory(\Charcoal\Factory\FactoryInterface  $factory) : \Charcoal\Admin\Widget\FormPropertyWidget

Set a property display factory.

Parameters

Returns

Chainable

resolveOutputType()

resolveOutputType(string  $type) : string

Resolve the property output type.

Note: The "input_type" or "display_type" will be set if the output type is a valid output property.

Parameters

Throws

\InvalidArgumentException

If the property output type is invalid.

Returns

Returns either "input" or "display".

resolvedOutputType()

resolvedOutputType() : string|null

Retrieved the resolved the property output type.

Returns

Returns the property's "input_type" or "display_type".

setCoreData()

setCoreData(array  $data) : array

Set the core data for the widget and property's first.

Parameters

Returns

The widget and property data.

resolveInputType()

resolveInputType() : string

Resolve the property control type.

Returns

resolveDisplayType()

resolveDisplayType() : string

Resolve the property display type.

Returns

createProperty()

createProperty() : \Charcoal\Property\PropertyInterface

Create the widget's model property from the property's dataset.

Returns

createInputProperty()

createInputProperty() : \Charcoal\Admin\Widget\PropertyInputInterface

Create the widget's form control property.

Returns

createDisplayProperty()

createDisplayProperty() : \Charcoal\Admin\Widget\PropertyDisplayInterface

Create the widget's display property.

Returns