SDK for PHP 3.x

RulesetParameter
in package

Houses properties of an individual parameter definition.

Table of Contents

Methods

__construct()  : mixed
getBuiltIn()  : mixed
getDefault()  : mixed
getDeprecated()  : bool
getDocumentation()  : string
getName()  : mixed
getRequired()  : bool
getType()  : mixed
validateInputParam()  : void
Validates that an input parameter matches the type provided in its definition.

Methods

__construct()

public __construct(mixed $name, array<string|int, mixed> $definition) : mixed
Parameters
$name : mixed
$definition : array<string|int, mixed>

getBuiltIn()

public getBuiltIn() : mixed

getDefault()

public getDefault() : mixed

getDeprecated()

public getDeprecated() : bool
Return values
bool

getDocumentation()

public getDocumentation() : string
Return values
string

getName()

public getName() : mixed

getRequired()

public getRequired() : bool
Return values
bool

getType()

public getType() : mixed

validateInputParam()

Validates that an input parameter matches the type provided in its definition.

public validateInputParam(mixed $inputParam) : void
Parameters
$inputParam : mixed
Tags
throws
InvalidArgumentException
On this page