Documentation

FieldDto
in package

FinalYes
Tags
author

Javier Eguiluz javier.eguiluz@gmail.com

Table of Contents

Properties

$assets  : AssetsDto
$columns  : string|null
$cssClass  : string
$customOptions  : KeyValueStore
$defaultColumns  : string
$displayedOn  : KeyValueStore
$doctrineMetadata  : KeyValueStore
$fieldFqcn  : string|null
$formattedValue  : mixed
$formatValueCallable  : mixed
$formThemePaths  : array<string|int, mixed>
$formType  : string|null
$formTypeOptions  : KeyValueStore
$help  : mixed
$label  : mixed
$permission  : string|null
$propertyName  : string|null
$sortable  : bool|null
$templateName  : string|null
$templatePath  : string|null
$textAlign  : string|null
$translationParameters  : array<string|int, mixed>
$value  : mixed
$virtual  : bool|null

Methods

__clone()  : mixed
__construct()  : mixed
addCssAsset()  : void
addFormTheme()  : void
addHtmlContentToBody()  : void
addHtmlContentToHead()  : void
addJsAsset()  : void
addWebpackEncoreAsset()  : void
getAssets()  : AssetsDto
getColumns()  : string|null
getCssClass()  : string
getCustomOption()  : mixed
getCustomOptions()  : KeyValueStore
getDefaultColumns()  : string
getDisplayedOn()  : KeyValueStore
getDoctrineMetadata()  : KeyValueStore
getFieldFqcn()  : string|null
getFormattedValue()  : mixed
Returns the value to be displayed for the field (it could be the same as the value stored in the field or not).
getFormatValueCallable()  : callable|null
getFormThemes()  : array<string|int, mixed>
getFormType()  : string|null
getFormTypeOption()  : mixed
getFormTypeOptions()  : array<string|int, mixed>
getHelp()  : TranslatableInterface|string|null
getLabel()  : TranslatableInterface|string|false|null
getPermission()  : string|null
getProperty()  : string
getTemplateName()  : string|null
getTemplatePath()  : string|null
getTextAlign()  : string|null
getTranslationParameters()  : array<string|int, mixed>
getUniqueId()  : string
getValue()  : mixed
Returns the original unmodified value stored in the entity field.
isDisplayedOn()  : bool
isFormDecorationField()  : bool
isSortable()  : bool|null
isVirtual()  : bool|null
setAssets()  : void
setColumns()  : void
setCssClass()  : void
setCustomOption()  : void
setCustomOptions()  : void
setDefaultColumns()  : void
setDisplayedOn()  : void
setDoctrineMetadata()  : void
setFormattedValue()  : void
setFormatValueCallable()  : void
setFormThemes()  : void
setFormType()  : void
setFormTypeOption()  : void
setFormTypeOptionIfNotSet()  : void
setFormTypeOptions()  : void
setHelp()  : void
setLabel()  : void
setPermission()  : void
setProperty()  : void
setSortable()  : void
setTemplateName()  : void
setTemplatePath()  : void
setTextAlign()  : void
setTranslationParameters()  : void
setUniqueId()  : void
setValue()  : void
setVirtual()  : void

Properties

$columns

private string|null $columns = null

$defaultColumns

private string $defaultColumns = ''

$fieldFqcn

private string|null $fieldFqcn = null

$formattedValue

private mixed $formattedValue = null

$formatValueCallable

private mixed $formatValueCallable

$formThemePaths

private array<string|int, mixed> $formThemePaths = []

$formType

private string|null $formType = null

$permission

private string|null $permission = null

$propertyName

private string|null $propertyName = null

$sortable

private bool|null $sortable = null

$templateName

private string|null $templateName = 'crud/field/text'

$templatePath

private string|null $templatePath = null

$textAlign

private string|null $textAlign = null

$translationParameters

private array<string|int, mixed> $translationParameters = []

$virtual

private bool|null $virtual = null

Methods

__construct()

public __construct() : mixed

addFormTheme()

public addFormTheme(string $formThemePath) : void
Parameters
$formThemePath : string

addHtmlContentToBody()

public addHtmlContentToBody(string $htmlContent) : void
Parameters
$htmlContent : string

addHtmlContentToHead()

public addHtmlContentToHead(string $htmlContent) : void
Parameters
$htmlContent : string

getColumns()

public getColumns() : string|null
Return values
string|null

getCssClass()

public getCssClass() : string
Return values
string

getCustomOption()

public getCustomOption(string $optionName) : mixed
Parameters
$optionName : string

