SF.net SVN: ledger-smb:[6967] trunk/LedgerSMB/Database.pm

[..hidden..]

Revision: 6967
          http://sourceforge.net/p/ledger-smb/code/6967
Author:   einhverfr
Date:     2014-04-04 07:32:00 +0000 (Fri, 04 Apr 2014)
Log Message:
-----------
Updates to Database.pm docs

Modified Paths:
--------------
    trunk/LedgerSMB/Database.pm

Modified: trunk/LedgerSMB/Database.pm
===================================================================
--- trunk/LedgerSMB/Database.pm	2014-04-04 07:22:10 UTC (rev 6966)
+++ trunk/LedgerSMB/Database.pm	2014-04-04 07:32:00 UTC (rev 6967)
@@ -5,8 +5,17 @@
 
 =head1 SYNOPSIS
 
-This module provides the APIs for database creation and management
+This module wraps both DBI and the PostgreSQL commandline tools.
 
+  my $db = LedgerSMB::Database->new({
+       company_name => 'mycompany',
+       username => 'foo',
+       password => 'foospassword'
+  });
+
+  $db->load_modules('LOADORDER');
+
+
 =head1 COPYRIGHT
 
 This module is copyright (C) 2007, the LedgerSMB Core Team and subject to 
@@ -57,7 +66,7 @@
 }
 
 
-=item LedgerSMB::Database->new({dbname = $dbname, countrycode = $cc, chart_name = $name, company_name = $company, username = $username, password = $password})
+=item LedgerSMB::Database->new({company_name = $dbname, countrycode = $cc, chart_name = $name, username = $username, password = $password})
 
 This function creates a new database management object with the specified
 characteristics.  The $dbname is the name of the database. the countrycode
@@ -67,9 +76,6 @@
 As some countries may have multiple available charts, you can also specify
 a chart name as well.
 
-Note that the arguments can be any hashref. If it is a LedgerSMB object,
-however, it will attempt to copy all attributes beginning with _ into the 
-current object (_user, _locale, etc).
 
 =cut
 

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


------------------------------------------------------------------------------
_______________________________________________
Ledger-smb-commits mailing list
..hidden..
https://lists.sourceforge.net/lists/listinfo/ledger-smb-commits