Documentation

GuiSpecTrait

If a field will be presented in GUIs (e.g. data-entry fields or data-columns), then use GuiSpecTrait to describe its typical/default appearance.

.

Table of Contents

Properties

$helpPost  : string
$helpPre  : string
$inputAttrs  : array<string|int, mixed>
$inputType  : string
Default widget to use when presenting this field.
$label  : string
User-facing label, shown on most forms and displays
$localizable  : bool
Can the field be translated.

Methods

getInputAttrs()  : array<string|int, mixed>
getInputType()  : string
getLabel()  : string
getLocalizable()  : bool
setHelpPost()  : mixed
setHelpPre()  : mixed
setInputAttr()  : $this
setInputAttrs()  : $this
setInputType()  : $this
setLabel()  : $this
setLocalizable()  : $this

Properties

$inputAttrs

public array<string|int, mixed> $inputAttrs = []

$inputType

Default widget to use when presenting this field.

public string $inputType

Ex: 'RichTextEditor'

$label

User-facing label, shown on most forms and displays

public string $label

Default label to use when presenting this field to an end-user (e.g. on a data-entry form or a data-column view).

$localizable

Can the field be translated.

public bool $localizable = FALSE

Methods

getInputAttrs()

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

getInputType()

public getInputType() : string
Return values
string

getLabel()

public getLabel() : string
Return values
string

getLocalizable()

public getLocalizable() : bool
Return values
bool

setHelpPost()

public setHelpPost(string|null $helpPost) : mixed
Parameters
$helpPost : string|null

setHelpPre()

public setHelpPre(string|null $helpPre) : mixed
Parameters
$helpPre : string|null

setInputAttr()

public setInputAttr(string $attrName, mixed $attrValue) : $this
Parameters
$attrName : string
$attrValue : mixed
Return values
$this

setInputAttrs()

public setInputAttrs(array<string|int, mixed> $inputAttrs) : $this
Parameters
$inputAttrs : array<string|int, mixed>
Return values
$this

setInputType()

public setInputType(string $inputType) : $this
Parameters
$inputType : string
Return values
$this

setLabel()

public setLabel(string $label) : $this
Parameters
$label : string
Return values
$this

setLocalizable()

public setLocalizable(bool $localizable) : $this
Parameters
$localizable : bool
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results