Documentation

RootController extends LedgerAccountController
in package
Uses Audited

Functions associated with creating and querying the Ledger root account.

Table of Contents

add()  : LedgerAccount
Adding an account to the ledger.
checkNoLedgerExists()  : mixed
Verify that the Ledger has not been created already.
create()  : LedgerAccount
Initialize a new Ledger.
delete()  : null
Delete a ledger account (and all sub-accounts). The accounts must be unused.
get()  : LedgerAccount
Get a single account
listTemplates()  : array<string|int, mixed>
Get a list of the names and title of the predefined templates.
query()  : Collection
Return accounts matching a Query.
run()  : LedgerAccount|null
Perform an account operation.
update()  : LedgerAccount
Update an account.

Methods

checkNoLedgerExists()

Verify that the Ledger has not been created already.

public static checkNoLedgerExists() : mixed
Tags
throws
Breaker
Return values
mixed

delete()

Delete a ledger account (and all sub-accounts). The accounts must be unused.

public delete(Account $message) : null
Parameters
$message : Account
Tags
throws
Breaker
throws
Exception
Return values
null

listTemplates()

Get a list of the names and title of the predefined templates.

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

Search results