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.

getId()

No description

setId(string $id)

No description

getName()

No description

setName(string $name)

No description

string|null
getDescription()

No description

setDescription(string $description = null)

No description

getType()

No description

setType(string $type)

No description

isRequired()

No description

setRequired(bool $required)

No description

bool|int|string
getDefault()

No description

setDefault(bool|int|string $default)

No description

getOptions()

No description

setOptions(array $options)

No description

getLabels()

No description

setLabels(array $labels)

No description

jsonSerialize()

{@inheritdoc}

Details

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

Parameter constructor.

Parameters

string $id
string $name
string $type

at line 77
getId()

at line 85
Parameter setId(string $id)

Parameters

string $id

Return Value

Parameter

at line 92
getName()

at line 100
Parameter setName(string $name)

Parameters

string $name

Return Value

Parameter

at line 110
string|null getDescription()

Return Value

string|null

at line 118
Parameter setDescription(string $description = null)

Parameters

string $description

Return Value

Parameter

at line 125
getType()

at line 133
Parameter setType(string $type)

Parameters

string $type

Return Value

Parameter

at line 144
isRequired()

at line 152
Parameter setRequired(bool $required)

Parameters

bool $required

Return Value

Parameter

at line 162
bool|int|string getDefault()

Return Value

bool|int|string

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

Parameters

bool|int|string $default

Return Value

Parameter

at line 179
getOptions()

at line 187
Parameter setOptions(array $options)

Parameters

array $options

Return Value

Parameter

at line 194
getLabels()

at line 202
Parameter setLabels(array $labels)

Parameters

array $labels

Return Value

Parameter

at line 212
jsonSerialize()

{@inheritdoc}