class ParameterObject

Helper class to define object for webservice methods (complex types).

Methods

__construct(string|null $name = null)

No description

addFilter(string $filterName, Closure $filterCallback, ParameterObject $filterParameter = null)

No description

addMember(string $parameter, string $type, ParameterObject|null $serviceObject = null)

Adds an member variable to the complex type definition.

addMemberArray(string $memberName, array $values)

No description

addMemberExpand(string $memberName, Closure $expandCallback, ParameterObject|null $parameterObject = null)

No description

Closure|null
getFilterClosure(string $filterName)

No description

ParameterObject|null
getFilterParameter(string $filterName)

No description

array
getFilters()

No description

Closure|null
getMemberExpandClosure(string $memberName)

No description

XQL|null
getMemberXQL($field)

No description

array
getMembers()

Returns the defined members.

string
getName()

Returns the object name

bool
hasFilter(string $filterName)

No description

bool
hasMember(string|null $name)

No description

removeFilter(string $filterName)

No description

removeMember(string $memberName)

No description

setMemberXQL(string $field, XQL $expandXQL)

No description

setName(string|null $name)

No description

Details

at line 24
__construct(string|null $name = null)

No description

Parameters

string|null $name

at line 138
ParameterObject addFilter(string $filterName, Closure $filterCallback, ParameterObject $filterParameter = null)

No description

Parameters

string $filterName
Closure $filterCallback
ParameterObject $filterParameter

Return Value

ParameterObject

at line 47
ParameterObject addMember(string $parameter, string $type, ParameterObject|null $serviceObject = null)

Adds an member variable to the complex type definition.

Beware: The order of the members matters!

Parameters

string $parameter
string $type
ParameterObject|null $serviceObject

If you use the type Method::OBJECT provide a definition of the object members

Return Value

ParameterObject

See also

Types for valid XSD type constants

at line 61
ParameterObject addMemberArray(string $memberName, array $values)

No description

Parameters

string $memberName
array $values

Return Value

ParameterObject

at line 121
ParameterObject addMemberExpand(string $memberName, Closure $expandCallback, ParameterObject|null $parameterObject = null)

No description

Parameters

string $memberName
Closure $expandCallback
ParameterObject|null $parameterObject

Return Value

ParameterObject

at line 150
Closure|null getFilterClosure(string $filterName)

No description

Parameters

string $filterName

Return Value

Closure|null

at line 154
ParameterObject|null getFilterParameter(string $filterName)

No description

Parameters

string $filterName

Return Value

ParameterObject|null

at line 162
array getFilters()

No description

Return Value

array

at line 130
Closure|null getMemberExpandClosure(string $memberName)

No description

Parameters

string $memberName

Return Value

Closure|null

at line 116
XQL|null getMemberXQL($field)

No description

Parameters

$field

Return Value

XQL|null

at line 89
array getMembers()

Returns the defined members.

at line 32
string getName()

Returns the object name

Return Value

string

at line 158
bool hasFilter(string $filterName)

No description

Parameters

string $filterName

Return Value

bool

at line 102
bool hasMember(string|null $name)

No description

Parameters

string|null $name

Return Value

bool

at line 144
ParameterObject removeFilter(string $filterName)

No description

Parameters

string $filterName

Return Value

ParameterObject

at line 70
ParameterObject removeMember(string $memberName)

No description

Parameters

string $memberName

Return Value

ParameterObject

at line 111
ParameterObject setMemberXQL(string $field, XQL $expandXQL)

No description

Parameters

string $field
XQL $expandXQL

Return Value

ParameterObject

at line 97
ParameterObject setName(string|null $name)

No description

Parameters

string|null $name

Return Value

ParameterObject