Documentation

SubJournal extends Model
in package
Uses CommonResponseProperties, HasFactory, HasRevisions, UuidPrimaryKey

Domains assigned within the ledger.

Tags
mixin

Builder

Table of Contents

$code  : string
$created_at  : Carbon
$extra  : string
$incrementing  : mixed
$names  : array<string|int, LedgerName>
$primaryKey  : mixed
$revision  : Carbon
$subJournalUuid  : string
$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
create()  :
createFromMessage()  : self
findWith()  : Builder
getRevisionHash()  : mixed
names()  : HasMany
refresh()  : mixed
toResponse()  : array<string|int, mixed>

Properties

$code

public string $code

Unique identifier for the sub-journal.

$created_at

public Carbon $created_at

When the record was created.

$extra

public string $extra

Application defined information.

$incrementing

public mixed $incrementing = false

$primaryKey

public mixed $primaryKey = 'subJournalUuid'

$revision

public Carbon $revision

Revision timestamp to detect race condition on update.

$subJournalUuid

public string $subJournalUuid

Identifier for this journal.

$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

create()

public static create(array<string|int, mixed> $attributes) :

Provided by model.

Parameters
$attributes : array<string|int, mixed>
Return values

findWith()

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

PhpIncompatibleReturnTypeInspection

noinspection

PhpDynamicAsStaticMethodCallInspection

Return values
Builder

getRevisionHash()

public getRevisionHash() : mixed
Return values
mixed

names()

public names() : HasMany
Return values
HasMany

refresh()

public refresh() : mixed
Return values
mixed

toResponse()

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

Search results