ConnectionField
in package
Read onlyYes
FinalYes
One configuration value of an external connection (e.g. the reCAPTCHA site key).
The field list lives in code, not in the database: the stored JSON only carries values, so the administration knows how to label, validate and mask each of them.
Table of Contents
Properties
- $kind : ConnectionFieldKind
- $name : string
- $public : bool
- May the value reach the browser (page source)? Secrets never do.
- $required : bool
Methods
- __construct() : mixed
- isPublic() : bool
- Public only when declared so AND not a secret — a secret can never be exposed.
- isSecret() : bool
Properties
$kind
public
ConnectionFieldKind
$kind
= ConnectionFieldKind::Text
$name
public
string
$name
$public
May the value reach the browser (page source)? Secrets never do.
public
bool
$public
= false
$required
public
bool
$required
= false
Methods
__construct()
public
__construct(string $name[, ConnectionFieldKind $kind = ConnectionFieldKind::Text ][, bool $required = false ][, bool $public = false ]) : mixed
Parameters
- $name : string
- $kind : ConnectionFieldKind = ConnectionFieldKind::Text
- $required : bool = false
- $public : bool = false
isPublic()
Public only when declared so AND not a secret — a secret can never be exposed.
public
isPublic() : bool
Return values
boolisSecret()
public
isSecret() : bool