Documentation

LedgerDomain extends Model
in package
Uses CommonResponseProperties, HasFactory, HasNames, HasRevisions, UuidPrimaryKey

Domains assigned within the ledger.

Tags
mixin

Builder

Table of Contents

$code  : string
$created_at  : Carbon
$currencyDefault  : string
$domainUuid  : string
$extra  : string
$flex  : string
$incrementing  : mixed
$names  : array<string|int, LedgerName>
$primaryKey  : mixed
$revision  : Carbon
$subJournals  : bool
$updated_at  : Carbon
__get()  : HigherOrderCollectionProxy|mixed|string|null
The revision Hash is computationally expensive, only calculated when required.
checkRevision()  : mixed
Throw a Breaker exception if the request revision doesn't match the stored value.
clearRevisionCache()  : void
createFromMessage()  : self
findWith()  : Builder
getRevisionHash()  : mixed
nameIn()  : string
names()  : HasMany
refresh()  : mixed
toResponse()  : array<string|int, string>
Create a response array.

Properties

$created_at

public Carbon $created_at

When the record was created.

$currencyDefault

public string $currencyDefault

The default currency.

$extra

public string $extra

Application defined information.

$flex

public string $flex

JSON-encoded additional system information (e.g. supported currencies).

$revision

public Carbon $revision

Revision hash to detect race condition on update.

$subJournals

public bool $subJournals

Set if the domain uses sub-journals.

$updated_at

public Carbon $updated_at

When the record was updated.

Methods

__get()

The revision Hash is computationally expensive, only calculated when required.

public __get( $key) : HigherOrderCollectionProxy|mixed|string|null
Parameters
$key :
Tags
throws
Exception
Return values
HigherOrderCollectionProxy|mixed|string|null —

checkRevision()

Throw a Breaker exception if the request revision doesn't match the stored value.

public checkRevision(string|null $revision) : mixed
Parameters
$revision : string|null
Tags
throws
Breaker
Return values
mixed —

clearRevisionCache()

public clearRevisionCache() : void
Return values
void —

createFromMessage()

public static createFromMessage(Domain $message) : self
Parameters
$message : Domain
Return values
self —

findWith()

public static findWith(EntityRef $entityRef) : Builder
Parameters
$entityRef : EntityRef
Tags
noinspection

PhpIncompatibleReturnTypeInspection

noinspection

PhpDynamicAsStaticMethodCallInspection

throws
Breaker
Return values
Builder —

getRevisionHash()

public getRevisionHash() : mixed
Return values
mixed —

nameIn()

public nameIn(mixed $languages) : string
Parameters
$languages : mixed
Return values
string —

names()

public names() : HasMany
Return values
HasMany —

refresh()

public refresh() : mixed
Return values
mixed —

toResponse()

Create a response array.

public toResponse() : array<string|int, string>
Tags
throws
Exception
Return values
array<string|int, string> —

Search results