Changeset 1237

Show
Ignore:
Timestamp:
11/04/06 23:29:49 (2 years ago)
Author:
dominik
Message:

phpdoc

Location:
trunk/src
Files:
13 modified

Legend:

Unmodified
Added
Removed

  • trunk/src/core/AgaviContext.class.php

    r1063 r1237  
    123123  protected function __construct()  
    124124  { 
    125     // Singleton, use Context::getInstance($controller) to get the instance 
     125    // Singleton, setting up the class happens in initialize() 
    126126  } 
    127127 
    … …  
    164164   * @param      name A database name. 
    165165   * 
    166    * @return     mixed An AgaviDatabase instance. 
    167    * 
    168    * @throws     <b>AgaviDatabaseException</b> If the requested database name does 
    169    *                                           not exist. 
     166   * @return     mixed A database connection. 
     167   * 
     168   * @throws     <b>AgaviDatabaseException</b> If the requested database name  
     169   *                                           does not exist. 
    170170   * 
    171171   * @author     Sean Kerr <skerr@mojavi.org> 
    … …  
    195195   * Retrieve the AgaviContext instance. 
    196196   * 
    197    * @param      string name corresponding to a section of the config 
    198    * 
    199    * @return     AgaviContext instance of the requested name 
     197   * If you don't supply a profile name this will try to return the context  
     198   * specified in the <kbd>core.default_context</kbd> setting. 
     199   * 
     200   * @param      string A name corresponding to a section of the config 
     201   * 
     202   * @return     AgaviContext An context instance initialized with the  
     203   *                          settings of the requested context name 
    200204   * 
    201205   * @author     Dominik del Bondio <ddb@bitxtender.com> 
    … …  
    228232   * Retrieve the LoggerManager 
    229233   * 
    230    * @return     AgaviLoggerManager The current LoggerManager implementation instance 
     234   * @return     AgaviLoggerManager The current LoggerManager implementation  
     235   *                                instance. 
    231236   * 
    232237   * @author     David Zuelke <dz@bitxtender.com> 
    … …  
    241246   * (re)Initialize the AgaviContext instance. 
    242247   * 
    243    * @param      string name corresponding to a section of the config 
     248   * @param      string A name corresponding to a section of the config 
    244249   * 
    245250   * @author     Dominik del Bondio <ddb@bitxtender.com> 
    … …  
    492497   * Retrieve the ValidatorManager 
    493498   * 
    494    * @return     AgaviValidatorManager The current ValidatorManager implementation 
    495    *                                   instance. 
     499   * @return     AgaviValidatorManager The current ValidatorManager  
     500   *                                   implementation instance. 
    496501   * 
    497502   * @author     David Zuelke <dz@bitxtender.com> 

  • trunk/src/database/AgaviAdodbDatabase.class.php

    r1063 r1237  
    145145   * Load a DSN connection string from an existing array. 
    146146   * 
     147   * @param      array  An array with the connection array at the 'dsn' index. 
     148   * @param      string The connection parameter read method. 
     149   * 
    147150   * @return     array An associative array of connection parameters. 
    148151   * 

  • trunk/src/database/AgaviCreoleDatabase.class.php

    r1063 r1237  
    3939 * # <b>compat_assoc_lower</b> - [Off] - Always lowercase the indexes of assoc  
    4040 *                                      arrays 
    41  * # <b>compat_rtrim_string</b> - [Off] - Trim whitepace from end of string column  
    42  *                                        types 
     41 * # <b>compat_rtrim_string</b> - [Off] - Trim whitepace from end of string  
     42 *                                        column types 
    4343 * # <b>password</b>       - [none]   - The database password. 
    4444 * # <b>persistent</b>     - [No]     - Indicates that the connection should 
    … …  
    158158   * Load a DSN connection string from an existing array. 
    159159   * 
     160   * @param      array  An array containing the connection information. 
     161   * 
    160162   * @return     array An associative array of connection parameters. 
    161163   * 
    … …  
    192194   * Execute the shutdown procedure. 
    193195   * 
    194    * @throws     <b>AgaviDatabaseException</b> If an error occurs while shutting  
     196   * @throws     <b>AgaviDatabaseException</b> If an error occurs while shutting 
    195197   *                                           down this database. 
    196198   * 

  • trunk/src/database/AgaviDatabase.class.php

    r1171 r1237  
    3636   
    3737  /** 
    38    * @var        mixed A database connection 
     38   * @var        mixed A database connection. 
    3939   */ 
    4040  protected $connection = null; 
    … …  
    7878   * @return     mixed A database connection. 
    7979   * 
    80    * @throws     <b>AgaviDatabaseException</b> If a connection could not be retrieved. 
     80   * @throws     <b>AgaviDatabaseException</b> If a connection could not be  
     81   *                                           retrieved. 
    8182   * 
    8283   * @author     Sean Kerr <skerr@mojavi.org> 
    … …  
    115116   * Initialize this Database. 
    116117   * 
     118   * @param      AgaviDatabaseManager The database manager of this instance. 
    117119   * @param      array An associative array of initialization parameters. 
    118120   * 
    … …  
    133135   * Execute the shutdown procedure. 
    134136   * 
    135    * @throws     <b>AgaviDatabaseException</b> If an error occurs while shutting  
     137   * @throws     <b>AgaviDatabaseException</b> If an error occurs while shutting 
    136138   *                                           down this database. 
    137139   * 

  • trunk/src/database/AgaviDatabaseManager.class.php

    r1063 r1237  
    1616 
    1717/** 
    18  * AgaviDatabaseManager allows you to setup your database connectivity before the 
    19  * request is handled. This eliminates the need for a filter to manage database 
    20  * connections. 
     18 * AgaviDatabaseManager allows you to setup your database connectivity before  
     19 * the request is handled. This eliminates the need for a filter to manage  
     20 * database connections. 
    2121 * 
    2222 * @package    agavi 
    … …  
    8181   * Initialize this DatabaseManager. 
    8282   * 
     83   * @param      AgaviContext An AgaviContext instance. 
     84   * @param      array        An array of initialization parameters. 
     85   * 
    8386   * @throws     <b>AgaviInitializationException</b> If an error occurs while 
    8487   *                                                 initializing this  
    … …  
    100103   * Execute the shutdown procedure. 
    101104   * 
    102    * @throws     <b>AgaviDatabaseException</b> If an error occurs while shutting  
     105   * @throws     <b>AgaviDatabaseException</b> If an error occurs while shutting 
    103106   *                                           down this DatabaseManager. 
    104107   * 

  • trunk/src/database/AgaviMysqlDatabase.class.php

    r1063 r1237  
    135135   * Load connection parameters from an existing array. 
    136136   * 
     137   * @param      array An array containing the connection information. 
     138   * 
    137139   * @return     array An associative array of connection parameters. 
    138140   * 

  • trunk/src/database/AgaviPdoDatabase.class.php

    r1063 r1237  
    1515 
    1616/** 
    17  * AgaviPdoDatabase provides connectivity for the PDO database abstraction layer. 
     17 * AgaviPdoDatabase provides connectivity for the PDO database abstraction  
     18 * layer. 
    1819 * 
    1920 * @package    agavi 
    … …  
    3233   * Connect to the database. 
    3334   * 
    34    * @throws     <b>AgaviDatabaseException</b> If a connection could not be created 
     35   * @throws     <b>AgaviDatabaseException</b> If a connection could not be  
     36   *                                           created. 
    3537   * 
    3638   * @author     Daniel Swarbrick (daniel@pressure.net.nz) 

  • trunk/src/database/AgaviPostgresqlDatabase.class.php

    r1063 r1237  
    1616 
    1717/** 
    18  * AgaviPostgresqlDatabase provides connectivity for the PostgreSQL brand database. 
     18 * AgaviPostgresqlDatabase provides connectivity for the PostgreSQL brand  
     19 * database. 
    1920 * 
    2021 * <b>Optional parameters:</b> 
    … …  
    121122   * Load connection parameters from an existing array. 
    122123   * 
     124   * @param      array  An array containing the connection information. 
     125   * 
    123126   * @return     string A connection string. 
    124127   * 

  • trunk/src/database/AgaviPropelDatabase.class.php

    r1189 r1237  
    7575  /** 
    7676   * Stores whether a Propel configuration file path has been explicitly set 
    77    * as default for use with Propel::init() in database.ini 
     77   * as default for use with Propel::init() in database.xml 
    7878   * 
    7979   * @var        bool A flag indicating whether a default config path was set. 
    … …  
    8585  /** 
    8686   * Returns the path to the config file that is passed to Propel::init() when 
    87    * PropelAutoload.php is used in autoload.ini 
     87   * PropelAutoload.php is used in autoload.xml 
    8888   * 
    8989   * @return     mixed The path if one has been set, otherwise null 
    … …  
    9999  /** 
    100100   * Sets the path to the config file that is passed to Propel::init() when 
    101    * PropelAutoload.php is used in autoload.ini 
     101   * PropelAutoload.php is used in autoload.xml 
    102102   * 
    103103   * @param      string The path to the configuration file 
    … …  
    117117  /** 
    118118   * Returns whether a Propel configuration file path has been explicitly set 
    119    * as default for use with Propel::init() in database.ini 
     119   * as default for use with Propel::init() in database.xml 
    120120   * 
    121121   * @return     bool true, if a Propel configuration file path has explicitely 
    122    *              been set as default in database.ini, otherwise false 
     122   *                  been set as default in database.ini, otherwise false 
    123123   * 
    124124   * @author     David Zuelke <dz@bitxtender.com> 
    … …  
    132132  /** 
    133133   * Sets a flag indicating a Propel configuration file path has been 
    134    * explicitly set as default for use with Propel::init() in database.ini 
     134   * explicitly set as default for use with Propel::init() in database.xml 
    135135   * 
    136136   * @author     David Zuelke <dz@bitxtender.com> 
    … …  
    144144  /** 
    145145   * Connect to the database. 
    146    * This method is used only if param.use_autoload is false 
     146   * This method is used only if the <kbd>use_autoload</kbd> parameter is false 
    147147   *  
    148148   * 
    … …  
    204204   * @return     mixed A database connection. 
    205205   * 
    206    * @throws     <b>AgaviDatabaseException</b> If a connection could not be retrieved. 
     206   * @throws     <b>AgaviDatabaseException</b> If a connection could not be 
     207   *                                           retrieved. 
    207208   * 
    208209   * @author     Sean Kerr <skerr@mojavi.org> 
    … …  
    241242   * Load Propel config 
    242243   *  
     244   * @param      AgaviDatabaseManager The database manager of this instance. 
    243245   * @param      array An associative array of initialization parameters. 
    244246   * 
    … …  
    302304  /** 
    303305   * Get the path to the Propel config file for this connection which has been 
    304    * specified in databases.ini. 
     306   * specified in databases.xml. 
    305307   * 
    306308   * @return     string The path to the Propel configuration file 
    … …  
    317319   * Execute the shutdown procedure. 
    318320   * 
    319    * @throws     <b>AgaviDatabaseException</b> If an error occurs while shutting  
     321   * @throws     <b>AgaviDatabaseException</b> If an error occurs while shutting 
    320322   *                                           down this database. 
    321323   * 

  • trunk/src/exception/AgaviAutoloadException.class.php

    r549 r1237  
    1616 
    1717/** 
    18  * AgaviAutoloadException is thrown when a class that has been required cannot be 
    19  * loaded. 
     18 * AgaviAutoloadException is thrown when a class that has been required cannot 
     19 * be loaded. 
    2020 * 
    2121 * @package    agavi 

  • trunk/src/exception/AgaviException.class.php

    r1063 r1237  
    3535   * Print the stack trace for this exception. 
    3636   * 
    37    * @param      string The format you wish to use for printing. Options 
    38    *                    include: 
    39    *                    - html 
    40    *                    - plain 
     37   * @param      Exception     The original exception. 
     38   * @param      AgaviContext  The context instance. 
     39   * @param      AgaviResponse The response instance. 
    4140   * 
    4241   * @author     Sean Kerr <skerr@mojavi.org> 

  • trunk/src/exception/AgaviFileException.class.php

    r549 r1237  
    1616 
    1717/** 
    18  * AgaviFileException is thrown when an error occurs while moving an uploaded file. 
     18 * AgaviFileException is thrown when an error occurs while moving an uploaded  
     19 * file. 
    1920 * 
    2021 * @package    agavi 

  • trunk/src/exception/AgaviInitializationException.class.php

    r549 r1237  
    1616 
    1717/** 
    18  * AgaviInitializationException is thrown when an initialization procedure fails. 
     18 * AgaviInitializationException is thrown when an initialization procedure  
     19 * fails. 
    1920 * 
    2021 * @package    agavi