class ReadByName extends AbstractFunction

Constants

RETURN_FORMATS

DEFAULT_RETURN_FORMAT

MAX_NAME_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 readByName block XML

string
getObjectName()

No description

setObjectName(string $objectName)

No description

array
getFields()

No description

setFields(array $fields)

No description

array
getNames()

No description

setNames(array $names)

Set names

string
getReturnFormat()

No description

setReturnFormat(string $format)

Set return format

string
getDocParId()

No description

setDocParId(string $docParId)

No description

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 181
writeXml(XMLWriter $xml)

Write the readByName 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
array getFields()

Return Value

array

at line line 78
setFields(array $fields)

Parameters

array $fields

at line line 86
array getNames()

Return Value

array

at line line 97
setNames(array $names)

Set names

Parameters

array $names

Exceptions

InvalidArgumentException

at line line 109
string getReturnFormat()

Return Value

string

at line line 120
setReturnFormat(string $format)

Set return format

Parameters

string $format

Exceptions

InvalidArgumentException

at line line 131
string getDocParId()

Return Value

string

at line line 139
setDocParId(string $docParId)

Parameters

string $docParId