Documentation

FormField
in package
implements FieldInterface Uses FieldTrait

FinalYes
Tags
author

Javier Eguiluz javier.eguiluz@gmail.com

Table of Contents

Interfaces

FieldInterface

Constants

OPTION_COLLAPSED  = 'collapsed'
OPTION_COLLAPSIBLE  = 'collapsible'
OPTION_ICON  = 'icon'
OPTION_ROW_BREAKPOINT  = 'rowBreakPoint'

Properties

$dto  : FieldDto

Methods

addCssClass()  : self
addCssFiles()  : self
addFormTheme()  : self
addHtmlContentsToBody()  : self
addHtmlContentsToHead()  : self
addJsFiles()  : self
addPanel()  : self
addRow()  : self
addTab()  : static
addWebpackEncoreEntries()  : self
collapsible()  : self
formatValue()  : self
getAsDto()  : FieldDto
hideOnDetail()  : self
hideOnForm()  : self
hideOnIndex()  : self
hideWhenCreating()  : self
hideWhenUpdating()  : self
onlyOnDetail()  : self
onlyOnForms()  : self
onlyOnIndex()  : self
onlyWhenCreating()  : self
onlyWhenUpdating()  : self
renderCollapsed()  : 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
setHelp()  : self
setIcon()  : 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
fixIconFormat()  : string|null
hasLabelOrIcon()  : bool

Constants

OPTION_COLLAPSED

public mixed OPTION_COLLAPSED = 'collapsed'

OPTION_COLLAPSIBLE

public mixed OPTION_COLLAPSIBLE = 'collapsible'

OPTION_ICON

public mixed OPTION_ICON = 'icon'

OPTION_ROW_BREAKPOINT

public mixed OPTION_ROW_BREAKPOINT = 'rowBreakPoint'

Properties

Methods

addCssClass()

public addCssClass(string $cssClass) : self
Parameters
$cssClass : string
Return values
self

addCssFiles()

public addCssFiles(Asset|string ...$pathsOrAssets) : self
Parameters
$pathsOrAssets : Asset|string
Return values
self

addFormTheme()

public addFormTheme(string ...$formThemePaths) : self
Parameters
$formThemePaths : string
Return values
self

addHtmlContentsToBody()

public addHtmlContentsToBody(string ...$contents) : self
Parameters
$contents : string
Return values
self

addHtmlContentsToHead()

public addHtmlContentsToHead(string ...$contents) : self
Parameters
$contents : string
Return values
self

addJsFiles()

public addJsFiles(Asset|string ...$pathsOrAssets) : self
Parameters
$pathsOrAssets : Asset|string
Return values
self

addPanel()

public static addPanel([TranslatableInterface|string|false|null $label = false ][, string|null $icon = null ]) : self
Parameters
$label : TranslatableInterface|string|false|null = false
$icon : string|null = null

The full CSS classes of the FontAwesome icon to render (see https://fontawesome.com/v6/search?m=free)

Return values
self

addRow()

public static addRow([string $breakpointName = '' ]) : self
Parameters
$breakpointName : string = ''

The name of the breakpoint where the new row is inserted It must be a valid Bootstrap 5 name ('', 'sm', 'md', 'lg', 'xl', 'xxl')

Return values
self

addWebpackEncoreEntries()

public addWebpackEncoreEntries(Asset|string ...$entryNamesOrAssets) : self
Parameters
$entryNamesOrAssets : Asset|string
Return values
self

collapsible()

public collapsible([bool $collapsible = true ]) : self
Parameters
$collapsible : bool = true
Return values
self

formatValue()

public formatValue(callable|null $callable) : self
Parameters
$callable : callable|null
Return values
self

hideOnDetail()

public hideOnDetail() : self
Return values
self

hideOnForm()

public hideOnForm() : self
Return values
self

hideOnIndex()

public hideOnIndex() : self
Return values
self

hideWhenCreating()

public hideWhenCreating() : self
Return values
self

hideWhenUpdating()

public hideWhenUpdating() : self
Return values
self

onlyOnDetail()

public onlyOnDetail() : self
Return values
self

onlyOnForms()

public onlyOnForms() : self
Return values
self

onlyOnIndex()

public onlyOnIndex() : self
Return values
self

onlyWhenCreating()

public onlyWhenCreating() : self
Return values
self

onlyWhenUpdating()

public onlyWhenUpdating() : self
Return values
self

renderCollapsed()

public renderCollapsed([bool $collapsed = true ]) : self
Parameters
$collapsed : bool = true
Return values
self

setColumns()

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
self

setCssClass()

public setCssClass(string $cssClass) : self
Parameters
$cssClass : string
Return values
self

setCustomOption()

public setCustomOption(string $optionName, mixed $optionValue) : self
Parameters
$optionName : string
$optionValue : mixed
Return values
self

setCustomOptions()

public setCustomOptions(array<string|int, mixed> $options) : self
Parameters
$options : array<string|int, mixed>
Return values
self

setDisabled()

public setDisabled([bool $disabled = true ]) : self
Parameters
$disabled : bool = true
Return values
self

setEmptyData()

public setEmptyData([mixed $emptyData = null ]) : self
Parameters
$emptyData : mixed = null
Return values
self

setFieldFqcn()

public setFieldFqcn(string $fieldFqcn) : self
Parameters
$fieldFqcn : string
Return values
self

setFormattedValue()

public setFormattedValue(mixed $value) : self
Parameters
$value : mixed
Return values
self

setFormType()

public setFormType(string $formTypeFqcn) : self
Parameters
$formTypeFqcn : string
Return values
self

setFormTypeOption()

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
self

setFormTypeOptionIfNotSet()

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
self

setFormTypeOptions()

public setFormTypeOptions(array<string|int, mixed> $options) : self
Parameters
$options : array<string|int, mixed>
Return values
self

setIcon()

public setIcon(string $iconCssClass) : self
Parameters
$iconCssClass : string
Return values
self

setPermission()

public setPermission(string $permission) : self
Parameters
$permission : string
Return values
self

setProperty()

public setProperty(string $propertyName) : self
Parameters
$propertyName : string
Return values
self

setRequired()

public setRequired(bool $isRequired) : self
Parameters
$isRequired : bool
Return values
self

setSortable()

public setSortable(bool $isSortable) : self
Parameters
$isSortable : bool
Return values
self

setTemplateName()

public setTemplateName(string $name) : self
Parameters
$name : string
Return values
self

setTemplatePath()

public setTemplatePath(string $path) : self
Parameters
$path : string
Return values
self

setTextAlign()

public setTextAlign(string $textAlign) : self
Parameters
$textAlign : string

It can be 'left', 'center' or 'right'

Return values
self

setTranslationParameters()

public setTranslationParameters(array<string|int, mixed> $parameters) : self
Parameters
$parameters : array<string|int, mixed>
Return values
self

setValue()

public setValue(mixed $value) : self
Parameters
$value : mixed
Return values
self

setVirtual()

public setVirtual(bool $isVirtual) : self
Parameters
$isVirtual : bool
Return values
self

fixIconFormat()

private fixIconFormat(string|null $icon, string $methodName) : string|null
Parameters
$icon : string|null
$methodName : string
Return values
string|null

hasLabelOrIcon()

private hasLabelOrIcon() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results