The Query Helper gives you the ability to manipulate the vCloud SDK Query Service with ease. It provides abstraction for pagination.
__construct(\VMware_VCloud_SDK_Query $queryService, int $pageSize = self::DEFAULT_PAGE_SIZE)
\VMware_VCloud_SDK_Query
The vCloud Director SDK for PHP Query Service
int
Page size
create(\VMware_VCloud_SDK_Query $queryService, int $pageSize = self::DEFAULT_PAGE_SIZE) : \VCloud\Helpers\Query
\VCloud\Helpers\Query::create($service)->queryRecords(...)
Since PHP 5.4, Class member access on instantiation is allowed:
new (\VCloud\Helpers\Query($service))->queryRecords(...)
\VMware_VCloud_SDK_Query
The vCloud Director SDK for PHP Query Service
int
Page size
\VCloud\Helpers\Query
Returns a new Query Handler
isLastPage(\VMware_VCloud_API_ResourceType $records) : boolean
\VMware_VCloud_API_ResourceType
boolean
Returns true if it's the last page, false otherwise
queryRecordsPage(string $type, string $filter, int $page) : \VMware_VCloud_API_QueryResultRecordsType
string
The query type
string
The query filter
int
The page to retrieve
\VMware_VCloud_API_QueryResultRecordsType
Returns the query records
queryRecords(string $type, string $filter = null) : array
string
The query type
string
The query filter
array
Returns an array of VMware_VCloud_API_QueryResultRecordType
queryRecord(string $type, string $filter = null) : \VMware_VCloud_API_QueryResultRecordType|boolean
string
The query type
string
The query filter
\VMware_VCloud_API_QueryResultRecordType|boolean
Returns the first record of the query, or false if there isn't any result.
queryReferencesPage(string $type, string $filter, int $page) : \VMware_VCloud_API_QueryResultReferencesType
string
The query type
string
The query filter
int
The page to retrieve
\VMware_VCloud_API_QueryResultReferencesType
Returns the query references
queryReferences(string $type, string $filter = null) : array
string
The query type
string
The query filter
array
Returns an array of VMware_VCloud_API_QueryResultReferenceType
queryReference(string $type, string $filter = null) : \VMware_VCloud_API_QueryResultReferenceType|boolean
string
The query type
string
The query filter
\VMware_VCloud_API_QueryResultReferenceType|boolean
Returns the first reference of the query, or false if there isn't any result.
DEFAULT_PAGE_SIZE
queryService : \VMware_VCloud_SDK_Query
var |
vCloud Director SDK for PHP Query Service |
---|
\VMware_VCloud_SDK_Query
pageSize : int
var |
Page size |
---|
int