ledgersmb::dbobject(3pm) [debian man page]
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)
Check Out this Related Man Page
LedgerSMB::DBObject::Admin(3pm) User Contributed Perl Documentation LedgerSMB::DBObject::Admin(3pm) NAME
LedgerSMB::DBObject::Admin - User/group management for LedgerSMB SYNOPSIS
User/group management for LedgerSMB INHERITS
Universal LedgerSMB LedgerSMB::DBObject METHODS
save_user Saves a user optionally with location and contact data. If the password or import hash values is set, will not save contact or address information. This API is not fully documented at this time because it is expected that it will be broken down into more manageable chunks in future versions. Please do not count on the behavior. delete_user($delete_role) Deletes a user specified by $self->{user_id}. if $delete_role is true, deletes the role too. search_users Returns a list of users matching search criteria, and attaches that list to the user_results hash value. Search criteria: username first_name last_name ssn dob Undef matches all values. All matches exact except username which allows for partial matches. list_sessions returns a list of active sessions, when they were last used, and how many discretionary locks they hold. The list is also attached to the active_sessions hash value. No inputs required or used. delete_session Deletes a session identified by the session_id hashref. save_roles Saves the roles assigned to a user. Each role is specified as a hashref true value, where the key is the full name of the role (i.e. starting with lsmb_[dbname]__). get_salutations Returns a list of salutation records from the db for the dropdowns. get_roles Returns a list of role names with the following format: {role => $full_role_name, description => $short_role_name} The short role name is the full role name with the prefix removed (i.e. without the lsmb_[dbname]__ prefix). get_countries Returns a reference to an array of hashrefs including the country data in the db. Sets the same reference to the countries hash value. get_contact_classes Returns a list of hashrefs ({id =>, class =>}) relating to the contact classes. 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::Admin(3pm)