LedgerCurrencyController
extends Controller
in package
Uses
Audited
Manage the currencies supported by the ledger.
Table of Contents
- add() : LedgerCurrency
- Add a currency to the ledger.
- delete() : null
- Delete a currency. The currency must be unused.
- get() : LedgerCurrency
- Get a currency.
- query() : Collection
- Return currencies matching a Query.
- run() : LedgerCurrency|null
- Perform a currency operation.
- update() : LedgerCurrency
- Update a currency.
Methods
add()
Add a currency to the ledger.
public
add(Currency $message) : LedgerCurrency
Parameters
- $message : Currency
Tags
Return values
LedgerCurrency —delete()
Delete a currency. The currency must be unused.
public
delete(Currency $message) : null
Parameters
- $message : Currency
Tags
Return values
null —get()
Get a currency.
public
get(Currency $message) : LedgerCurrency
Parameters
- $message : Currency
Tags
Return values
LedgerCurrency —query()
Return currencies matching a Query.
public
query(CurrencyQuery $message, int $opFlags) : Collection
Parameters
- $message : CurrencyQuery
- $opFlags : int
Tags
Return values
Collection —run()
Perform a currency operation.
public
run(Currency $message[, int|null $opFlags = null ]) : LedgerCurrency|null
Parameters
- $message : Currency
- $opFlags : int|null = null
Tags
Return values
LedgerCurrency|null —update()
Update a currency.
public
update(Currency $message) : LedgerCurrency
Parameters
- $message : Currency