BasicSpecTrait
Tags
Table of Contents
Properties
- $description : string
- Explanation of the purpose of the field.
- $name : string
- Symbolic name of the field.
- $title : string
- Backend-facing label. Shown in API, exports, and other configuration systems.
Methods
- getDescription() : string
- getName() : string
- getTitle() : string
- setDescription() : $this
- setName() : $this
- setTitle() : $this
Properties
$description
Explanation of the purpose of the field.
public
string
$description
$name
Symbolic name of the field.
public
string
$name
Ex: 'first_name'
$title
Backend-facing label. Shown in API, exports, and other configuration systems.
public
string
$title
If this field is presented to an administrator (e.g. when configuring a screen or configuring process-automation), how the field be entitled?
Ex: ts('First Name')
Methods
getDescription()
public
getDescription() : string
Return values
stringgetName()
public
getName() : string
Return values
stringgetTitle()
public
getTitle() : string
Return values
stringsetDescription()
public
setDescription(string $description) : $this
Parameters
- $description : string
Return values
$thissetName()
public
setName(string $name) : $this
Parameters
- $name : string
Return values
$thissetTitle()
public
setTitle(string $title) : $this
Parameters
- $title : string