ledgersmb::dbobject::menu(3pm) [debian man page]

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)

LedgerSMB::DBObject(3pm)				User Contributed Perl Documentation				  LedgerSMB::DBObject(3pm)

NAME

       LedgerSMB::DBObject - LedgerSMB class for building objects from db relations

SYOPSIS

       This module creates object instances based on LedgerSMB's in-database ORM.

METHODS

       new ($class, base => $LedgerSMB::hash)
	   This is the base constructor for all child classes.	It must be used with base argument because this is necessary for database
	   connectivity and the like.

	   Of course the base object can be any object that inherits LedgerSMB, so you can use any subclass of that.  The per-session dbh is
	   passed between the objects this way as is any information that is needed.

       exec_method
	   ($self, procname => $function_name, [args => @args, schema => $schema, continue_on_error=>$continue_on_error])

	   Provides the basic mapping of parameters to the SQL stored procedure function arguments.

	   If @args is not defined, args are mapped from the object's properties, stripping them of their in_ prefix.	If schema is provided,
	   that is used instead of PostgreSQL's search path.  If continue_on_error is provided and true, the operation will not raise an exception
	   in the event of a database error, and it will be up to the application to handle any exceptions.

       __validate__ is called on every new() invocation.  It is blank in this module but can be overridden in decendant modules.
       _db_array_scalars(@elements) creates a db array from scalars.
       _db_array_literal(@elements) creates a multiple dimension db array from preparsed db arrays or other data which does not need to be
       escaped.
       set_ordering
	   Sets the ordering used by default for specific functions called by exec_method

       run_custom_queries
	   Backward-compatible with 1.2 custom query system for moving forward.

Copyright (C) 2007, The LedgerSMB core team.
       This file is licensed under the Gnu General Public License version 2, or at your option any later version.  A copy of the license should
       have been included with your software.

perl v5.14.2							    2011-12-10						  LedgerSMB::DBObject(3pm)