FieldInfo
in package
Read onlyYes
FinalYes
Read-only snapshot of a form field's properties.
Table of Contents
Properties
- $flags : int
- $maxLen : int|null
- $name : string
- $options : array<string|int, mixed>|null
- $rect : array<string|int, mixed>|null
- $type : FieldType
- $value : string|null
Methods
- __construct() : mixed
Properties
$flags
public
int
$flags
= 0
$maxLen
public
int|null
$maxLen
= null
$name
public
string
$name
$options
public
array<string|int, mixed>|null
$options
= null
$rect
public
array<string|int, mixed>|null
$rect
= null
$type
public
FieldType
$type
$value
public
string|null
$value
= null
Methods
__construct()
public
__construct(string $name, FieldType $type[, string|null $value = null ][, int $flags = 0 ][, array<string|int, float>|null $rect = null ][, int|null $maxLen = null ][, array<string|int, string>|null $options = null ]) : mixed
Parameters
- $name : string
-
Fully qualified field name (dot-separated for hierarchical fields)
- $type : FieldType
-
Field type (Text, Button, Choice, Signature)
- $value : string|null = null
-
Current value as string, or null if unset
- $flags : int = 0
-
Field flags (/Ff)
- $rect : array<string|int, float>|null = null
-
Widget rectangle [x1, y1, x2, y2], or null if no widget
- $maxLen : int|null = null
-
Maximum length for text fields
- $options : array<string|int, string>|null = null
-
Available options for choice fields