\Charcoal\Admin\Property\InputImageInput

setStyleAttr()

setStyleAttr(string|array<mixed,string>  $styles) : \Charcoal\Admin\Ui\ImageDisplay

Set the CSS styling declarations to apply on the image.

Parameters

Returns

Chainable

styleAttr()

styleAttr() : string

Retrieve the CSS styling declarations for the HTML `style` attribute.

Returns

setClassAttr()

setClassAttr(string|array<mixed,string>  $classes) : \Charcoal\Admin\Property\Input\ImageDisplay

Set the CSS classes to apply on the image.

Parameters

Returns

Chainable

classAttr()

classAttr() : string

Retrieve the CSS classes for the HTML `class` attribute.

Returns

setWidth()

setWidth(mixed  $width) : \Charcoal\Admin\Ui\ImageDisplay

Set the display width of the image.

If integer specified, 'px' will be append to it.

Parameters

Returns

Chainable

width()

width() : string

Retrieve the display width of the image.

Returns

setHeight()

setHeight(mixed  $height) : \Charcoal\Admin\Ui\ImageDisplay

Set the display height of the image.

If integer specified, 'px' will be append to it.

Parameters

Returns

Chainable

height()

height() : string

Retrieve the display width of the image.

Returns

setMaxWidth()

setMaxWidth(mixed  $width) : \Charcoal\Admin\Ui\ImageDisplay

Set the maximum width to display the image.

If integer specified, 'px' will be append to it.

Parameters

Returns

Chainable

maxWidth()

maxWidth() : string

Retrieve the maximum width to display the image.

Returns

setMaxHeight()

setMaxHeight(mixed  $height) : \Charcoal\Admin\Ui\ImageDisplay

Set the maximum height to display the image.

If integer specified, 'px' will be append to it.

Parameters

Returns

Chainable

maxHeight()

maxHeight() : string

Retrieve the maximum height to display the image.

Returns

setDependencies()

setDependencies(\Pimple\Container  $container) : void

Inject dependencies from a DI Container.

Parameters

type()

type() : string

Retrieve the control type for the HTML element `<input>`.

Returns

abridgedInputVal()

abridgedInputVal() : string|null

Returns

filePreview()

filePreview() : string|null

Returns

previewVal()

previewVal() : string

Retrieve input value for file preview.

Returns

setShowFilePreview()

setShowFilePreview(boolean  $show) : \Charcoal\Admin\Property\Input\FileInput

Parameters

Returns

Chainable

showFilePreview()

showFilePreview() : boolean

Returns

setShowFileUpload()

setShowFileUpload(boolean  $show) : \Charcoal\Admin\Property\Input\FileInput

Parameters

Returns

Chainable

showFileUpload()

showFileUpload() : boolean

Returns

setShowFilePicker()

setShowFilePicker(boolean  $show) : \Charcoal\Admin\Property\Input\FileInput

Parameters

Returns

Chainable

showFilePicker()

showFilePicker() : boolean

Returns

setDialogTitle()

setDialogTitle(string|array<mixed,string>  $title) : self

Set the title for the file picker dialog.

Parameters

Returns

dialogTitle()

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

Retrieve the title for the file picker dialog.

Returns

setChooseButtonLabel()

setChooseButtonLabel(string|array<mixed,string>  $label) : self

Set the label for the file picker button.

Parameters

Returns

chooseButtonLabel()

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

Retrieve the label for the file picker button.

Returns

setRemoveButtonLabel()

setRemoveButtonLabel(string|array<mixed,string>  $label) : self

Set the label for the file removal button.

Parameters

Returns

removeButtonLabel()

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

Retrieve the label for the file removal button.

Returns

__construct()

__construct(array|\ArrayAccess  $data = null) 

Parameters

setData()

setData(array  $data) : \Charcoal\Admin\Property\AbstractPropertyInput

This function takes an array and fill the model object with its value.

This method either calls a setter for each key (set_{$key}()) or sets a public member.

For example, calling with setData(['properties'=>$properties]) would call setProperties($properties), becasue setProperties() exists.

But calling with setData(['foobar'=>$foo]) would set the $foobar member on the metadata object, because the method set_foobar() does not exist.

Parameters

Returns

Chainable

setPropertyVal()

setPropertyVal(mixed  $val) : \Charcoal\Admin\Property\PropertyInputInterface

Parameters

Returns

Chainable

propertyVal()

propertyVal() : mixed

Returns

setLang()

setLang(string  $lang) : \Charcoal\Admin\Property\PropertyInputInterface

Parameters

Returns

Chainable

lang()

lang() : string

Get the input language

Returns

hidden()

hidden() : boolean

Returns

setIdent()

setIdent(string  $ident) : \Charcoal\Admin\Property\Widget

Parameters

Throws

\InvalidArgumentException

If the ident is not a string.

Returns

Chainable

ident()

ident() : string

Returns

setReadOnly()

setReadOnly(boolean  $readOnly) : \Charcoal\Admin\Property\Widget

Parameters

Returns

(Chainable)

readOnly()

readOnly() : boolean

Returns

setRequired()

setRequired(boolean  $required) : \Charcoal\Admin\Property\Widget

Parameters

Returns

(Chainable)

required()

required() : boolean

