class ReadView extends AbstractFunction

Constants

RETURN_FORMATS

DEFAULT_RETURN_FORMAT

MIN_PAGE_SIZE

MAX_PAGE_SIZE

DEFAULT_PAGE_SIZE

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 readView block XML

string
getViewName()

No description

setViewName(string $view)

Set view name

int
getPageSize()

No description

setPageSize(int $pageSize)

Set page size

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

at line line 141
__construct(string $controlId = null)

Initializes the class with the given parameters.

Parameters

string $controlId Control ID, default=random UUID

at line line 154
writeXml(XMLWriter $xml)

Write the readView block XML

Parameters

XMLWriter $xml

at line line 57
string getViewName()

Return Value

string

at line line 68
setViewName(string $view)

Set view name

Parameters

string $view

Exceptions

InvalidArgumentException

at line line 80
int getPageSize()

Return Value

int

at line line 91
setPageSize(int $pageSize)

Set page size

Parameters

int $pageSize

Exceptions

InvalidArgumentException

at line line 117
string getReturnFormat()

Return Value

string

at line line 128
setReturnFormat(string $format)

Set return format

Parameters

string $format

Exceptions

InvalidArgumentException