class Parameter implements JsonSerializable

Properties

protected string $id
protected string $name
protected string|null $description
protected string $type
protected bool $required
protected string|int|bool $default
protected array $options
protected array $labels
static protected string[] $validTypes

Methods

__construct(string $id, string $name, string $type)

Parameter constructor.

string
getId()

No description

setId(string $id)

No description

string
getName()

No description

setName(string $name)

No description

string|null
getDescription()

No description

setDescription(string $description = \null)

No description

string
getType()

No description

setType(string $type)

No description

bool
isRequired()

No description

setRequired(bool $required)

No description

bool|int|string
getDefault()

No description

setDefault(bool|int|string $default)

No description

array
getOptions()

No description

setOptions(array $options)

No description

array
getLabels()

No description

setLabels(array $labels)

No description

jsonSerialize()

{@inheritdoc}

Details

at line 73
__construct(string $id, string $name, string $type)

Parameter constructor.

Parameters

string $id
string $name
string $type

at line 84
string getId()

Return Value

string

at line 94
Parameter setId(string $id)

Parameters

string $id

Return Value

Parameter

at line 104
string getName()

Return Value

string

at line 114
Parameter setName(string $name)

Parameters

string $name

Return Value

Parameter

at line 124
string|null getDescription()

Return Value

string|null

at line 134
Parameter setDescription(string $description = \null)

Parameters

string $description

Return Value

Parameter

at line 144
string getType()

Return Value

string

at line 154
Parameter setType(string $type)

Parameters

string $type

Return Value

Parameter

at line 172
bool isRequired()

Return Value

bool

at line 182
Parameter setRequired(bool $required)

Parameters

bool $required

Return Value

Parameter

at line 192
bool|int|string getDefault()

Return Value

bool|int|string

at line 202
Parameter setDefault(bool|int|string $default)

Parameters

bool|int|string $default

Return Value

Parameter

at line 212
array getOptions()

Return Value

array

at line 222
Parameter setOptions(array $options)

Parameters

array $options

Return Value

Parameter

at line 232
array getLabels()

Return Value

array

at line 242
Parameter setLabels(array $labels)

Parameters

array $labels

Return Value

Parameter

at line 252
jsonSerialize()

{@inheritdoc}