ApiOpenStudio PHPDoc

VarStore
in package

Class VarStore.

DB class for storing var row data.

Table of Contents

$accid  : int|null
$appid  : int|null
$key  : string|null
$val  : mixed
$vid  : int|null
__construct()  : mixed
VarStore constructor.
dump()  : array<string|int, mixed>
Return the values as an associative array.
getAccid()  : int|null
Get the var account ID.
getAppid()  : int|null
Get the var application ID.
getKey()  : string|null
Get the var key.
getVal()  : string|null
Get the var value.
getVid()  : int|null
Get the var ID.
setAccid()  : void
Set the var account ID.
setAppid()  : void
Set the var application ID.
setKey()  : void
Set the var key.
setVal()  : void
Set the var value.
setVid()  : void
Set the var ID.

Properties

$accid

protected int|null $accid

account ID.

$appid

protected int|null $appid

Application ID.

$key

protected string|null $key

Var key.

$vid

protected int|null $vid

Var store ID.

Methods

__construct()

VarStore constructor.

public __construct([int|null $vid = null ][, int|null $accid = null ][, int|null $appid = null ][, string|null $key = null ][, mixed $val = null ]) : mixed
Parameters
$vid : int|null = null

The var ID.

$accid : int|null = null

The var account ID.

$appid : int|null = null

The var application ID.

$key : string|null = null

The var key.

$val : mixed = null

The var value.

Return values
mixed

dump()

Return the values as an associative array.

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

Associative array of var attributes.

getAccid()

Get the var account ID.

public getAccid() : int|null
Return values
int|null

The var account ID.

getAppid()

Get the var application ID.

public getAppid() : int|null
Return values
int|null

The var application ID.

getKey()

Get the var key.

public getKey() : string|null
Return values
string|null

The var key.

getVal()

Get the var value.

public getVal() : string|null
Return values
string|null

The var value.

getVid()

Get the var ID.

public getVid() : int|null
Return values
int|null

The var ID.

setAccid()

Set the var account ID.

public setAccid(int|null $accid) : void
Parameters
$accid : int|null

The var account ID.

Return values
void

setAppid()

Set the var application ID.

public setAppid(int|null $appid) : void
Parameters
$appid : int|null

The avr application ID.

Return values
void

setKey()

Set the var key.

public setKey(string|null $key) : void
Parameters
$key : string|null

The var key.

Return values
void

setVal()

Set the var value.

public setVal(mixed $val) : void
Parameters
$val : mixed

The var value.

Return values
void

setVid()

Set the var ID.

public setVid(int|null $vid) : void
Parameters
$vid : int|null

The var ID.

Return values
void

Search results