FacturaScripts

ApiRoot extends ApiController
in package

Table of Contents

API_VERSION  = 3
INCIDENT_EXPIRATION_TIME  = 600
IP_LIST  = 'api-ip-list'
MAX_INCIDENT_COUNT  = 5
$apiKey  : ApiKey
$request  : Request
$response  : Response
$url  : string
__construct()  : mixed
getPageData()  : array<string|int, mixed>
run()  : void
exposeResources()  : void
getResourcesMap()  : array<string|int, mixed>
getUriParam()  : string
runResource()  : void
clientHasManyIncidents()  : bool
getIpList()  : array<string|int, mixed>
isAllowed()  : bool
saveIncident()  : void
validateApiToken()  : bool

Constants

INCIDENT_EXPIRATION_TIME

public mixed INCIDENT_EXPIRATION_TIME = 600

Properties

Methods

__construct()

public __construct(string $className[, string $url = '' ]) : mixed
Parameters
$className : string
$url : string = ''
Return values
mixed —

getPageData()

public getPageData() : array<string|int, mixed>
Return values
array<string|int, mixed> —

exposeResources()

protected exposeResources(array<string|int, mixed> &$map) : void
Parameters
$map : array<string|int, mixed>
Return values
void —

getResourcesMap()

protected getResourcesMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getUriParam()

protected getUriParam(string $num) : string
Parameters
$num : string
Return values
string —

runResource()

protected runResource() : void
Return values
void —

clientHasManyIncidents()

private clientHasManyIncidents() : bool
Return values
bool —

getIpList()

private getIpList() : array<string|int, mixed>
Return values
array<string|int, mixed> —

isAllowed()

private isAllowed(string $resource) : bool
Parameters
$resource : string
Return values
bool —

saveIncident()

private saveIncident() : void
Return values
void —

validateApiToken()

private validateApiToken(string $token) : bool
Parameters
$token : string
Return values
bool —

Search results