Documentation

LanguageField
in package
implements FieldInterface Uses FieldTrait

FinalYes
Tags
author

Javier Eguiluz javier.eguiluz@gmail.com

Table of Contents

Interfaces

FieldInterface

Constants

FORMAT_ISO_639_ALPHA2  = 'iso639Alpha2'
FORMAT_ISO_639_ALPHA3  = 'iso639Alpha3'
OPTION_LANGUAGE_CODE_FORMAT  = 'languageCodeFormat'
OPTION_LANGUAGE_CODES_TO_KEEP  = 'languageCodesToKeep'
OPTION_LANGUAGE_CODES_TO_REMOVE  = 'languageCodesToRemove'
OPTION_SHOW_CODE  = 'showCode'
OPTION_SHOW_NAME  = 'showName'

Properties

$dto  : FieldDto

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
includeOnly()  : self
Restricts the list of languages shown by the field to the given list of languages codes.
new()  : self
onlyOnDetail()  : self
onlyOnForms()  : self
onlyOnIndex()  : self
onlyWhenCreating()  : self
onlyWhenUpdating()  : self
remove()  : self
Removes the given list of languages codes from the languages displayed by the field.
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
setLabel()  : self
setPermission()  : self
setProperty()  : self
setRequired()  : self
setSortable()  : self
setTemplateName()  : self
setTemplatePath()  : self
setTextAlign()  : self
setTranslationParameters()  : self
setValue()  : self
setVirtual()  : self
showCode()  : self
showName()  : self
useAlpha3Codes()  : self
__construct()  : mixed

Constants

FORMAT_ISO_639_ALPHA2

public mixed FORMAT_ISO_639_ALPHA2 = 'iso639Alpha2'

FORMAT_ISO_639_ALPHA3

public mixed FORMAT_ISO_639_ALPHA3 = 'iso639Alpha3'

OPTION_LANGUAGE_CODE_FORMAT

public mixed OPTION_LANGUAGE_CODE_FORMAT = 'languageCodeFormat'

OPTION_LANGUAGE_CODES_TO_KEEP

public mixed OPTION_LANGUAGE_CODES_TO_KEEP = 'languageCodesToKeep'

OPTION_LANGUAGE_CODES_TO_REMOVE

public mixed OPTION_LANGUAGE_CODES_TO_REMOVE = 'languageCodesToRemove'

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

addWebpackEncoreEntries()

public addWebpackEncoreEntries(Asset|string ...$entryNamesOrAssets) : self
Parameters
$entryNamesOrAssets : Asset|string
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

includeOnly()

Restricts the list of languages shown by the field to the given list of languages codes.

public includeOnly(array<string|int, mixed> $countryCodesToKeep) : self

e.g. ->includeOnly(['de', 'en', 'fr']).

Parameters
$countryCodesToKeep : array<string|int, mixed>
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

remove()

Removes the given list of languages codes from the languages displayed by the field.

public remove(array<string|int, mixed> $countryCodesToRemove) : self

e.g. ->remove(['de', 'fr']).

Parameters
$countryCodesToRemove : array<string|int, mixed>
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

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

showCode()

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

showName()

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

useAlpha3Codes()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results