Changeset 1237 for trunk/src/database/AgaviPropelDatabase.class.php

Timestamp:

11/04/06 23:29:49 (2 years ago)

Author:

dominik

Message:

phpdoc

Files:

• trunk/src/database/AgaviPropelDatabase.class.php (modified) (10 diffs)

trunk/src/database/AgaviPropelDatabase.class.php

@@ -75 +75 @@
   /**
    * Stores whether a Propel configuration file path has been explicitly set
-   * as default for use with Propel::init() in database.ini
+   * as default for use with Propel::init() in database.xml
    *
    * @var        bool A flag indicating whether a default config path was set.
@@ -85 +85 @@
   /**
    * Returns the path to the config file that is passed to Propel::init() when
-   * PropelAutoload.php is used in autoload.ini
+   * PropelAutoload.php is used in autoload.xml
    *
    * @return     mixed The path if one has been set, otherwise null
@@ -99 +99 @@
   /**
    * Sets the path to the config file that is passed to Propel::init() when
-   * PropelAutoload.php is used in autoload.ini
+   * PropelAutoload.php is used in autoload.xml
    *
    * @param      string The path to the configuration file
@@ -117 +117 @@
   /**
    * Returns whether a Propel configuration file path has been explicitly set
-   * as default for use with Propel::init() in database.ini
+   * as default for use with Propel::init() in database.xml
    *
    * @return     bool true, if a Propel configuration file path has explicitely
-   *              been set as default in database.ini, otherwise false
+   *                  been set as default in database.ini, otherwise false
    *
    * @author     David Zuelke <dz@bitxtender.com>
@@ -132 +132 @@
   /**
    * Sets a flag indicating a Propel configuration file path has been
-   * explicitly set as default for use with Propel::init() in database.ini
+   * explicitly set as default for use with Propel::init() in database.xml
    *
    * @author     David Zuelke <dz@bitxtender.com>
@@ -144 +144 @@
   /**
    * Connect to the database.
-   * This method is used only if param.use_autoload is false
+   * This method is used only if the <kbd>use_autoload</kbd> parameter is false
    * 
    *
@@ -204 +204 @@
    * @return     mixed A database connection.
    *
-   * @throws     <b>AgaviDatabaseException</b> If a connection could not be retrieved.
+   * @throws     <b>AgaviDatabaseException</b> If a connection could not be
+   *                                           retrieved.
    *
    * @author     Sean Kerr <skerr@mojavi.org>
@@ -241 +242 @@
    * Load Propel config
    * 
+   * @param      AgaviDatabaseManager The database manager of this instance.
    * @param      array An associative array of initialization parameters.
    *
@@ -302 +304 @@
   /**
    * Get the path to the Propel config file for this connection which has been
-   * specified in databases.ini.
+   * specified in databases.xml.
    *
    * @return     string The path to the Propel configuration file
@@ -317 +319 @@
    * Execute the shutdown procedure.
    *
-   * @throws     <b>AgaviDatabaseException</b> If an error occurs while shutting 
+   * @throws     <b>AgaviDatabaseException</b> If an error occurs while shutting
    *                                           down this database.
    *