[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/vendor/tobscure/json-api/src/ -> Parameters.php (summary)

(no description)

File Size: 220 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Parameters:: (10 methods):
  __construct()
  getInclude()
  getOffset()
  getOffsetFromNumber()
  getLimit()
  getSort()
  getFields()
  getFilter()
  getInput()
  getPage()


Class: Parameters  - X-Ref

__construct(array $input)   X-Ref

param: array $input

getInclude(array $available = [])   X-Ref
Get the includes.

param: array $available
return: array

getOffset($perPage = null)   X-Ref
Get number of offset.

param: int|null $perPage
return: int

getOffsetFromNumber($perPage)   X-Ref
Calculate the offset based on the page[number] parameter.

param: int $perPage
return: int

getLimit($max = null)   X-Ref
Get the limit.

param: int|null $max
return: int|null

getSort(array $available = [])   X-Ref
Get the sort.

param: array $available
return: array

getFields()   X-Ref
Get the fields requested for inclusion.

return: array

getFilter()   X-Ref
Get a filter item.

return: mixed

getInput($key, $default = null)   X-Ref
Get an input item.

param: string $key
param: null $default
return: mixed

getPage($key)   X-Ref
Get the page.

param: string $key
return: string



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer