ApiOpenStudio PHPDoc

Resource
in package

Class Resource.

DB class for for storing resource row data.

Table of Contents

$appid  : int|null
Resource application ID.
$description  : string|null
Resource description.
$meta  : string|null
Resource Metadata.
$method  : string|null
Resource request method.
$name  : string|null
Resource name.
$openapi  : string|null
OpenApi Path JSON.
$resid  : int|null
Resource ID.
$ttl  : int|null
Resource TTL.
$uri  : string|null
Resource URI.
__construct()  : mixed
Resource constructor.
dump()  : array<string|int, mixed>
Return the values as an associative array.
getAppId()  : int
Get the application ID.
getDescription()  : string
Get the resource description.
getMeta()  : string
Get the json encoded resource metadata.
getMethod()  : string
Get the resource method.
getName()  : string
Get the resource nanme.
getOpenapi()  : string
Get the json encoded OpenApi path fragment.
getResid()  : int
Get the resource ID.
getTtl()  : int
Get the resource TTL.
getUri()  : string
Get the resource URI.
setAppId()  : void
Set the resource application ID.
setDescription()  : void
Set the resource description.
setMeta()  : void
Set the json encoded resource metadata.
setMethod()  : void
Set the resource method.
setName()  : void
Set the resource name.
setOpenapi()  : void
Set the json encoded OpenApi path fragment.
setResid()  : void
Set the resource ID.
setTtl()  : void
Set the TTL.
setUri()  : void
Set the resource URI.

Properties

$appid

Resource application ID.

protected int|null $appid

Application ID.

$description

Resource description.

protected string|null $description

Resource description.

$meta

Resource Metadata.

protected string|null $meta

Resource metadata.

$method

Resource request method.

protected string|null $method

Resource method.

$name

Resource name.

protected string|null $name

Resource name.

$openapi

OpenApi Path JSON.

protected string|null $openapi

OpenApi Path JSON.

$resid

Resource ID.

protected int|null $resid

Resource ID.

$ttl

Resource TTL.

protected int|null $ttl

Resource time to live.

$uri

Resource URI.

protected string|null $uri

Resource URI.

Methods

__construct()

Resource constructor.

public __construct([int|null $resid = null ][, int|null $appid = null ][, string|null $name = null ][, string|null $description = null ][, string|null $method = null ][, string|null $uri = null ][, string|null $meta = null ][, string|null $openapi = null ][, int|null $ttl = null ]) : mixed
Parameters
$resid : int|null = null

The resource ID.

$appid : int|null = null

The application ID.

$name : string|null = null

The resource name.

$description : string|null = null

The resource description.

$method : string|null = null

The resource method.

$uri : string|null = null

The resource URI.

$meta : string|null = null

The resource metadata.

$openapi : string|null = null

OpenApi Path JSON.

$ttl : int|null = null

The resource TTL.

Return values
mixed

dump()

Return the values as an associative array.

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

Api resource.

getAppId()

Get the application ID.

public getAppId() : int
Return values
int

The application ID.

getDescription()

Get the resource description.

public getDescription() : string
Return values
string

The resource description.

getMeta()

Get the json encoded resource metadata.

public getMeta() : string
Return values
string

Json encoded resource metadata.

getMethod()

Get the resource method.

public getMethod() : string
Return values
string

Resource method.

getName()

Get the resource nanme.

public getName() : string
Return values
string

The resource name.

getOpenapi()

Get the json encoded OpenApi path fragment.

public getOpenapi() : string
Return values
string

OpenApi path fragment.

getResid()

Get the resource ID.

public getResid() : int
Return values
int

The resource ID

getTtl()

Get the resource TTL.

public getTtl() : int
Return values
int

Time to live.

getUri()

Get the resource URI.

public getUri() : string
Return values
string

The resource URI.

setAppId()

Set the resource application ID.

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

The application ID.

Return values
void

setDescription()

Set the resource description.

public setDescription(string $description) : void
Parameters
$description : string

The resource description.

Return values
void

setMeta()

Set the json encoded resource metadata.

public setMeta(string $meta) : void
Parameters
$meta : string

The json encoded resource metadata.

Return values
void

setMethod()

Set the resource method.

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

The resource method.

Return values
void

setName()

Set the resource name.

public setName(string $name) : void
Parameters
$name : string

The resource name.

Return values
void

setOpenapi()

Set the json encoded OpenApi path fragment.

public setOpenapi(string $openapi) : void
Parameters
$openapi : string

The json encoded OpenApi path fragment.

Return values
void

setResid()

Set the resource ID.

public setResid(int $resid) : void
Parameters
$resid : int

The resource ID.

Return values
void

setTtl()

Set the TTL.

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

Time to live.

Return values
void

setUri()

Set the resource URI.

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

Resource URI.

Return values
void

Search results