Field

Overview #

Field represents a single input field in a form (text input, password, checkbox, etc.).

Location: orchesty-php-sdk/src/Application/Model/Form/Field.php

Constructor #

public function __construct(
    string $type,
    string $key,
    string $label,
    mixed $value = null,
    bool $required = false
)

Parameter	Type	Description
$type	string	Field type (use constants)
$key	string	Unique field identifier
$label	string	Display label
$value	mixed	Default value
$required	bool	Whether field is required

Field Types #

Field::TEXT       // Text input
Field::NUMBER     // Number input
Field::URL        // URL input
Field::PASSWORD   // Password input (masked)
Field::SELECT_BOX // Dropdown select
Field::CHECKBOX   // Checkbox

Methods #

setValue() #

public function setValue(mixed $value): self

Sets the field value.

setDescription() #

public function setDescription(string $description): self

Sets field description/help text.

setReadOnly() #

public function setReadOnly(bool $readOnly): self

Makes field read-only.

setChoices() #

public function setChoices(array $choices): self

Sets choices for SELECT_BOX fields.

Usage Examples #

Text Field #

new Field(Field::TEXT, 'api_key', 'API Key', null, true)

Password Field #

new Field(Field::PASSWORD, 'password', 'Password', null, true)

Select Box #

$field = new Field(Field::SELECT_BOX, 'region', 'Region', 'us-east-1', false);
$field->setChoices(['us-east-1', 'us-west-1', 'eu-central-1']);

Checkbox #

new Field(Field::CHECKBOX, 'enable_logs', 'Enable Logging', false, false)