Changeset 1237 for trunk/src/core/AgaviContext.class.php

Timestamp:

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

Author:

dominik

Message:

phpdoc

Files:

• trunk/src/core/AgaviContext.class.php (modified) (6 diffs)

trunk/src/core/AgaviContext.class.php

@@ -123 +123 @@
   protected function __construct() 
   {
-    // Singleton, use Context::getInstance($controller) to get the instance
+    // Singleton, setting up the class happens in initialize()
   }
 
@@ -164 +164 @@
    * @param      name A database name.
    *
-   * @return     mixed An AgaviDatabase instance.
-   *
-   * @throws     <b>AgaviDatabaseException</b> If the requested database name does
-   *                                           not exist.
+   * @return     mixed A database connection.
+   *
+   * @throws     <b>AgaviDatabaseException</b> If the requested database name 
+   *                                           does not exist.
    *
    * @author     Sean Kerr <skerr@mojavi.org>
@@ -195 +195 @@
    * Retrieve the AgaviContext instance.
    *
-   * @param      string name corresponding to a section of the config
-   *
-   * @return     AgaviContext instance of the requested name
+   * If you don't supply a profile name this will try to return the context 
+   * specified in the <kbd>core.default_context</kbd> setting.
+   *
+   * @param      string A name corresponding to a section of the config
+   *
+   * @return     AgaviContext An context instance initialized with the 
+   *                          settings of the requested context name
    *
    * @author     Dominik del Bondio <ddb@bitxtender.com>
@@ -228 +232 @@
    * Retrieve the LoggerManager
    *
-   * @return     AgaviLoggerManager The current LoggerManager implementation instance
+   * @return     AgaviLoggerManager The current LoggerManager implementation 
+   *                                instance.
    *
    * @author     David Zuelke <dz@bitxtender.com>
@@ -241 +246 @@
    * (re)Initialize the AgaviContext instance.
    *
-   * @param      string name corresponding to a section of the config
+   * @param      string A name corresponding to a section of the config
    *
    * @author     Dominik del Bondio <ddb@bitxtender.com>
@@ -492 +497 @@
    * Retrieve the ValidatorManager
    *
-   * @return     AgaviValidatorManager The current ValidatorManager implementation
-   *                                   instance.
+   * @return     AgaviValidatorManager The current ValidatorManager 
+   *                                   implementation instance.
    *
    * @author     David Zuelke <dz@bitxtender.com>