__call()
__construct()
__toString()
addFilter()
getCurrentPage()
getFilters()
getItems()
getPerPage()
getSort()
getSortBy()
getTotal()
getTotalPages()
getType()
load()
perPage()
setFilters()
setType()
sort()
sortBy()
validateFilter()
$api
$autoload
$current_page
$filters
$items
$per_page
$schema
$sort
$sort_by
$total_entries
$total_pages
$type
Salesking SDK file for read access to collections
| since | 1.0.0 |
|---|---|
| package | SalesKing PHP SDK |
__call(string $method, array $args) : \SaleskingCollection
| since | 1.0.0 |
|---|
stringmethod name
arrayarray of arguments
\BadMethodCallException |
|---|
__construct(Salesking $api, array $config)
__toString() : string
| since | 1.0.0 |
|---|
stringaddFilter(string $filter, mixed $value) : \SaleskingCollection
getCurrentPage() : int
| since | 1.0.0 |
|---|
intcurrent pagegetFilters() : array
| since | 1.0.0 |
|---|
arrayfiltersgetItems() : array
| since | 1.0.0 |
|---|
arrayItemsgetPerPage() : int
| since | 1.0.0 |
|---|
intNumber of entries per page to fetchgetSort() : string
| since | 1.0.0 |
|---|
stringsorting directiongetSortBy() : string
| since | 1.0.0 |
|---|
stringobject propertygetTotal() : int
| since | 1.0.0 |
|---|
inttotal itemsgetTotalPages() : int
| since | 1.0.0 |
|---|
inttotal pagesgetType() : string
| since | 1.0.0 |
|---|
stringcollection typeload(int $page) : \SaleskingCollection
perPage(int $number) : \SaleskingCollection
setType(string $type)
| since | 1.0.0 |
|---|
stringcollection type
sort(string $direction) : \SaleskingCollection
| since | 1.0.0 |
|---|
stringSorting direction - either ASC or DESC
\SaleskingException |
|---|
sortBy(string $property) : \SaleskingCollection
validateFilter(string $filter, mixed $value) : bool
| since | 1.0.0 |
|---|
stringname of the filter
mixedfilter value
bool$autoload : boolean
| since | 1.0.0 |
|---|
$current_page : int
| since | 1.0.0 |
|---|
$filters : array
| since | 1.0.0 |
|---|
$items : array
| since | 1.0.0 |
|---|
$per_page : int
| since | 1.0.0 |
|---|
$schema : mixed
| since | 1.0.0 |
|---|
$sort : string
| since | 1.0.0 |
|---|
$sort_by : string
| since | 1.0.0 |
|---|
$total_entries : int
| since | 1.0.0 |
|---|
$total_pages : int
| since | 1.0.0 |
|---|
$type : string
| since | 1.0.0 |
|---|