Documentation

Overwatch
in package

Table of Contents

$model  : mixed
$DB  : mixed
$field  : mixed
__construct()  : mixed
getOp()  : string|array<string|int, mixed>|object
Returns operation data from current session
getOps()  : array<string|int, mixed>
Returns list of operations from current session
processOps()  : mixed
setOp()  : bool
Adds an operation to the current session
setSessionOp()  : bool
Adds an operation to the current session

Properties

Methods

__construct()

public __construct([mixed $args = [] ]) : mixed
Parameters
$args : mixed = []
Return values
mixed

getOp()

Returns operation data from current session

public getOp(mixed $name[, mixed $options = false ]) : string|array<string|int, mixed>|object
Parameters
$name : mixed
$options : mixed = false
Tags
name

string : Name of the operation, ID-like format (lowercase, no spaces)

Return values
string|array<string|int, mixed>|object

getOps()

Returns list of operations from current session

public getOps([mixed $options = false ]) : array<string|int, mixed>
Parameters
$options : mixed = false
Tags
options

payload bool : Returns payload data too. WARNING can be overwhelming for some operations

Return values
array<string|int, mixed>

Returns category_id, category_domain_id array

processOps()

public processOps() : mixed
Return values
mixed

setOp()

Adds an operation to the current session

public setOp(mixed $name, mixed $payload[, mixed $incremental = false ][, mixed $options = false ][, mixed $additional_payload = false ]) : bool
Parameters
$name : mixed
$payload : mixed
$incremental : mixed = false
$options : mixed = false
$additional_payload : mixed = false
Tags
name

string : Name of the operation, ID-like format (lowercase, no spaces)

payload

string|array|object : Operation data

options

id string OPTIONAL : An ID for an operation part of an incremental set. Defaults to int as array index

options

date_added string OPTIONAL : Set date in MySQL format for when the operation is set, populated by default with now

options

date_expiry date_time OPTIONAL : Date for the operation is now longer valid, date included (>=)

Return values
bool

setSessionOp()

Adds an operation to the current session

public setSessionOp(mixed $name, mixed $payload[, mixed $incremental = false ][, mixed $options = false ][, mixed $additional_payload = false ]) : bool
Parameters
$name : mixed
$payload : mixed
$incremental : mixed = false
$options : mixed = false
$additional_payload : mixed = false
Tags
name

string : Name of the operation, ID-like format (lowercase, no spaces)

payload

string|array|object : Operation data

options

id string OPTIONAL : An ID for an operation part of an incremental set. Defaults to int as array index

options

date_added string OPTIONAL : Set date in MySQL format for when the operation is set, populated by default with now

options

date_expiry date_time OPTIONAL : Date for the operation is now longer valid, date included (>=)

Return values
bool

Search results