ChoiceFieldOptions
in package
FinalYes
Options for {@see \Phpdftk\Pdf\Writer\PdfDoc::addChoiceField()}.
$choices is a list of [value, displayLabel] pairs (or plain
strings, in which case the same value is used for both). combo
controls whether the field renders as a drop-down combo box (true)
or a scrolling list box (false).
Table of Contents
Properties
- $choices : array<string|int, mixed>
- $combo : bool
- $defaultValue : string|null
- $editable : bool
- $multiSelect : bool
- $readOnly : bool
- $required : bool
- $sort : bool
Methods
- __construct() : mixed
Properties
$choices read-only
public
array<string|int, mixed>
$choices
$combo read-only
public
bool
$combo
= true
$defaultValue read-only
public
string|null
$defaultValue
= null
$editable read-only
public
bool
$editable
= false
$multiSelect read-only
public
bool
$multiSelect
= false
$readOnly read-only
public
bool
$readOnly
= false
$required read-only
public
bool
$required
= false
$sort read-only
public
bool
$sort
= false
Methods
__construct()
public
__construct(array<int, string|array{0: string, 1: string}> $choices[, string|null $defaultValue = null ][, bool $combo = true ][, bool $editable = false ][, bool $sort = false ][, bool $multiSelect = false ][, bool $required = false ][, bool $readOnly = false ]) : mixed
Parameters
- $choices : array<int, string|array{0: string, 1: string}>
- $defaultValue : string|null = null
- $combo : bool = true
- $editable : bool = false
- $sort : bool = false
- $multiSelect : bool = false
- $required : bool = false
- $readOnly : bool = false