class ReadRelated extends AbstractFunction

Constants

RETURN_FORMATS

DEFAULT_RETURN_FORMAT

MAX_KEY_COUNT

Methods

getControlId()

Get control ID

setControlId($controlId = null)

Set control ID

__construct(string $controlId = null)

Initializes the class with the given parameters.

writeXml(XMLWriter $xml)

Write the readRelated block XML

string
getObjectName()

No description

setObjectName(string $objectName)

No description

string
getRelationName()

No description

setRelationName(string $relationName)

No description

array
getFields()

No description

setFields(array $fields)

No description

array
getKeys()

No description

setKeys(array $keys)

Set keys

string
getReturnFormat()

No description

setReturnFormat(string $format)

Set return format

Details

in AbstractFunction at line line 35
getControlId()

Get control ID

in AbstractFunction at line line 46
setControlId($controlId = null)

Set control ID

Parameters

$controlId

Exceptions

InvalidArgumentException

in AbstractFunction at line line 67
__construct(string $controlId = null)

Initializes the class with the given parameters.

Parameters

string $controlId Control ID, default=random UUID

at line line 180
writeXml(XMLWriter $xml)

Write the readRelated block XML

Parameters

XMLWriter $xml

at line line 54
string getObjectName()

Return Value

string

at line line 62
setObjectName(string $objectName)

Parameters

string $objectName

at line line 70
string getRelationName()

Return Value

string

at line line 78
setRelationName(string $relationName)

Parameters

string $relationName

at line line 86
array getFields()

Return Value

array

at line line 94
setFields(array $fields)

Parameters

array $fields

at line line 102
array getKeys()

Return Value

array

at line line 113
setKeys(array $keys)

Set keys

Parameters

array $keys

Exceptions

InvalidArgumentException

at line line 124
string getReturnFormat()

Return Value

string

at line line 135
setReturnFormat(string $format)

Set return format

Parameters

string $format

Exceptions

InvalidArgumentException