ApiOpenStudio PHPDoc

Request
in package

Class Request

Container class for all request details.

Table of Contents

$accId  : int
Account ID.
$accName  : string
Account name.
$appId  : int
Application ID.
$appName  : string
Application name.
$args  : array<string|int, mixed>
Request arguments.
$cacheKey  : string
Cache key.
$files  : array<string|int, mixed>
Contents of $_FILES.
$fragments  : array<string|int, mixed>
Fragments array.
$getVars  : array<string|int, mixed>
Contents of $_GET.
$ip  : string
The requesting IP.
$meta  : stdClass
The request metadata.
$method  : string
The request method.
$outFormat  : string
Request output format.
$postVars  : array<string|int, mixed>
Contents of $_POST.
$resource  : Resource
The resource called.
$ttl  : int
Resource cache TTL.
$uri  : string
Request URI.
getAccId()  : int
Get the account ID.
getAccName()  : string
Get the account name.
getAppId()  : int
Get the application ID.
getAppName()  : string
Get the application name.
getArgs()  : array<string|int, mixed>
Get the request args.
getCacheKey()  : string
Get the cache key.
getFiles()  : array<string|int, mixed>
Get the FILES.
getFragments()  : array<string|int, mixed>
Get the fragments.
getGetVars()  : array<string|int, mixed>
Get the GET vars.
getIp()  : string
Get the request IP.
getMeta()  : stdClass
Get the metadata,
getMethod()  : string
Get the request method.
getOutFormat()  : string
Get the output format.
getPostVars()  : array<string|int, mixed>
Get the POST vars.
getResource()  : resource
Get the resource.
getTtl()  : int
Get the cache TTL.
getUri()  : string
Get the request URI.
setAccId()  : void
Set the account ID.
setAccName()  : void
Set the account name.
setAppId()  : void
Set the application ID.
setAppName()  : void
Set the application name
setArgs()  : void
Set the request args.
setCacheKey()  : void
Set the cache key.
setFiles()  : void
Set the FILES.
setFragments()  : void
Set the fragments.
setGetVars()  : void
Set the GET vars.
setIp()  : void
Set the request IP.
setMeta()  : void
Set the metadata.
setMethod()  : void
Set the method.
setOutFormat()  : void
Set the output format.
setPostVars()  : void
Set the POST vars.
setResource()  : void
Set the resource object.
setTtl()  : void
Set the cache TTL.
setUri()  : void
Set the URI.

Properties

$accId

Account ID.

private int $accId

Account ID.

$accName

Account name.

private string $accName

Account name.

$appId

Application ID.

private int $appId

Application ID.

$appName

Application name.

private string $appName

Application name.

$args

Request arguments.

private array<string|int, mixed> $args

Request arguments.

$cacheKey

Cache key.

private string $cacheKey

Cache key.

$files

Contents of $_FILES.

private array<string|int, mixed> $files

Server $_FILES.

$fragments

Fragments array.

private array<string|int, mixed> $fragments = []

Fragments metadata and results.

$getVars

Contents of $_GET.

private array<string|int, mixed> $getVars

GET variables.

$ip

The requesting IP.

private string $ip

Request IP.

$meta

The request metadata.

private stdClass $meta

Request metadata.

$method

The request method.

private string $method

Request method.

$outFormat

Request output format.

private string $outFormat

Value of the accept header, translated into readable string.

$postVars

Contents of $_POST.

private array<string|int, mixed> $postVars

POST variables.

$ttl

Resource cache TTL.

private int $ttl = 0

Cache TTL.

$uri

Request URI.

private string $uri

Requesting URI.

Methods

getAccId()

Get the account ID.

public getAccId() : int
Return values
int

getAccName()

Get the account name.

public getAccName() : string
Return values
string

getAppId()

Get the application ID.

public getAppId() : int
Return values
int

getAppName()

Get the application name.

public getAppName() : string
Return values
string

getArgs()

Get the request args.

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

getCacheKey()

Get the cache key.

public getCacheKey() : string
Return values
string

getFiles()

Get the FILES.

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

getFragments()

Get the fragments.

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

getGetVars()

Get the GET vars.

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

getIp()

Get the request IP.

public getIp() : string
Return values
string

getMeta()

Get the metadata,

public getMeta() : stdClass
Return values
stdClass

getMethod()

Get the request method.

public getMethod() : string
Return values
string

getOutFormat()

Get the output format.

public getOutFormat() : string
Return values
string

getPostVars()

Get the POST vars.

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

getResource()

Get the resource.

public getResource() : resource
Return values
resource

getTtl()

Get the cache TTL.

public getTtl() : int
Return values
int

getUri()

Get the request URI.

public getUri() : string
Return values
string

setAccId()

Set the account ID.

public setAccId(int $var) : void
Parameters
$var : int

Account ID.

Return values
void

setAccName()

Set the account name.

public setAccName(string $var) : void
Parameters
$var : string

Account name.

Return values
void

setAppId()

Set the application ID.

public setAppId(int $var) : void
Parameters
$var : int

Application ID.

Return values
void

setAppName()

Set the application name

public setAppName(string $var) : void
Parameters
$var : string

Application name.

Return values
void

setArgs()

Set the request args.

public setArgs(array<string|int, mixed> $var) : void
Parameters
$var : array<string|int, mixed>

Request URI args.

Return values
void

setCacheKey()

Set the cache key.

public setCacheKey(string $var) : void
Parameters
$var : string

Cache key.

Return values
void

setFiles()

Set the FILES.

public setFiles(array<string|int, mixed> $var) : void
Parameters
$var : array<string|int, mixed>

Copy of request $_FILES.

Return values
void

setFragments()

Set the fragments.

public setFragments(array<string|int, mixed> $var) : void
Parameters
$var : array<string|int, mixed>

Fragments.

Return values
void

setGetVars()

Set the GET vars.

public setGetVars(array<string|int, mixed> $var) : void
Parameters
$var : array<string|int, mixed>

Copy of request $_GET.

Return values
void

setIp()

Set the request IP.

public setIp(string $var) : void
Parameters
$var : string

Request IP address.

Return values
void

setMeta()

Set the metadata.

public setMeta(stdClass $var) : void
Parameters
$var : stdClass

Resource metadata.

Return values
void

setMethod()

Set the method.

public setMethod(string $var) : void
Parameters
$var : string

Request method.

Return values
void

setOutFormat()

Set the output format.

public setOutFormat(string $var) : void
Parameters
$var : string

Output format.

Return values
void

setPostVars()

Set the POST vars.

public setPostVars(array<string|int, mixed> $var) : void
Parameters
$var : array<string|int, mixed>

Copy of request $_POST.

Return values
void

setResource()

Set the resource object.

public setResource(resource $var) : void
Parameters
$var : resource

Resource object.

Return values
void

setTtl()

Set the cache TTL.

public setTtl(int $var) : void
Parameters
$var : int

Cache TTL.

Return values
void

setUri()

Set the URI.

public setUri(string $var) : void
Parameters
$var : string

Request URI.

Return values
void

Search results