Documentation

CurrencyQuery extends Paginated
in package

Messages that return paginated results over a range.

Table of Contents

ALL_OPS  = 0b11111111
Bitmask for all the OP_ constants.
F_API  = 2 ** 30
Set when the request came from the JSON API.
F_VALIDATE  = 2 ** 29
Set on a request to validate the message.
OP_ADD  = 1
OP_BATCH  = 2 ** 6
OP_CREATE  = 2
OP_DELETE  = 2 ** 2
OP_GET  = 2 ** 3
OP_LOCK  = 2 ** 7
OP_QUERY  = 2 ** 4
OP_UPDATE  = 2 ** 5
$after  : string
$codes  : array<string|int, mixed>
$limit  : int
$names  : array<string|int, mixed>
copy()  : $this
Selectively copy information from a data array.
fromArray()  : static
Populate the message with data from an array of request data.
fromRequest()  : static
Create a message from the request payload, bypassing some middleware.
getOpFlags()  : int
run()  : array<string|int, mixed>
selectCodes()  : Builder|Builder
Apply code selections to a query
selectNames()  : Builder|Builder
Apply name selections to a query.
toOpFlags()  : int
Convert a method name to an operation bitmask.
validate()  : self
Check the message for validity.

Constants

ALL_OPS

Bitmask for all the OP_ constants.

public mixed ALL_OPS = 0b11111111

F_API

Set when the request came from the JSON API.

public mixed F_API = 2 ** 30

F_VALIDATE

Set on a request to validate the message.

public mixed F_VALIDATE = 2 ** 29

OP_BATCH

public mixed OP_BATCH = 2 ** 6

OP_CREATE

public mixed OP_CREATE = 2

OP_DELETE

public mixed OP_DELETE = 2 ** 2

OP_LOCK

public mixed OP_LOCK = 2 ** 7

OP_QUERY

public mixed OP_QUERY = 2 ** 4

OP_UPDATE

public mixed OP_UPDATE = 2 ** 5

Properties

$after

public string $after

For pagination, a reference to the last currency in the previous page.

$codes

public array<string|int, mixed> $codes = []

A list of single codes or code range selections

$limit

public int $limit

The maximum number of elements to return.

$names

public array<string|int, mixed> $names = []

A list of Name messages.

Methods

copy()

Selectively copy information from a data array.

public copy(array<string|int, mixed> $data, int $opFlags) : $this
Parameters
$data : array<string|int, mixed>
$opFlags : int
Return values
$this

fromArray()

Populate the message with data from an array of request data.

public abstract static fromArray(array<string|int, mixed> $data, int $opFlags) : static
Parameters
$data : array<string|int, mixed>

Data generated by the request.

$opFlags : int

Bitmask of the request operation (may include FM_VALIDATE)

Tags
throws
Breaker

On error, e.g. required data is missing or on validation.

Return values
static

Message initialized with relevant data.

fromRequest()

Create a message from the request payload, bypassing some middleware.

public static fromRequest(Request $request, int $opFlags) : static
Parameters
$request : Request
$opFlags : int
Tags
throws
Breaker
Return values
static

getOpFlags()

public getOpFlags() : int
Return values
int

run()

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

selectCodes()

Apply code selections to a query

public selectCodes(Builder|Builder $query) : Builder|Builder
Parameters
$query : Builder|Builder
Return values
Builder|Builder

selectNames()

Apply name selections to a query.

public selectNames(Builder|Builder $query) : Builder|Builder
Parameters
$query : Builder|Builder
Return values
Builder|Builder

toOpFlags()

Convert a method name to an operation bitmask.

public static toOpFlags(string $method[, array<string|int, mixed> $options = [] ]) : int
Parameters
$method : string

The method name.

$options : array<string|int, mixed> = []

Options are: add Bitmask of flags to add to the result. allowZero boolean, if not set an exception is thrown when there is no matching flag. disallow Bitmask of methods to ignore.

Tags
throws
Breaker
Return values
int

Operation bitmask, zero if not recognized or disallowed.

validate()

Check the message for validity.

public abstract validate(int|null $opFlags) : self
Parameters
$opFlags : int|null

Operation bitmask.

Tags
throws
Breaker

When data is not valid.

Return values
self

Search results