Fork me on GitHub

System Parameters

There are a few parameters that are removed from the filter parameters and reserved for internal usage.

_format=json
This determines in what format data is returned. Can be json/jsonp/xml/phps. Defaults to json

\Ginger\System\Parameters::$format

_limit=10
This limits the amount of items/data returned to you. Defaults to 10.

\Ginger\System\Parameters::$limit

_offset=0
Used for offset of items retrieved if applicable. Defaults to 0

\Ginger\System\Parameters::$offset

_sort=created
Used to determine sorting column/field/key. Defaults to “created”

\Ginger\System\Parameters::$sort

_direction=asc
Used to determine sorting direction, could be asc or desc. Defaults to “asc”

\Ginger\System\Parameters::$direction

_template=NULL
If return format html is supported and selected use this template file instead of default. Defaults to NULL

\Ginger\System\Parameters::$template

_options=NULL
This can be used for internal options, for instance in

GET /files/id/93801dj0j2/_options/crop|120x120 it is used to determine the crop dimensions. Defaults to NULL

\Ginger\System\Parameters::$options

_flags=NULL
This can be used for internal flags. Defaults to NULL

\Ginger\System\Parameters::$flags

_mode=NULL
This can be used for selected an alternate mode for data retrieval within the module. For instance in:

GET /files/id/1928d9hd/_mode/download directly downloads the file instead of returning the meta data. Defaults to NULL

\Ginger\System\Parameters::$mode

_ts=1383650700
This can be used for timestamp to go around the internal browser cache. Defaults to NULL