getDefaultColumns()

public getDefaultColumns() : string
Return values
string

getFieldFqcn()

public getFieldFqcn() : string|null
Return values
string|null

getFormattedValue()

Returns the value to be displayed for the field (it could be the same as the value stored in the field or not).

public getFormattedValue() : mixed

getFormatValueCallable()

public getFormatValueCallable() : callable|null
Return values
callable|null

getFormThemes()

public getFormThemes() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFormType()

public getFormType() : string|null
Return values
string|null

getFormTypeOption()

public getFormTypeOption(string $optionName) : mixed
Parameters
$optionName : string

getFormTypeOptions()

public getFormTypeOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPermission()

public getPermission() : string|null
Return values
string|null

getProperty()

public getProperty() : string
Return values
string

getTemplateName()

public getTemplateName() : string|null
Return values
string|null

getTemplatePath()

public getTemplatePath() : string|null
Return values
string|null

getTextAlign()

public getTextAlign() : string|null
Return values
string|null

getTranslationParameters()

public getTranslationParameters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getUniqueId()

public getUniqueId() : string
Return values
string

getValue()

Returns the original unmodified value stored in the entity field.

public getValue() : mixed

isDisplayedOn()

public isDisplayedOn(string $pageName) : bool
Parameters
$pageName : string
Return values
bool

isFormDecorationField()

public isFormDecorationField() : bool
Return values
bool

isSortable()

public isSortable() : bool|null
Return values
bool|null

isVirtual()

public isVirtual() : bool|null
Return values
bool|null

setColumns()

public setColumns(string|null $columnCssClasses) : void
Parameters
$columnCssClasses : string|null

setCssClass()

public setCssClass(string $cssClass) : void
Parameters
$cssClass : string

setCustomOption()

public setCustomOption(string $optionName, mixed $optionValue) : void
Parameters
$optionName : string
$optionValue : mixed

setCustomOptions()

public setCustomOptions(array<string|int, mixed> $customOptions) : void
Parameters
$customOptions : array<string|int, mixed>

setDefaultColumns()

public setDefaultColumns(string $columnCssClasses) : void
Parameters
$columnCssClasses : string

setDoctrineMetadata()

public setDoctrineMetadata(array<string|int, mixed> $metadata) : void
Parameters
$metadata : array<string|int, mixed>

setFormattedValue()

public setFormattedValue(mixed $formattedValue) : void
Parameters
$formattedValue : mixed

setFormatValueCallable()

public setFormatValueCallable(callable|null $callable) : void
Parameters
$callable : callable|null

setFormThemes()

public setFormThemes(array<string|int, mixed> $formThemePaths) : void
Parameters
$formThemePaths : array<string|int, mixed>

setFormType()

public setFormType(string $formTypeFqcn) : void
Parameters
$formTypeFqcn : string

setFormTypeOption()

public setFormTypeOption(string $optionName, mixed $optionValue) : void
Parameters
$optionName : string

You can use "dot" notation to set nested options (e.g. 'attr.class')

$optionValue : mixed

setFormTypeOptionIfNotSet()

public setFormTypeOptionIfNotSet(string $optionName, mixed $optionValue) : void
Parameters
$optionName : string

You can use "dot" notation to set nested options (e.g. 'attr.class')

$optionValue : mixed

setFormTypeOptions()

public setFormTypeOptions(array<string|int, mixed> $formTypeOptions) : void
Parameters
$formTypeOptions : array<string|int, mixed>

setLabel()

public setLabel(mixed $label) : void
Parameters
$label : mixed

setPermission()

public setPermission(string $permission) : void
Parameters
$permission : string

setProperty()

public setProperty(string $propertyName) : void
Parameters
$propertyName : string

setSortable()

public setSortable(bool $isSortable) : void
Parameters
$isSortable : bool

setTemplateName()

public setTemplateName(string|null $templateName) : void
Parameters
$templateName : string|null

setTemplatePath()

public setTemplatePath(string|null $templatePath) : void
Parameters
$templatePath : string|null

setTextAlign()

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

setTranslationParameters()

public setTranslationParameters(array<string|int, mixed> $translationParameters) : void
Parameters
$translationParameters : array<string|int, mixed>

setUniqueId()

public setUniqueId(string $uniqueId) : void
Parameters
$uniqueId : string

setValue()

public setValue(mixed $value) : void
Parameters
$value : mixed

setVirtual()

public setVirtual(bool $isVirtual) : void
Parameters
$isVirtual : bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results