Documentation

Entry extends Message
in package

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
$arguments  : array<string|int, mixed>
$clearing  : bool
$currency  : string
$description  : string
$details  : array<string|int, mixed>
$domain  : EntityRef
$extra  : mixed
$id  : int
$journal  : EntityRef
$language  : string
$lock  : bool
$reference  : Reference
$reviewed  : bool
$revision  : string
$transDate  : Carbon
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>
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

$arguments

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

Arguments to be passed to a string translation function.

$clearing

public bool $clearing = false

This is explicitly a clearing transaction (multiple debit/credits).

$currency

public string $currency

Currency code. If not provided, the domain's default is used.

$description

public string $description

Transaction description.

$details

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

Transaction detail records.

$extra

public mixed $extra

An arbitrary string for use by the application.

$id

public int $id

A unique identifier for this entry.

$language

public string $language

The language used for the supplied description.

$lock

public bool $lock

Lock or unlock a journal entry.

$reviewed

public bool $reviewed = false

Reviewed flag. If absent, set to the ledger default.

$revision

public string $revision

Revision signature.

$transDate

public Carbon $transDate

Transaction date.

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 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

run()

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

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

Operation bitmask.

Tags
inheritdoc
Return values
self

Search results