GetList Class Reference
Inheritance diagram for GetList:
Public Member Functions | |
| getObjectName () | |
| setObjectName (string $objectName) | |
| getMaxTotalCount () | |
| setMaxTotalCount (int $maxTotalCount) | |
| getStartAtCount () | |
| setStartAtCount (int $startAtCount) | |
| isShowPrivate () | |
| setShowPrivate (bool $showPrivate) | |
| getSortFields () | |
| setSortFields (array $sortFields) | |
| getReturnFields () | |
| setReturnFields (array $returnFields) | |
| getFilter () | |
| setFilter ($filter) | |
| getAdditionalParameters () | |
| setAdditionalParameters (array $additionalParameters) | |
| writeXml (XMLWriter &$xml) | |
 Public Member Functions inherited from AbstractFunction | |
| getControlId () | |
| setControlId (string $controlId='') | |
| __construct (string $controlId='') | |
| writeXml (XMLWriter &$xml) | |
| getControlId () | |
| setControlId (string $controlId) | |
| writeXml (XMLWriter &$xml) | |
Protected Attributes | |
| $objectName = '' | |
| $maxTotalCount | |
| $startAtCount | |
| $showPrivate = false | |
| $sortFields = [] | |
| $returnFields = [] | |
| $filter | |
| $additionalParameters = [] | |
| Protected Attributes inherited from AbstractFunction | |
| $controlId = '' | |
Member Function Documentation
◆ getAdditionalParameters()
| getAdditionalParameters | ( | ) |
- Returns
- AdditionalParameter[]
◆ getFilter()
| getFilter | ( | ) |
- Returns
- FilterInterface
◆ getMaxTotalCount()
| getMaxTotalCount | ( | ) |
- Returns
- int
◆ getObjectName()
| getObjectName | ( | ) |
- Returns
- string
◆ getReturnFields()
| getReturnFields | ( | ) |
- Returns
- array
◆ getSortFields()
| getSortFields | ( | ) |
- Returns
- SortField[]
◆ getStartAtCount()
| getStartAtCount | ( | ) |
- Returns
- int
◆ isShowPrivate()
| isShowPrivate | ( | ) |
- Returns
- bool
◆ setAdditionalParameters()
| setAdditionalParameters | ( | array | $additionalParameters | ) |
- Parameters
-
AdditionalParameter[] $additionalParameters
◆ setFilter()
| setFilter | ( | $filter | ) |
- Parameters
-
FilterInterface $filter
◆ setMaxTotalCount()
| setMaxTotalCount | ( | int | $maxTotalCount | ) |
- Parameters
-
int $maxTotalCount
◆ setObjectName()
| setObjectName | ( | string | $objectName | ) |
- Parameters
-
string $objectName
◆ setReturnFields()
| setReturnFields | ( | array | $returnFields | ) |
- Parameters
-
array $returnFields
◆ setShowPrivate()
| setShowPrivate | ( | bool | $showPrivate | ) |
- Parameters
-
bool $showPrivate
◆ setSortFields()
| setSortFields | ( | array | $sortFields | ) |
- Parameters
-
SortField[] $sortFields
◆ setStartAtCount()
| setStartAtCount | ( | int | $startAtCount | ) |
- Parameters
-
int $startAtCount
◆ writeXml()
| writeXml | ( | XMLWriter & | $xml | ) |
Write the function block XML
- Parameters
-
XMLWriter $xml
- Exceptions
-
InvalidArgumentException
Reimplemented from AbstractFunction.
Field Documentation
◆ $additionalParameters
|
protected |
◆ $filter
|
protected |
◆ $maxTotalCount
|
protected |
◆ $objectName
|
protected |
◆ $returnFields
|
protected |
◆ $showPrivate
|
protected |
◆ $sortFields
|
protected |
◆ $startAtCount
|
protected |
