AvatarField
in package
implements
FieldInterface
Uses
FieldTrait
FinalYes
Tags
Table of Contents
Interfaces
Constants
- OPTION_HEIGHT = 'height'
- OPTION_IS_GRAVATAR_EMAIL = 'isGravatarEmail'
Properties
Methods
- addCssClass() : self
- addCssFiles() : self
- addFormTheme() : self
- addHtmlContentsToBody() : self
- addHtmlContentsToHead() : self
- addJsFiles() : self
- addWebpackEncoreEntries() : self
- formatValue() : self
- getAsDto() : FieldDto
- hideOnDetail() : self
- hideOnForm() : self
- hideOnIndex() : self
- hideWhenCreating() : self
- hideWhenUpdating() : self
- new() : self
- onlyOnDetail() : self
- onlyOnForms() : self
- onlyOnIndex() : self
- onlyWhenCreating() : self
- onlyWhenUpdating() : self
- setColumns() : self
- setCssClass() : self
- setCustomOption() : self
- setCustomOptions() : self
- setDisabled() : self
- setEmptyData() : self
- setFieldFqcn() : self
- setFormattedValue() : self
- setFormType() : self
- setFormTypeOption() : self
- setFormTypeOptionIfNotSet() : self
- setFormTypeOptions() : self
- setHeight() : self
- setHelp() : self
- setIsGravatarEmail() : self
- setLabel() : self
- setPermission() : self
- setProperty() : self
- setRequired() : self
- setSortable() : self
- setTemplateName() : self
- setTemplatePath() : self
- setTextAlign() : self
- setTranslationParameters() : self
- setValue() : self
- setVirtual() : self
- __construct() : mixed
Constants
OPTION_HEIGHT
public
mixed
OPTION_HEIGHT
= 'height'
OPTION_IS_GRAVATAR_EMAIL
public
mixed
OPTION_IS_GRAVATAR_EMAIL
= 'isGravatarEmail'
Properties
$dto
private
FieldDto
$dto
Methods
addCssClass()
public
addCssClass(string $cssClass) : self
Parameters
- $cssClass : string
Return values
selfaddCssFiles()
public
addCssFiles(Asset|string ...$pathsOrAssets) : self
Parameters
- $pathsOrAssets : Asset|string
Return values
selfaddFormTheme()
public
addFormTheme(string ...$formThemePaths) : self
Parameters
- $formThemePaths : string
Return values
selfaddHtmlContentsToBody()
public
addHtmlContentsToBody(string ...$contents) : self
Parameters
- $contents : string
Return values
selfaddHtmlContentsToHead()
public
addHtmlContentsToHead(string ...$contents) : self
Parameters
- $contents : string
Return values
selfaddJsFiles()
public
addJsFiles(Asset|string ...$pathsOrAssets) : self
Parameters
- $pathsOrAssets : Asset|string
Return values
selfaddWebpackEncoreEntries()
public
addWebpackEncoreEntries(Asset|string ...$entryNamesOrAssets) : self
Parameters
- $entryNamesOrAssets : Asset|string
Return values
selfformatValue()
public
formatValue(callable|null $callable) : self
Parameters
- $callable : callable|null
Return values
selfgetAsDto()
public
getAsDto() : FieldDto
Return values
FieldDtohideOnDetail()
public
hideOnDetail() : self
Return values
selfhideOnForm()
public
hideOnForm() : self
Return values
selfhideOnIndex()
public
hideOnIndex() : self
Return values
selfhideWhenCreating()
public
hideWhenCreating() : self
Return values
selfhideWhenUpdating()
public
hideWhenUpdating() : self
Return values
selfnew()
public
static new(string $propertyName[, TranslatableInterface|string|false|null $label = null ]) : self
Parameters
- $propertyName : string
- $label : TranslatableInterface|string|false|null = null
Return values
selfonlyOnDetail()
public
onlyOnDetail() : self
Return values
selfonlyOnForms()
public
onlyOnForms() : self
Return values
selfonlyOnIndex()
public
onlyOnIndex() : self
Return values
selfonlyWhenCreating()
public
onlyWhenCreating() : self
Return values
selfonlyWhenUpdating()
public
onlyWhenUpdating() : self
Return values
selfsetColumns()
public
setColumns(int|string $cols) : self
Parameters
- $cols : int|string
-
An integer with the number of columns that this field takes (e.g. 6), or a string with responsive col CSS classes (e.g. 'col-6 col-sm-4 col-lg-3')
Return values
selfsetCssClass()
public
setCssClass(string $cssClass) : self
Parameters
- $cssClass : string
Return values
selfsetCustomOption()
public
setCustomOption(string $optionName, mixed $optionValue) : self
Parameters
- $optionName : string
- $optionValue : mixed
Return values
selfsetCustomOptions()
public
setCustomOptions(array<string|int, mixed> $options) : self
Parameters
- $options : array<string|int, mixed>
Return values
selfsetDisabled()
public
setDisabled([bool $disabled = true ]) : self
Parameters
- $disabled : bool = true
Return values
selfsetEmptyData()
public
setEmptyData([mixed $emptyData = null ]) : self
Parameters
- $emptyData : mixed = null
Return values
selfsetFieldFqcn()
public
setFieldFqcn(string $fieldFqcn) : self
Parameters
- $fieldFqcn : string
Return values
selfsetFormattedValue()
public
setFormattedValue(mixed $value) : self
Parameters
- $value : mixed
Return values
selfsetFormType()
public
setFormType(string $formTypeFqcn) : self
Parameters
- $formTypeFqcn : string
Return values
selfsetFormTypeOption()
public
setFormTypeOption(string $optionName, mixed $optionValue) : self
Parameters
- $optionName : string
-
You can use "dot" notation to set nested options (e.g. 'attr.class')
- $optionValue : mixed
Return values
selfsetFormTypeOptionIfNotSet()
public
setFormTypeOptionIfNotSet(string $optionName, mixed $optionValue) : self
Parameters
- $optionName : string
-
You can use "dot" notation to set nested options (e.g. 'attr.class')
- $optionValue : mixed
Return values
selfsetFormTypeOptions()
public
setFormTypeOptions(array<string|int, mixed> $options) : self
Parameters
- $options : array<string|int, mixed>
Return values
selfsetHeight()
public
setHeight(mixed $heightInPixels) : self
Parameters
- $heightInPixels : mixed
Return values
selfsetHelp()
public
setHelp(TranslatableInterface|string $help) : self
Parameters
- $help : TranslatableInterface|string
Return values
selfsetIsGravatarEmail()
public
setIsGravatarEmail([bool $isGravatar = true ]) : self
Parameters
- $isGravatar : bool = true
Return values
selfsetLabel()
public
setLabel(TranslatableInterface|string|false|null $label) : self
Parameters
- $label : TranslatableInterface|string|false|null
Return values
selfsetPermission()
public
setPermission(string $permission) : self
Parameters
- $permission : string
Return values
selfsetProperty()
public
setProperty(string $propertyName) : self
Parameters
- $propertyName : string
Return values
selfsetRequired()
public
setRequired(bool $isRequired) : self
Parameters
- $isRequired : bool
Return values
selfsetSortable()
public
setSortable(bool $isSortable) : self
Parameters
- $isSortable : bool
Return values
selfsetTemplateName()
public
setTemplateName(string $name) : self
Parameters
- $name : string
Return values
selfsetTemplatePath()
public
setTemplatePath(string $path) : self
Parameters
- $path : string
Return values
selfsetTextAlign()
public
setTextAlign(string $textAlign) : self
Parameters
- $textAlign : string
-
It can be 'left', 'center' or 'right'
Return values
selfsetTranslationParameters()
public
setTranslationParameters(array<string|int, mixed> $parameters) : self
Parameters
- $parameters : array<string|int, mixed>
Return values
selfsetValue()
public
setValue(mixed $value) : self
Parameters
- $value : mixed
Return values
selfsetVirtual()
public
setVirtual(bool $isVirtual) : self
Parameters
- $isVirtual : bool
Return values
self__construct()
private
__construct() : mixed