Documentation

Detail extends Message
in package

Account detail in a journal entry.

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.
MAX_DECIMALS  = 30
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
$account  : EntityRef
$amount  : string
$credit  : string
$debit  : string
$reference  : Reference
$signTest  : int
__construct()  : mixed
Detail constructor.
__get()  : int|null
Property get.
copy()  : $this
Selectively copy information from a data array.
findAccount()  : LedgerAccount|null
Find the ledger account associated with this detail record.
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
normalizeAmount()  : string
Make the amount have the requested number of decimal places.
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

MAX_DECIMALS

public mixed MAX_DECIMALS = 30

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

$amount

public string $amount

A valid amount for this Currency.

$credit

public string $credit

A valid amount for this Currency.

$debit

public string $debit

A valid amount for this Currency.

$signTest read-only

public int $signTest

Methods

__construct()

Detail constructor.

public __construct([EntityRef|null $account = null ][, string|null $amount = null ]) : mixed
Parameters
$account : EntityRef|null = null
$amount : string|null = null
Return values
mixed —

__get()

Property get.

public __get( $name) : int|null
Parameters
$name :
Return values
int|null —

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 static fromArray(array<string|int, mixed> $data[, int $opFlags = self::OP_ADD ]) : static
Parameters
$data : array<string|int, mixed>

Data generated by the request.

$opFlags : int = self::OP_ADD

Bitmask of the request operation (may include FM_VALIDATE)

Tags
inheritdoc
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 —

normalizeAmount()

Make the amount have the requested number of decimal places.

public normalizeAmount([int|null $decimals = null ]) : string
Parameters
$decimals : int|null = null
Tags
throws
Breaker
Return values
string —

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 validate(int|null $opFlags) : self
Parameters
$opFlags : int|null

Operation bitmask.

Tags
inheritdoc
Return values
self —

Search results