__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 |
---|
string
method name
array
array of arguments
\BadMethodCallException |
---|
__construct(Salesking $api, array $config)
__toString() : string
since | 1.0.0 |
---|
string
addFilter(string $filter, mixed $value) : \SaleskingCollection
getCurrentPage() : int
since | 1.0.0 |
---|
int
current pagegetFilters() : array
since | 1.0.0 |
---|
array
filtersgetItems() : array
since | 1.0.0 |
---|
array
ItemsgetPerPage() : int
since | 1.0.0 |
---|
int
Number of entries per page to fetchgetSort() : string
since | 1.0.0 |
---|
string
sorting directiongetSortBy() : string
since | 1.0.0 |
---|
string
object propertygetTotal() : int
since | 1.0.0 |
---|
int
total itemsgetTotalPages() : int
since | 1.0.0 |
---|
int
total pagesgetType() : string
since | 1.0.0 |
---|
string
collection typeload(int $page) : \SaleskingCollection
perPage(int $number) : \SaleskingCollection
setType(string $type)
since | 1.0.0 |
---|
string
collection type
sort(string $direction) : \SaleskingCollection
since | 1.0.0 |
---|
string
Sorting direction - either ASC or DESC
\SaleskingException |
---|
sortBy(string $property) : \SaleskingCollection
validateFilter(string $filter, mixed $value) : bool
since | 1.0.0 |
---|
string
name of the filter
mixed
filter 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 |
---|