LedgerAccountController
extends Controller
in package
Uses
Audited, ControllerResultHandler
Add traits common to all controllers
Table of Contents
- add() : LedgerAccount
- Adding an account to the ledger.
- create() : LedgerAccount
- Create a new ledger root.
- delete() : null
- Delete a ledger account (and all sub-accounts). The accounts must be unused.
- get() : LedgerAccount
- Get a single account
- query() : Collection
- Return accounts matching a Query.
- run() : LedgerAccount|null
- Perform an account operation.
- update() : LedgerAccount
- Update an account.
Methods
add()
Adding an account to the ledger.
public
add(Account $message) : LedgerAccount
Parameters
- $message : Account
Tags
Return values
LedgerAccount —create()
Create a new ledger root.
public
create(Create $message) : LedgerAccount
Parameters
- $message : Create
Tags
Return values
LedgerAccount —delete()
Delete a ledger account (and all sub-accounts). The accounts must be unused.
public
delete(Account $message) : null
Parameters
- $message : Account
Tags
Return values
null —get()
Get a single account
public
get(Account $message) : LedgerAccount
Parameters
- $message : Account
Tags
Return values
LedgerAccount —query()
Return accounts matching a Query.
public
query(AccountQuery $message, int $opFlags) : Collection
Parameters
- $message : AccountQuery
- $opFlags : int
Tags
Return values
Collection —run()
Perform an account operation.
public
run(Account $message[, int|null $opFlags = null ]) : LedgerAccount|null
Parameters
- $message : Account
-
Account details.
- $opFlags : int|null = null
-
The requested operation. See the Message constants.
Tags
Return values
LedgerAccount|null —The related account, if any.
update()
Update an account.
public
update(Account $message) : LedgerAccount
Parameters
- $message : Account
-
The update request details.
Tags
Return values
LedgerAccount —The updated account with new values.