LedgerSMB::DBObject::Menu(3pm) User Contributed Perl Documentation LedgerSMB::DBObject::Menu(3pm)NAME
LedgerSMB::DBObject::Menu - Menu Handling Back-end Routines for LedgerSMB
SYNOPSIS
Provides the functions for generating the data structures for the LedgerSMB menu.
COPYRIGHT
Copyright (c) 2007 The LedgerSMB Core Team. Licensed under the GNU General Public License version 2 or at your option any later version.
Please see the included COPYRIGHT and LICENSE files for more information.
METHODS
new()
Inherited from LedgerSMB::DBObject. Please see that documnetation for details.
generate()
This function returns a list of menu items. Each list item is a hashref: keys %menu_item would return the equivalent of qw(position id
level label path args). Returns the complete list and sets $menu->{menu_items} to a referene to th result set, This function does not
return an entry for the top-level menu.
generate_section()
This class acts like Menu::Generate except it returns only a cross-section of the menu. Basically it returns all nodes which are
direct children below $object->{parent_id}.
will_expire_soon()
This method returns true if the user's password will expire soon (within the next week).
Copyright (C) 2007 The LedgerSMB Core Team
Licensed under the GNU General Public License version 2 or later (at your option). For more information please see the included LICENSE
and COPYRIGHT files.
perl v5.14.2 2012-03-25 LedgerSMB::DBObject::Menu(3pm)
Check Out this Related Man Page
LedgerSMB::DBObject::Account(3pm) User Contributed Perl Documentation LedgerSMB::DBObject::Account(3pm)NAME
LedgerSMB::DBObject::Account - Base class for chart of accounts entries
SYNOPSYS
This class contains methods for managing chart of accounts entries (headings and accounts).
INERITS
LedgerSMB::DBObject
METHODS
save()
This method saves the chart of accounts entry.
The hash component of the object may contain an id attribute, used to overwrite an account if that one exists.
Hash entries Used:
id: (optional): If set, overwrite existing account. accno: the text used to specify the account number description: Text to describe
the account category: A = asset, L = liability, Q = Equity, I = Income, E = expense gifi_accno: The GIFI account entry control code
heading: (Optional) The integer representing the heading.id desired contra: If true, the account balances on the opposite side. tax:
If true, is a tax account link: a list of strings representing text box identifier.
get()
This method gets a chart of accounts entry. It requires that the $account->{id} value must be properly set.
check_transactions()
Returns true if the account has transactions, false if not. Also sets the $account->{has_transactions} value to the return value.
$account->{id} must be set.
is_recon
Returns true if is set up for reconciliation. False otherwise.
delete()
Attempts to delete the account. This will NOT succeed if the account is referenced in any way by any transactions, credit accounts,
etc.
$account->{id} must be set.
list()
Returns a list of all accounts.
generate_links()
A mostly-private method for generating and checking whether link data is valid.
This is usually done (automatically) in preparation for saving the information to the database.
list_headings
Returns a list of account_heading's. No inputs required.
SEE ALSO
LedgerSMB::DBObject, LedgerSMB
COPYRIGHT
Copyright (c) 2009, the LedgerSMB Core Team. This is licensed under the GNU General Public License, version 2, or at your option any later
version. Please see the accompanying License.txt for more information.
perl v5.14.2 2012-03-25 LedgerSMB::DBObject::Account(3pm)