Returns

setDisabled()

setDisabled(boolean  $disabled) : \Charcoal\Admin\Property\Widget

Parameters

Returns

(Chainable)

disabled()

disabled() : boolean

Returns

setMultiple()

setMultiple(boolean  $multiple) : \Charcoal\Admin\Property\Widget

Parameters

Returns

(Chainable)

multiple()

multiple() : boolean

Returns

setPlaceholder()

setPlaceholder(mixed  $placeholder) : \Charcoal\Admin\Property\AbstractPropertyInput

Set the form control's placeholder.

A placeholder is a hint to the user of what can be entered in the property control.

Parameters

Returns

Chainable

placeholder()

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

Retrieve the placeholder.

Returns

setInputId()

setInputId(string  $inputId) : \Charcoal\Admin\Property\AbstractPropertyInput

Set the input ID.

Used for the HTML "ID" attribute.

Parameters

Returns

Chainable

inputId()

inputId() : string

Retrieve the input ID.

If none was previously set then a unique random one will be generated.

Returns

setInputClass()

setInputClass(string  $inputClass) : \Charcoal\Admin\Property\AbstractPropertyInput

Parameters

Throws

\InvalidArgumentException

If the class is not a string.

Returns

Chainable

inputClass()

inputClass() : string

Returns

setInputName()

setInputName(string  $inputName) : \Charcoal\Admin\Property\AbstractPropertyInput

Set the input name.

Used for the HTML "name" attribute.

Parameters

Returns

Chainable

inputName()

inputName() : string

Retrieve the input name.

The input name should always be the property's ident.

Returns

inputVal()

inputVal() : string

Throws

\UnexpectedValueException

If the value is invalid.

Returns

setInputMode()

setInputMode(string  $inputMode) : \Charcoal\Admin\Property\AbstractPropertyInput

Set the hint to the browser for which keyboard to display.

Parameters

Throws

\InvalidArgumentException

If the provided argument is not a string.

Returns

Chainable

inputMode()

inputMode() : string

Retrieve the hint to the browser for which keyboard to display.

Returns

setInputType()

setInputType(string  $inputType) : \Charcoal\Admin\Property\AbstractPropertyInput

Parameters

Throws

\InvalidArgumentException

If the provided argument is not a string.

Returns

Chainable

inputType()

inputType() : string

Returns

hasInputAffix()

hasInputAffix() : boolean

Determine if the property has an affix.

Textual <input>s only

Avoid using <select> elements here as they cannot be fully styled in WebKit browsers.

Avoid using <textarea> elements here as their rows attribute will not be respected in some cases.

Returns

setInputPrefix()

setInputPrefix(mixed  $affix) : self

Retrieve the control's prefix.

Parameters

Throws

\InvalidArgumentException

If the suffix is not translatable.

Returns

inputPrefix()

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

Retrieve the control's prefix.

Returns

setInputSuffix()

setInputSuffix(mixed  $affix) : self

Retrieve the control's suffix.

Parameters

Throws

\InvalidArgumentException

If the suffix is not translatable.

Returns

inputSuffix()

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

Retrieve the control's suffix.

Returns

setType()

setType(string  $type) : \Charcoal\Admin\Property\AbstractPropertyInput

Set the control type for the HTML element `<input>`.

Parameters

Throws

\InvalidArgumentException

If the provided argument is not a string.

Returns

Chainable

propertyIdent()

propertyIdent() : string

Returns

setProperty()

setProperty(\Charcoal\Property\PropertyInterface  $p) : \Charcoal\Admin\Property\AbstractPropertyInput

Parameters

Returns

Chainable

property()

property() : \Charcoal\Property\PropertyInterface

Returns

p()

p() : \Charcoal\Property\PropertyInterface

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

Returns

renderTranslatableTemplate()

renderTranslatableTemplate(mixed  $templateString) : string

Render the given template from string.

Parameters

Returns

The rendered template.

defaultStyleAttr()

defaultStyleAttr() : string

Parse the CSS styling declarations from the property's display features.

Returns

parseStyleAttr()

parseStyleAttr(array<mixed,string>  $styles) : string

Parse the CSS styling declarations from the property's display features.

Parameters

Returns

isDataUri()

isDataUri(string  $val) : boolean

Determine if the value is a {@see @see http://en.wikipedia.org/wiki/Data_URI_scheme Data URI}.

Parameters

Returns

defaultDialogTitle()

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

Retrieve the default title for the file picker dialog.

Returns

defaultChooseButtonLabel()

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

Retrieve the default label for the file picker button.

Returns

defaultRemoveButtonLabel()

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

Retrieve the default label for the file removal button.

Returns

createMetadata()

createMetadata(array  $data = null) : \Charcoal\Property\PropertyMetadata

Parameters

Returns

generateInputId()

generateInputId() : string

Generate a unique input ID.

Returns

getter()

getter(string  $key) : string

Allow an object to define how the key getter are called.

Parameters

Returns

The getter method name, for a given key.

setter()

setter(string  $key) : string

Allow an object to define how the key setter are called.

Parameters

Returns

The setter method name, for a given key.

camelize()

camelize(string  $str) : string

Transform a snake_case string to camelCase.

Parameters

Returns

The camelCase string.