Class DefaultApiV2Controller

Class DefaultApiV2Controller

The default APIv2 controller will be triggered when client consumers hit the "api.php/v2" URI and it will return information about the API.

AbstractApiV2Controller
┗ HttpApiV2Controller
┗ DefaultApiV2Controller
Package: ApiV2Controllers
Category: System
Located at Controllers/Api/v2/DefaultApiV2Controller.inc.php

Methods summary

public get( void )
public post( void )
public put( void )
public patch( void )
public delete( void )
public head( void )
public options( void )
protected _returnHelpResponse( void )
protected _camelCaseToUnderscore( string $input ) : string

Converts a camel case string to underscored.

Methods inherited from HttpApiV2Controller

_linkResponse(), _locateResource(), _mapResponse(), _minimizeResponse(), _paginateResponse(), _searchResponse(), _setJsonValue(), _sortResponse(), _writeResponse()

Methods inherited from AbstractApiV2Controller

__construct(), _prepareResponse(), _setRateLimitHeader(), _validateRequest()

Constants summary

Constants inherited from AbstractApiV2Controller

DEFAULT_CONTROLLER_NAME, DEFAULT_PAGE_ITEMS, DEFAULT_RATE_LIMIT, DEFAULT_RATE_RESET_PERIOD

Properties summary

Properties inherited from AbstractApiV2Controller

$api, $uri