Development

Changeset 17858

You must first sign up to be able to contribute.

Changeset 17858

Show
Ignore:
Timestamp:
05/01/09 23:22:50 (11 months ago)
Author:
FabianLange
Message:

[1.1, 1.2, 1.3] fixed some codeing standards (fixes #6376 - patch from gimler)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • branches/1.1/lib/action/sfActionStack.class.php

    r9044 r17858  
    2828   * Adds an entry to the action stack. 
    2929   * 
    30    * @param string   $moduleName      A module name 
    31    * @param string   $actionName      An action name 
    32    * @param sfAction $actionInstance An sfAction implementation instance 
     30   * @param string   $moduleName     A module name 
     31   * @param string   $actionName     An action name 
     32   * @param sfAction $actionInstance An sfAction implementation instance 
    3333   * 
    3434   * @return sfActionStackEntry sfActionStackEntry instance 
  • branches/1.1/lib/action/sfActionStackEntry.class.php

    r9044 r17858  
    3030   * Class constructor. 
    3131   * 
    32    * @param string   $moduleName      A module name 
    33    * @param string   $actionName      An action name 
    34    * @param sfAction $actionInstance An sfAction implementation instance 
     32   * @param string   $moduleName     A module name 
     33   * @param string   $actionName     An action name 
     34   * @param sfAction $actionInstance An sfAction implementation instance 
    3535   */ 
    3636  public function __construct($moduleName, $actionName, $actionInstance) 
  • branches/1.1/lib/action/sfActions.class.php

    r9044 r17858  
    2727   * defined action name. 
    2828   * 
    29    * @param sfRequest $request The current sfRequest object 
     29   * @param sfRequest $request The current sfRequest object 
    3030   * 
    3131   * @return string    A string containing the view name associated with this action 
  • branches/1.1/lib/autoload/sfAutoload.class.php

    r12676 r17858  
    123123   * Handles autoloading of classes that have been specified in autoload.yml. 
    124124   * 
    125    * @param string  $class A class name. 
     125   * @param string $class A class name. 
    126126   * 
    127127   * @return boolean Returns true if the class has been loaded 
     
    148148   * Tries to load a class that has been specified in autoload.yml. 
    149149   * 
    150    * @param string  $class A class name. 
     150   * @param string $class A class name. 
    151151   * 
    152152   * @return boolean Returns true if the class has been loaded 
  • branches/1.1/lib/cache/sfCache.class.php

    r9084 r17858  
    3939   * Initializes this sfCache instance. 
    4040   * 
    41    * @param array $options An array of options. 
     41   * @param array $options An array of options. 
    4242   * 
    4343   * Available options: 
     
    6767   * Gets the cache content for a given key. 
    6868   * 
    69    * @param string $key      The cache key 
    70    * @param mixed  $default The default value is the key does not exist or not valid anymore 
    71    * 
    72    * @return mixed The data of the cache 
     69   * @param string $key     The cache key 
     70   * @param mixed  $default The default value is the key does not exist or not valid anymore 
     71   * 
     72   * @return mixed The data of the cache 
    7373   */ 
    7474  abstract public function get($key, $default = null); 
     
    7777   * Returns true if there is a cache for the given key. 
    7878   * 
    79    * @param string  $key The cache key 
     79   * @param string $key The cache key 
    8080   * 
    8181   * @return Boolean true if the cache exists, false otherwise 
     
    8686   * Saves some data in the cache. 
    8787   * 
    88    * @param string $key      The cache key 
    89    * @param mixed  $data      The data to put in cache 
    90    * @param int    $lifetime The lifetime 
     88   * @param string $key      The cache key 
     89   * @param mixed  $data     The data to put in cache 
     90   * @param int    $lifetime The lifetime 
    9191   * 
    9292   * @return Boolean true if no problem 
     
    106106   * Removes content from the cache that matches the given pattern. 
    107107   * 
    108    * @param string $pattern The cache key pattern 
     108   * @param string $pattern The cache key pattern 
    109109   * 
    110110   * @return Boolean true if no problem 
     
    117117   * Cleans the cache. 
    118118   * 
    119    * @param string  $mode The clean mode 
    120    *                        sfCache::ALL: remove all keys (default) 
    121    *                        sfCache::OLD: remove all expired keys 
     119   * @param string $mode The clean mode 
     120   *                     sfCache::ALL: remove all keys (default) 
     121   *                     sfCache::OLD: remove all expired keys 
    122122   * 
    123123   * @return Boolean true if no problem 
     
    146146   * Gets many keys at once. 
    147147   * 
    148    * @param array $keys An array of keys 
     148   * @param array $keys An array of keys 
    149149   * 
    150150   * @return array An associative array of data from cache 
     
    164164   * Computes lifetime. 
    165165   * 
    166    * @param integer $lifetime Lifetime in seconds 
     166   * @param integer $lifetime Lifetime in seconds 
    167167   * 
    168168   * @return integer Lifetime in seconds 
     
    186186   * Gets an option value. 
    187187   * 
    188    * @param string $name     The option name 
    189    * @param mixed  $default The default value 
    190    * 
    191    * @return mixed The option value 
     188   * @param string $name    The option name 
     189   * @param mixed  $default The default value 
     190   * 
     191   * @return mixed The option value 
    192192   */ 
    193193  public function getOption($name, $default = null) 
     
    215215   *  - ** Matches one or more namespaces (foo:**:bar) 
    216216   * 
    217    * @param string $pattern A pattern 
     217   * @param string $pattern A pattern 
    218218   * 
    219219   * @return string A regular expression 
  • branches/1.1/lib/cache/sfFunctionCache.class.php

    r9084 r17858  
    4848   * $cache->call(array($object, 'methodName'), array($arg1, $arg2)); 
    4949   * 
    50    * @param mixed $callable  A PHP callable 
    51    * @param array $arguments An array of arguments to pass to the callable 
     50   * @param mixed $callable  A PHP callable 
     51   * @param array $arguments An array of arguments to pass to the callable 
    5252   * 
    5353   * @return mixed The result of the function/method 
  • branches/1.1/lib/cache/sfXCacheCache.class.php

    r17478 r17858  
    5151    $set = $this->getBaseValue($key); 
    5252     
    53     if(!is_array($set) || !array_key_exists('data', $set)) 
     53    if (!is_array($set) || !array_key_exists('data', $set)) 
    5454    { 
    5555       
     
    122122    $set = $this->getBaseValue($key); 
    123123     
    124     if(!is_array($set) || !array_key_exists('ctime', $set)) 
     124    if (!is_array($set) || !array_key_exists('ctime', $set)) 
    125125    { 
    126126       
     
    139139    $set = $this->getBaseValue($key); 
    140140     
    141     if(!is_array($set) || !array_key_exists('timeout', $set)) 
     141    if (!is_array($set) || !array_key_exists('timeout', $set)) 
    142142    { 
    143143       
  • branches/1.1/lib/command/sfCommandArgument.class.php

    r9076 r17858  
    3333   * Constructor. 
    3434   * 
    35    * @param string  $name    The argument name 
    36    * @param integer $mode    The argument mode: self::REQUIRED or self::OPTIONAL 
    37    * @param string  $help    A help text 
    38    * @param mixed   $default The default value (for self::OPTIONAL mode only) 
     35   * @param string  $name    The argument name 
     36   * @param integer $mode    The argument mode: self::REQUIRED or self::OPTIONAL 
     37   * @param string  $help    A help text 
     38   * @param mixed   $default The default value (for self::OPTIONAL mode only) 
    3939   */ 
    4040  public function __construct($name, $mode = null, $help = '', $default = null) 
  • branches/1.1/lib/command/sfCommandArgumentSet.class.php

    r9076 r17858  
    106106   * Returns an argument by name. 
    107107   * 
    108    * @param string $name The argument name 
     108   * @param string $name The argument name 
    109109   * 
    110110   * @return sfCommandArgument A sfCommandArgument object 
     
    123123   * Returns true if an argument object exists by name. 
    124124   * 
    125    * @param string  $name The argument name 
     125   * @param string $name The argument name 
    126126   * 
    127127   * @return Boolean true if the argument object exists, false otherwise 
  • branches/1.1/lib/command/sfCommandLogger.class.php

    r15485 r17858  
    2121   * Initializes this logger. 
    2222   * 
    23    * @param sfEventDispatcher $dispatcher A sfEventDispatcher instance 
    24    * @param array             $options     An array of options. 
     23   * @param sfEventDispatcher $dispatcher A sfEventDispatcher instance 
     24   * @param array             $options    An array of options. 
    2525   */ 
    2626  public function initialize(sfEventDispatcher $dispatcher, $options = array()) 
  • branches/1.1/lib/command/sfCommandManager.class.php

    r16343 r17858  
    206206   * Returns the argument value for a given argument name. 
    207207   * 
    208    * @param string $name The argument name 
     208   * @param string $name The argument name 
    209209   * 
    210210   * @return mixed The argument value 
     
    233233   * Returns the option value for a given option name. 
    234234   * 
    235    * @param string $name The option name 
     235   * @param string $name The option name 
    236236   * 
    237237   * @return mixed The option value 
  • branches/1.1/lib/command/sfCommandOption.class.php

    r9076 r17858  
    3535   * Constructor. 
    3636   * 
    37    * @param string  $name       The option name 
    38    * @param string  $shortcut   The shortcut (can be null) 
    39    * @param integer $mode       The option mode: self::PARAMETER_REQUIRED, self::PARAMETER_NONE or self::PARAMETER_OPTIONAL 
    40    * @param string  $help       A help text 
    41    * @param mixed   $default    The default value (must be null for self::PARAMETER_REQUIRED or self::PARAMETER_NONE) 
     37   * @param string  $name     The option name 
     38   * @param string  $shortcut The shortcut (can be null) 
     39   * @param integer $mode     The option mode: self::PARAMETER_REQUIRED, self::PARAMETER_NONE or self::PARAMETER_OPTIONAL 
     40   * @param string  $help     A help text 
     41   * @param mixed   $default  The default value (must be null for self::PARAMETER_REQUIRED or self::PARAMETER_NONE) 
    4242   */ 
    4343  public function __construct($name, $shortcut = null, $mode = null, $help = '', $default = null) 
  • branches/1.1/lib/command/sfCommandOptionSet.class.php

    r9076 r17858  
    8484   * Returns an option by name. 
    8585   * 
    86    * @param string $name The option name 
     86   * @param string $name The option name 
    8787   * 
    8888   * @return sfCommandOption A sfCommandOption object 
     
    101101   * Returns true if an option object exists by name. 
    102102   * 
    103    * @param string  $name The option name 
     103   * @param string $name The option name 
    104104   * 
    105105   * @return Boolean true if the option object exists, false otherwise 
     
    123123   * Returns true if an option object exists by shortcut. 
    124124   * 
    125    * @param string  $name The option shortcut 
     125   * @param string $name The option shortcut 
    126126   * 
    127127   * @return Boolean true if the option object exists, false otherwise 
     
    161161   * Returns the option name given a shortcut. 
    162162   * 
    163    * @param string $shortcut The shortcut 
     163   * @param string $shortcut The shortcut 
    164164   * 
    165165   * @return string The option name 
  • branches/1.1/lib/command/sfFormatter.class.php

    r9076 r17858  
    3030   * Formats a text according to the given parameters. 
    3131   * 
    32    * @param string $text         The test to style 
    33    * @param mixed  $parameters  An array of parameters 
    34    * @param stream $stream       A stream (default to STDOUT) 
     32   * @param string $text       The test to style 
     33   * @param mixed  $parameters An array of parameters 
     34   * @param stream $stream     A stream (default to STDOUT) 
    3535   * 
    3636   * @return string The formatted text 
     
    4444   * Formats a message within a section. 
    4545   * 
    46    * @param string  $section The section name 
    47    * @param string  $text    The text message 
    48    * @param integer $size    The maximum size allowed for a line (65 by default) 
     46   * @param string  $section The section name 
     47   * @param string  $text    The text message 
     48   * @param integer $size    The maximum size allowed for a line (65 by default) 
    4949   */ 
    5050  public function formatSection($section, $text, $size = null) 
  • branches/1.1/lib/config/sfCacheConfigHandler.class.php

    r9085 r17858  
    6868   * Returns a single addCache statement. 
    6969   * 
    70    * @param string $actionName The action name 
     70   * @param string $actionName The action name 
    7171   * 
    7272   * @return string PHP code for the addCache statement 
  • branches/1.1/lib/config/sfCompileConfigHandler.class.php

    r9085 r17858  
    6767 
    6868      // replace windows and mac format with unix format 
    69       $contents = str_replace("\r", "\n", $contents); 
     69      $contents = str_replace("\r", "\n", $contents); 
    7070 
    7171      // replace multiple new lines with a single newline 
  • branches/1.1/lib/config/sfConfigCache.class.php

    r16899 r17858  
    4141   * Loads a configuration handler. 
    4242   * 
    43    * @param string $handler   The handler to use when parsing a configuration file 
    44    * @param array  $configs   An array of absolute filesystem paths to configuration files 
    45    * @param string $cache     An absolute filesystem path to the cache file that will be written 
     43   * @param string $handler The handler to use when parsing a configuration file 
     44   * @param array  $configs An array of absolute filesystem paths to configuration files 
     45   * @param string $cache   An absolute filesystem path to the cache file that will be written 
    4646   * 
    4747   * @throws <b>sfConfigurationException</b> If a requested configuration file does not have an associated configuration handler 
     
    111111   * Returns the config handler configured for the given name 
    112112   * 
    113    * @param string $name The config handler name 
     113   * @param string $name The config handler name 
    114114   * 
    115115   * @return sfConfigHandler A sfConfigHandler instance 
     
    135135   * defined in the sfConfiguration::getConfigPaths() method. 
    136136   * 
    137    * @param string  $configPath A filesystem path to a configuration file 
    138    * @param boolean $optional    If true, config path does not need to exist 
     137   * @param string  $configPath A filesystem path to a configuration file 
     138   * @param boolean $optional   If true, config path does not need to exist 
    139139   * 
    140140   * @return string An absolute filesystem path to the cache filename associated with this specified configuration file 
     
    236236   * Imports a configuration file. 
    237237   * 
    238    * @param string $config    A filesystem path to a configuration file 
    239    * @param bool   $once      Only allow this configuration file to be included once per request? 
    240    * @param bool   $optional Only include if true 
     238   * @param string $config   A filesystem path to a configuration file 
     239   * @param bool   $once     Only allow this configuration file to be included once per request? 
     240   * @param bool   $optional Only include if true 
    241241   * 
    242242   * @see checkConfig() 
     
    322322   * Writes a cache file. 
    323323   * 
    324    * @param string $config An absolute filesystem path to a configuration file 
    325    * @param string $cache  An absolute filesystem path to the cache file that will be written 
    326    * @param string $data    Data to be written to the cache file 
     324   * @param string $config An absolute filesystem path to a configuration file 
     325   * @param string $cache  An absolute filesystem path to the cache file that will be written 
     326   * @param string $data   Data to be written to the cache file 
    327327   * 
    328328   * @throws sfCacheException If the cache file cannot be written 
     
    367367   * Registers a configuration handler. 
    368368   * 
    369    * @param string $handler   The handler to use when parsing a configuration file 
    370    * @param class  $class     A configuration handler class 
    371    * @param string $params    An array of options for the handler class initialization 
     369   * @param string $handler The handler to use when parsing a configuration file 
     370   * @param class  $class   A configuration handler class 
     371   * @param string $params  An array of options for the handler class initialization 
    372372   */ 
    373373  public function registerConfigHandler($handler, $class, $params = array()) 
  • branches/1.1/lib/config/sfDefineEnvironmentConfigHandler.class.php

    r9085 r17858  
    2121   * Executes this configuration handler. 
    2222   * 
    23    * @param string $configFiles An absolute filesystem path to a configuration file 
     23   * @param string $configFiles An absolute filesystem path to a configuration file 
    2424   * 
    2525   * @return string Data to be written to a cache file 
     
    7070   * Gets values from the configuration array. 
    7171   * 
    72    * @param string $prefix    The prefix name 
    73    * @param string $category The category name 
     72   * @param string $prefix   The prefix name 
     73   * @param string $category The category name 
    7474   * @param mixed  $keys      The key/value array 
    7575   * 
     
    102102   * Fixes the category name and replaces constants in the value. 
    103103   * 
    104    * @param string $category The category name 
    105    * @param string $key      The key name 
    106    * @param string $value    The value 
     104   * @param string $category The category name 
     105   * @param string $key      The key name 
     106   * @param string $value    The value 
    107107   * 
    108108   * @return string Return the new key and value 
     
    116116   * Fixes the category name. 
    117117   * 
    118    * @param string $category The category name 
    119    * @param string $prefix    The prefix 
     118   * @param string $category The category name 
     119   * @param string $prefix   The prefix 
    120120   * 
    121121   * @return string The fixed category name 
  • branches/1.1/lib/config/sfFilterConfigHandler.class.php

    r9400 r17858  
    130130   * Adds a filter statement to the data. 
    131131   * 
    132    * @param string $category    The category name 
    133    * @param string $class      The filter class name 
    134    * @param array  $parameters Filter default parameters 
     132   * @param string $category   The category name 
     133   * @param string $class      The filter class name 
     134   * @param array  $parameters Filter default parameters 
    135135   * 
    136136   * @return string The PHP statement 
  • branches/1.1/lib/config/sfViewConfigHandler.class.php

    r17714 r17858  
    155155   * Adds a layout statement statement to the data. 
    156156   * 
    157    * @param string $viewName The view name 
     157   * @param string $viewName The view name 
    158158   * 
    159159   * @return string The PHP statement 
     
    209209   * Adds http metas and metas statements to the data. 
    210210   * 
    211    * @param string $viewName The view name 
     211   * @param string $viewName The view name 
    212212   * 
    213213   * @return string The PHP statement 
  • branches/1.1/lib/config/sfYamlConfigHandler.class.php

    r9085 r17858  
    2626   * Parses an array of YAMLs files and merges them in one configuration array. 
    2727   * 
    28    * @param array $configFiles An array of configuration file paths 
     28   * @param array $configFiles An array of configuration file paths 
    2929   * 
    3030   * @return array A merged configuration array 
     
    7474   * Merges configuration values for a given key and category. 
    7575   * 
    76    * @param string $keyName  The key name 
    77    * @param string $category The category name 
     76   * @param string $keyName  The key name 
     77   * @param string $category The category name 
    7878   * 
    7979   * @return string The value associated with this key name and category 
     
    9999   * Gets a configuration value for a given key and category. 
    100100   * 
    101    * @param string $keyName      The key name 
    102    * @param string $category      The category name 
    103    * @param string $defaultValue The default value 
     101   * @param string $keyName      The key name 
     102   * @param string $category     The category name 
     103   * @param string $defaultValue The default value 
    104104   * 
    105105   * @return string The value associated with this key name and category 
  • branches/1.1/lib/controller/sfConsoleController.class.php

    r9078 r17858  
    2020   * Dispatches a request. 
    2121   * 
    22    * @param string $moduleName A module name 
    23    * @param string $actionName An action name 
    24    * @param array  $parameters An associative array of parameters to be set 
     22   * @param string $moduleName A module name 
     23   * @param string $actionName An action name 
     24   * @param array  $parameters An associative array of parameters to be set 
    2525   */ 
    2626  public function dispatch($moduleName, $actionName, $parameters = array()) 
  • branches/1.1/lib/database/sfMySQLiDatabase.class.php

    r14869 r17858  
    2020   * Returns the appropriate connect method. 
    2121   * 
    22    * @param bool $persistent Whether persistent connections are use or not 
    23    *                          The MySQLi driver does not support persistent 
    24    *                          connections so this argument is ignored. 
     22   * @param bool $persistent Whether persistent connections are use or not 
     23   *                         The MySQLi driver does not support persistent 
     24   *                         connections so this argument is ignored. 
    2525   * 
    2626   * @return string name of connect method 
     
    3434   * Selects the database to be used in this connection 
    3535   * 
    36    * @param string $database Name of database to be connected 
     36   * @param string $database Name of database to be connected 
    3737   * 
    3838   * @return bool true if this was successful 
  • branches/1.1/lib/database/sfPDODatabase.class.php

    r9372 r17858  
    6767 
    6868    // lets generate exceptions instead of silent failures 
    69     if(sfConfig::get('sf_debug')) 
     69    if (sfConfig::get('sf_debug')) 
    7070    { 
    7171      $this->connection->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); 
     
    7878    // compatability 
    7979    $compatability = $this->getParameter('compat'); 
    80     if($compatability) 
     80    if ($compatability) 
    8181    { 
    8282      $this->connection->setAttribute(PDO::ATTR_CASE, PDO::CASE_NATURAL); 
     
    8585    // nulls 
    8686    $nulls = $this->getParameter('nulls'); 
    87     if($nulls) 
     87    if ($nulls) 
    8888    { 
    8989      $this->connection->setAttribute(PDO::ATTR_ORACLE_NULLS, PDO::NULL_EMPTY_STRING); 
     
    9292    // auto commit 
    9393    $autocommit = $this->getParameter('autocommit'); 
    94     if($autocommit) 
     94    if ($autocommit) 
    9595    { 
    9696      $this->connection->setAttribute(PDO::ATTR_AUTOCOMMIT, true); 
  • branches/1.1/lib/debug/sfDebug.class.php

    r9079 r17858  
    4848    if ($values['extensions']) 
    4949    { 
    50       foreach($values['extensions'] as $key => $extension) 
     50      foreach ($values['extensions'] as $key => $extension) 
    5151      { 
    5252        $values['extensions'][$key] = phpversion($extension) ? sprintf('%s (%s)', $extension, phpversion($extension)) : $extension; 
  • branches/1.1/lib/event/sfEvent.class.php

    r8698 r17858  
    2929   * Constructs a new sfEvent. 
    3030   * 
    31    * @param mixed  $subject      The subject 
    32    * @param string $name         The event name 
    33    * @param array  $parameters  An array of parameters 
     31   * @param mixed  $subject    The subject 
     32   * @param string $name       The event name 
     33   * @param array  $parameters An array of parameters 
    3434   */ 
    3535  public function __construct($subject, $name, $parameters = array()) 
     
    114114   * Returns true if the parameter exists (implements the ArrayAccess interface). 
    115115   * 
    116    * @param string  $name The parameter name 
     116   * @param string $name The parameter name 
    117117   * 
    118118   * @return Boolean true if the parameter exists, false otherwise 
     
    126126   * Returns a parameter value (implements the ArrayAccess interface). 
    127127   * 
    128    * @param string  $name The parameter name 
     128   * @param string $name The parameter name 
    129129   * 
    130    * @return mixed The parameter value 
     130   * @return mixed The parameter value 
    131131   */ 
    132132  public function offsetGet($name) 
     
    143143   * Sets a parameter (implements the ArrayAccess interface). 
    144144   * 
    145    * @param string $name   The parameter name 
    146    * @param mixed  $value The parameter value  
     145   * @param string $name  The parameter name 
     146   * @param mixed  $value The parameter value  
    147147   */ 
    148148  public function offsetSet($name, $value) 
     
    154154   * Removes a parameter (implements the ArrayAccess interface). 
    155155   * 
    156    * @param string $name    The parameter name 
     156   * @param string $name The parameter name 
    157157   */ 
    158158  public function offsetUnset($name) 
  • branches/1.1/lib/event/sfEventDispatcher.class.php

    r10632 r17858  
    2727   * Connects a listener to a given event name. 
    2828   * 
    29    * @param string $name      An event name 
    30    * @param mixed  $listener A PHP callable 
     29   * @param string $name     An event name 
     30   * @param mixed  $listener A PHP callable 
    3131   */ 
    3232  public function connect($name, $listener) 
     
    4343   * Disconnects a listener for a given event name. 
    4444   * 
    45    * @param string   $name      An event name 
    46    * @param mixed    $listener A PHP callable 
     45   * @param string $name     An event name 
     46   * @param mixed  $listener A PHP callable 
    4747   * 
    4848   * @return mixed false if listener does not exist, null otherwise 
     
    8484   * Notifies all listeners of a given event until one returns a non null value. 
    8585   * 
    86    * @param sfEvent $event A sfEvent instance 
     86   * @param sfEvent $event A sfEvent instance 
    8787   * 
    8888   * @return sfEvent The sfEvent instance 
     
    105105   * Filters a value by calling all listeners of a given event. 
    106106   * 
    107    * @param sfEvent  $event  A sfEvent instance 
    108    * @param mixed    $value  The value to be filtered 
     107   * @param sfEvent $event A sfEvent instance 
     108   * @param mixed   $value The value to be filtered 
    109109   * 
    110110   * @return sfEvent The sfEvent instance 
     
    125125   * Returns true if the given event name has some listeners. 
    126126   * 
    127    * @param string   $name    The event name 
     127   * @param string $name The event name 
    128128   * 
    129129   * @return Boolean true if some listeners are connected, false otherwise 
     
    142142   * Returns all listeners associated with a given event name. 
    143143   * 
    144    * @param string   $name    The event name 
     144   * @param string $name The event name 
    145145   * 
    146    * @return array An array of listeners 
     146   * @return array An array of listeners 
    147147   */ 
    148148  public function getListeners($name) 
  • branches/1.1/lib/filter/sfCacheFilter.class.php

    r17468 r17858  
    2929   * Initializes this Filter. 
    3030   * 
    31    * @param sfContext $context      The current application context 
    32    * @param array     $parameters   An associative array of initialization parameters 
     31   * @param sfContext $context    The current application context 
     32   * @param array     $parameters An associative array of initialization parameters 
    3333   * 
    3434   * @return bool true, if initialization completes successfully, otherwise false 
  • branches/1.1/lib/filter/sfExecutionFilter.class.php

    r16250 r17858  
    5959   * Handles the action. 
    6060   * 
    61    * @param sfFilterChain $filterChain     The current filter chain 
    62    * @param sfAction      $actionInstance An sfAction instance 
     61   * @param sfFilterChain $filterChain    The current filter chain 
     62   * @param sfAction      $actionInstance An sfAction instance 
    6363   * 
    64    * @return string        The view type 
     64   * @return string The view type 
    6565   */ 
    6666  protected function handleAction($filterChain, $actionInstance) 
     
    8080   * Executes the execute method of an action. 
    8181   * 
    82    * @param sfAction $actionInstance An sfAction instance 
     82   * @param sfAction $actionInstance An sfAction instance 
    8383   * 
    84    * @return string   The view type 
     84   * @return string The view type 
    8585   */ 
    8686  protected function executeAction($actionInstance) 
     
    9797   * Handles the view. 
    9898   * 
    99    * @param sfFilterChain $filterChain     The current filter chain 
    100    * @param sfAction      $actionInstance An sfAction instance 
    101    * @param string        $viewName        The view name 
     99   * @param sfFilterChain $filterChain    The current filter chain 
     100   * @param sfAction      $actionInstance An sfAction instance 
     101   * @param string        $viewName       The view name 
    102102   */ 
    103103  protected function handleView($filterChain, $actionInstance, $viewName) 
     
    124124   *   - sfView::RENDER_DATA: View data populates the data presentation variable. 
    125125   * 
    126    * @param string $moduleName     The module name 
    127    * @param string $actionName     The action name 
    128    * @param string $viewName       The view name 
    129    * @param array  $viewAttributes An array of view attributes 
     126   * @param string $moduleName     The module name 
     127   * @param string $actionName     The action name 
     128   * @param string $viewName       The view name 
     129   * @param array  $viewAttributes An array of view attributes 
    130130   * 
    131131   * @return string The view data 
  • branches/1.1/lib/filter/sfFilter.class.php

    r9087 r17858  
    124124   * <code>$this->getParameterHolder()->has()</code> 
    125125   * 
    126    * @param string $name The key name 
     126   * @param string $name The key name 
    127127   * 
    128128   * @return boolean true if the given key exists, false otherwise 
  • branches/1.1/lib/form/sfFormFieldSchema.class.php

    r17587 r17858  
    2727   * Constructor. 
    2828   * 
    29    * @param sfWidgetFormSchema $widget A sfWidget instance 
    30    * @param sfFormField        $parent The sfFormField parent instance (null for the root widget) 
    31    * @param string             $name    The field name 
    32    * @param string             $value  The field value 
    33    * @param sfValidatorError   $error  A sfValidatorError instance 
     29   * @param sfWidgetFormSchema $widget A sfWidget instance 
     30   * @param sfFormField        $parent The sfFormField parent instance (null for the root widget) 
     31   * @param string             $name   The field name 
     32   * @param string             $value  The field value 
     33   * @param sfValidatorError   $error  A sfValidatorError instance 
    3434   */ 
    3535  public function __construct(sfWidgetFormSchema $widget, sfFormField $parent = null, $name, $value, sfValidatorError $error = null) 
     
    4343   * Returns true if the bound field exists (implements the ArrayAccess interface). 
    4444   * 
    45    * @param string  $name The name of the bound field 
     45   * @param string $name The name of the bound field 
    4646   * 
    4747   * @return Boolean true if the widget exists, false otherwise 
     
    5555   * Returns the form field associated with the name (implements the ArrayAccess interface). 
    5656   * 
    57    * @param string $name The offset of the value to get 
     57   * @param string $name The offset of the value to get 
    5858   * 
    5959   * @return sfFormField A form field instance 
  • branches/1.1/lib/generator/sfGenerator.class.php

    r9123 r17858  
    5858   * Generates PHP files for a given module name. 
    5959   * 
    60    * @param string $generatedModuleName   The name of module name to generate 
    61    * @param array  $files                 A list of template files to generate 
     60   * @param string $generatedModuleName The name of module name to generate 
     61   * @param array  $files               A list of template files to generate 
    6262   */ 
    6363  protected function generatePhpFiles($generatedModuleName, $files = array()) 
     
    7272   * Evaluates a template file. 
    7373   * 
    74    * @param string $templateFile The template file path 
     74   * @param string $templateFile The template file path 
    7575   * 
    7676   * @return string The evaluated template 
  • branches/1.1/lib/helper/EscapingHelper.php

    r9101 r17858  
    3535 * Runs the PHP function htmlentities on the value passed. 
    3636 * 
    37  * @param string $value the value to escape 
     37 * @param string $value the value to escape 
    3838 * @return string the escaped value 
    3939 */ 
     
    5050 * Runs the PHP function htmlspecialchars on the value passed. 
    5151 * 
    52  * @param string $value the value to escape 
     52 * @param string $value the value to escape 
    5353 * @return string the escaped value 
    5454 */ 
     
    6666 * being to be able to specify that the value is not to be escaped in any way. 
    6767 * 
    68  * @param string $value the value to escape 
     68 * @param string $value the value to escape 
    6969 * @return string the escaped value 
    7070 */ 
     
    8585 * that is ultimately not going to end up as text in an HTML document. 
    8686 * 
    87  * @param string $value the value to escape 
     87 * @param string $value the value to escape 
    8888 * @return string the escaped value 
    8989 */ 
     
    9999 * JavaScript string. 
    100100 * 
    101  * @param string $value the value to escape 
     101 * @param string $value the value to escape 
    102102 * @return string the escaped value 
    103103 */ 
  • branches/1.2/lib/action/sfAction.class.php

    r17749 r17858  
    7878   * Forwards current action to the default 404 error action unless the specified condition is true. 
    7979   * 
    80    * @param bool    $condition A condition that evaluates to true or false 
    81    * @param string $message    Message of the generated exception 
     80   * @param bool   $condition A condition that evaluates to true or false 
     81   * @param string $message   Message of the generated exception 
    8282   * 
    8383   * @throws sfError404Exception 
     
    9494   * Forwards current action to the default 404 error action if the specified condition is true. 
    9595   * 
    96    * @param bool    $condition A condition that evaluates to true or false 
    97    * @param string $message    Message of the generated exception 
     96   * @param bool   $condition A condition that evaluates to true or false 
     97   * @param string $message   Message of the generated exception 
    9898   * 
    9999   * @throws sfError404Exception 
     
    122122   * This method stops the action. So, no code is executed after a call to this method. 
    123123   * 
    124    * @param string  $module A module name 
    125    * @param string  $action An action name 
     124   * @param string $module A module name 
     125   * @param string $action An action name 
    126126   * 
    127127   * @throws sfStopException 
     
    144144   * This method stops the action. So, no code is executed after a call to this method. 
    145145   * 
    146    * @param bool   $condition A condition that evaluates to true or false 
    147    * @param string $module     A module name 
    148    * @param string $action     An action name 
     146   * @param bool   $condition A condition that evaluates to true or false 
     147   * @param string $module    A module name 
     148   * @param string $action    An action name 
    149149   * 
    150150   * @throws sfStopException 
     
    163163   * This method stops the action. So, no code is executed after a call to this method. 
    164164   * 
    165    * @param bool   $condition A condition that evaluates to true or false 
    166    * @param string $module     A module name 
    167    * @param string $action     An action name 
     165   * @param bool   $condition A condition that evaluates to true or false 
     166   * @param string $module    A module name 
     167   * @param string $action    An action name 
    168168   * 
    169169   * @throws sfStopException 
     
    186186   * This method stops the action. So, no code is executed after a call to this method. 
    187187   * 
    188    * @param string $url         Url 
    189    * @param string $statusCode Status code (default to 302) 
     188   * @param string $url        Url 
     189   * @param string $statusCode Status code (default to 302) 
    190190   * 
    191191   * @throws sfStopException 
     
    203203   * This method stops the action. So, no code is executed after a call to this method. 
    204204   * 
    205    * @param bool   $condition  A condition that evaluates to true or false 
    206    * @param string $url        Url 
    207    * @param string $statusCode Status code (default to 302) 
     205   * @param bool   $condition  A condition that evaluates to true or false 
     206   * @param string $url        Url 
     207   * @param string $statusCode Status code (default to 302) 
    208208   * 
    209209   * @throws sfStopException 
     
    224224   * This method stops the action. So, no code is executed after a call to this method. 
    225225   * 
    226    * @param bool   $condition  A condition that evaluates to true or false 
    227    * @param string $url        Url 
    228    * @param string $statusCode Status code (default to 302) 
     226   * @param bool   $condition  A condition that evaluates to true or false 
     227   * @param string $url        Url 
     228   * @param string $statusCode Status code (default to 302) 
    229229   * 
    230230   * @throws sfStopException 
     
    267267   * available in the partial. 
    268268   * 
    269    * @param string $templateName partial name 
    270    * @param array  $vars         vars 
     269   * @param string $templateName partial name 
     270   * @param array  $vars         vars 
    271271   * 
    272272   * @return string The partial content 
     
    288288   * <code>return $this->renderPartial('foo/bar')</code> 
    289289   * 
    290    * @param string $templateName partial name 
    291    * @param array  $vars         vars 
     290   * @param string $templateName partial name 
     291   * @param array  $vars         vars 
    292292   * 
    293293   * @return sfView::NONE 
     
    309309   * available in the component. 
    310310   * 
    311    * @param string $moduleName    module name 
    312    * @param string  $componentName component name 
    313    * @param array   $vars          vars 
     311   * @param string $moduleName    module name 
     312   * @param string $componentName component name 
     313   * @param array  $vars          vars 
    314314   * 
    315315   * @return string  The component rendered content 
     
    331331   * <code>return $this->renderComponent('foo', 'bar')</code> 
    332332   * 
    333    * @param string $moduleName    module name 
    334    * @param string  $componentName component name 
    335    * @param array   $vars          vars 
     333   * @param string $moduleName    module name 
     334   * @param string $componentName component name 
     335   * @param array  $vars          vars 
    336336   * 
    337337   * @return sfView::NONE 
     
    461461   * See 'Naming Conventions' in the 'Symfony View' documentation. 
    462462   * 
    463    * @param string $name    Template name 
    464    * @param string $module The module (current if null) 
     463   * @param string $name   Template name 
     464   * @param string $module The module (current if null) 
    465465   */ 
    466466  public function setTemplate($name, $module = null) 
     
    544544   * Returns a formatted message for a 404 error. 
    545545   * 
    546    * @param string $message An error message (null by default) 
     546   * @param string $message An error message (null by default) 
    547547   * 
    548548   * @return string The error message or a default one if null 
  • branches/1.2/lib/action/sfActionStack.class.php

    r9044 r17858  
    2828   * Adds an entry to the action stack. 
    2929   * 
    30    * @param string   $moduleName      A module name 
    31    * @param string   $actionName      An action name 
    32    * @param sfAction $actionInstance An sfAction implementation instance 
     30   * @param string   $moduleName     A module name 
     31   * @param string   $actionName     An action name 
     32   * @param sfAction $actionInstance An sfAction implementation instance 
    3333   * 
    3434   * @return sfActionStackEntry sfActionStackEntry instance 
  • branches/1.2/lib/action/sfActionStackEntry.class.php

    r9044 r17858  
    3030   * Class constructor. 
    3131   * 
    32    * @param string   $moduleName      A module name 
    33    * @param string   $actionName      An action name 
    34    * @param sfAction $actionInstance An sfAction implementation instance 
     32   * @param string   $moduleName     A module name 
     33   * @param string   $actionName     An action name 
     34   * @param sfAction $actionInstance An sfAction implementation instance 
    3535   */ 
    3636  public function __construct($moduleName, $actionName, $actionInstance) 
  • branches/1.2/lib/action/sfActions.class.php

    r9044 r17858  
    2727   * defined action name. 
    2828   * 
    29    * @param sfRequest $request The current sfRequest object 
     29   * @param sfRequest $request The current sfRequest object 
    3030   * 
    3131   * @return string    A string containing the view name associated with this action 
  • branches/1.2/lib/action/sfComponent.class.php

    r11599 r17858  
    7171   * single product. 
    7272   * 
    73    * @param sfRequest $request The current sfRequest object 
     73   * @param sfRequest $request The current sfRequest object 
    7474   * 
    7575   * @return mixed     A string containing the view name associated with this action 
     
    157157   * <code>$this->getRequest()->getParameterHolder()->get($name)</code> 
    158158   * 
    159    * @param string $name     The parameter name 
    160    * @param mixed  $default The default value if parameter does not exist 
     159   * @param string $name    The parameter name 
     160   * @param mixed  $default The default value if parameter does not exist 
    161161   * 
    162162   * @return string The request parameter value 
     
    174174   * <code>$this->getRequest()->getParameterHolder()->has($name)</code> 
    175175   * 
    176    * @param string  $name The parameter name 
     176   * @param string $name The parameter name 
    177177   * @return boolean true if the request parameter exists, false otherwise 
    178178   */ 
     
    231231   * <code>$this->getContext()->getRouting()->generate(...)</code> 
    232232   * 
    233    * @param string  The route name 
    234    * @param array   An array of parameters for the route 
    235    * @param Boolean Whether to generate an absolute URL or not 
     233   * @param string  The route name 
     234   * @param array   An array of parameters for the route 
     235   * @param Boolean Whether to generate an absolute URL or not 
    236236   * 
    237237   * @return string  The URL 
     
    263263   * value is escaped properly. 
    264264   * 
    265    * @param string  $name  The variable name 
    266    * @param mixed   $value The variable value 
    267    * @param Boolean $safe  true if the value is safe for output (false by default) 
     265   * @param string  $name  The variable name 
     266   * @param mixed   $value The variable value 
     267   * @param Boolean $safe  true if the value is safe for output (false by default) 
    268268   */ 
    269269  public function setVar($name, $value, $safe = false) 
     
    275275   * Gets a variable set for the template. 
    276276   * 
    277    * @param  string $name  The variable name 
     277   * @param string $name The variable name 
     278   * 
    278279   * @return mixed  The variable value 
    279280   */ 
     
    300301   * <code>$this->setVar('name', 'value')</code> 
    301302   * 
    302    * @param string $key   The variable name 
    303    * @param string $value The variable value 
     303   * @param string $key   The variable name 
     304   * @param string $value The variable value 
    304305   * 
    305306   * @return boolean always true 
     
    319320   * <code>$this->getVar('name')</code> 
    320321   * 
    321    * @param string $key The variable name 
     322   * @param string $key The variable name 
    322323   * 
    323324   * @return mixed The variable value 
     
    337338   * <code>$this->getVarHolder()->has('name')</code> 
    338339   * 
    339    * @param string $name The variable name 
     340   * @param string $name The variable name 
    340341   * 
    341342   * @return boolean true if the variable is set 
     
    353354   * <code>$this->getVarHolder()->remove('name')</code> 
    354355   * 
    355    * @param string $name The variable Name 
     356   * @param string $name The variable Name 
    356357   */ 
    357358  public function __unset($name) 
  • branches/1.2/lib/addon/sfData.class.php

    r15803 r17858  
    8989   * The returned array of files is sorted by alphabetical order. 
    9090   * 
    91    * @param string|array $element A directory or file name or an array of directories and/or file names 
    92    *                              If null, then defaults to 'sf_data_dir'/fixtures 
     91   * @param string|array $element A directory or file name or an array of directories and/or file names 
     92   *                              If null, then defaults to 'sf_data_dir'/fixtures 
    9393   * 
    9494   * @return array A list of *.yml files 
  • branches/1.2/lib/autoload/sfAutoload.class.php

    r12676 r17858  
    123123   * Handles autoloading of classes that have been specified in autoload.yml. 
    124124   * 
    125    * @param string  $class A class name. 
     125   * @param string $class A class name. 
    126126   * 
    127127   * @return boolean Returns true if the class has been loaded 
     
    148148   * Tries to load a class that has been specified in autoload.yml. 
    149149   * 
    150    * @param string  $class A class name. 
     150   * @param string $class A class name. 
    151151   * 
    152152   * @return boolean Returns true if the class has been loaded 
  • branches/1.2/lib/autoload/sfCoreAutoload.class.php

    r17692 r17858  
    8989   * Handles autoloading of classes. 
    9090   * 
    91    * @param string  $class A class name. 
     91   * @param string $class A class name. 
    9292   * 
    9393   * @return boolean Returns true if the class has been loaded 
     
    110110   * @return base directory 
    111111   */ 
    112   public function getBaseDir() 
    113  
    114     return $this->baseDir; 
    115  
     112  public function getBaseDir() 
     113 
     114    return $this->baseDir; 
     115 
    116116 
    117117  /** 
  • branches/1.2/lib/autoload/sfSimpleAutoload.class.php

    r17749 r17858  
    4747   * Retrieves the singleton instance of this class. 
    4848   * 
    49    * @param string $cacheFile The file path to save the cache 
    50    * 
    51    * @return sfSimpleAutoload   A sfSimpleAutoload implementation instance. 
     49   * @param string $cacheFile The file path to save the cache 
     50   * 
     51   * @return sfSimpleAutoload A sfSimpleAutoload implementation instance. 
    5252   */ 
    5353  static public function getInstance($cacheFile = null) 
     
    6464   * Register sfSimpleAutoload in spl autoloader. 
    6565   * 
    66    * @return void 
     66   * @return void  
    6767   */ 
    6868  static public function register() 
     
    101101   * Handles autoloading of classes. 
    102102   * 
    103    * @param string $class A class name. 
     103   * @param string $class A class name. 
    104104   * 
    105105   * @return boolean Returns true if the class has been loaded 
     
    161161  public function reload() 
    162162  { 
    163     $this->classes = array(); 
     163    $this->classes     = array(); 
    164164    $this->cacheLoaded = false; 
    165165 
     
    174174    } 
    175175 
    176     $this->cacheLoaded = true; 
     176    $this->cacheLoaded = true; 
    177177    $this->cacheChanged = true; 
    178178  } 
     
    196196    $finder = sfFinder::type('file')->follow_link()->name('*'.$ext); 
    197197 
    198     if($dirs = glob($dir)) 
     198    if ($dirs = glob($dir)) 
    199199    { 
    200200      foreach ($dirs as $dir) 
  • branches/1.2/lib/cache/sfCache.class.php

    r9084 r17858  
    3939   * Initializes this sfCache instance. 
    4040   * 
    41    * @param array $options An array of options. 
     41   * @param array $options An array of options. 
    4242   * 
    4343   * Available options: 
     
    6767   * Gets the cache content for a given key. 
    6868   * 
    69    * @param string $key      The cache key 
    70    * @param mixed  $default The default value is the key does not exist or not valid anymore 
    71    * 
    72    * @return mixed The data of the cache 
     69   * @param string $key     The cache key 
     70   * @param mixed  $default The default value is the key does not exist or not valid anymore 
     71   * 
     72   * @return mixed The data of the cache 
    7373   */ 
    7474  abstract public function get($key, $default = null); 
     
    7777   * Returns true if there is a cache for the given key. 
    7878   * 
    79    * @param string  $key The cache key 
     79   * @param string $key The cache key 
    8080   * 
    8181   * @return Boolean true if the cache exists, false otherwise 
     
    8686   * Saves some data in the cache. 
    8787   * 
    88    * @param string $key      The cache key 
    89    * @param mixed  $data      The data to put in cache 
    90    * @param int    $lifetime The lifetime 
     88   * @param string $key      The cache key 
     89   * @param mixed  $data     The data to put in cache 
     90   * @param int    $lifetime The lifetime 
    9191   * 
    9292   * @return Boolean true if no problem 
     
    106106   * Removes content from the cache that matches the given pattern. 
    107107   * 
    108    * @param string $pattern The cache key pattern 
     108   * @param string $pattern The cache key pattern 
    109109   * 
    110110   * @return Boolean true if no problem 
     
    117117   * Cleans the cache. 
    118118   * 
    119    * @param string  $mode The clean mode 
    120    *                        sfCache::ALL: remove all keys (default) 
    121    *                        sfCache::OLD: remove all expired keys 
     119   * @param string $mode The clean mode 
     120   *                     sfCache::ALL: remove all keys (default) 
     121   *                     sfCache::OLD: remove all expired keys 
    122122   * 
    123123   * @return Boolean true if no problem 
     
    146146   * Gets many keys at once. 
    147147   * 
    148    * @param array $keys An array of keys 
     148   * @param array $keys An array of keys 
    149149   * 
    150150   * @return array An associative array of data from cache 
     
    164164   * Computes lifetime. 
    165165   * 
    166    * @param integer $lifetime Lifetime in seconds 
     166   * @param integer $lifetime Lifetime in seconds 
    167167   * 
    168168   * @return integer Lifetime in seconds 
     
    186186   * Gets an option value. 
    187187   * 
    188    * @param string $name     The option name 
    189    * @param mixed  $default The default value 
    190    * 
    191    * @return mixed The option value 
     188   * @param string $name    The option name 
     189   * @param mixed  $default The default value 
     190   * 
     191   * @return mixed The option value 
    192192   */ 
    193193  public function getOption($name, $default = null) 
     
    215215   *  - ** Matches one or more namespaces (foo:**:bar) 
    216216   * 
    217    * @param string $pattern A pattern 
     217   * @param string $pattern A pattern 
    218218   * 
    219219   * @return string A regular expression 
  • branches/1.2/lib/cache/sfFileCache.class.php

    r16899 r17858  
    6161    $data = $this->read($file_path, self::READ_DATA); 
    6262 
    63     if ($data[self::READ_DATA] === null) { 
     63    if ($data[self::READ_DATA] === null) 
     64    { 
    6465      return $default; 
    6566    } 
     
    204205  * Converts a cache key to a full path. 
    205206  * 
    206   * @param string $key The cache key 
     207  * @param string $key The cache key 
    207208  * 
    208209  * @return string The full path to the cache file 
     
    235236    @flock($fp, LOCK_SH); 
    236237    $data[self::READ_TIMEOUT] = intval(@stream_get_contents($fp, 12, 0)); 
    237     if ($type != self::READ_TIMEOUT && time() < $data[self::READ_TIMEOUT]) { 
     238    if ($type != self::READ_TIMEOUT && time() < $data[self::READ_TIMEOUT]) 
     239    { 
    238240      if ($type & self::READ_LAST_MODIFIED) 
    239241      { 
     
    247249        $data[self::READ_DATA] = @fread($fp, $length); 
    248250      } 
    249     } else { 
     251    } 
     252    else 
     253    { 
    250254      $data[self::READ_LAST_MODIFIED] = null; 
    251255      $data[self::READ_DATA] = null; 
     
    260264  * Writes the given data in the cache file. 
    261265  * 
    262   * @param string  $path     The file path 
    263   * @param string  $data     The data to put in cache 
    264   * @param integer $timeout The timeout timestamp 
     266  * @param string  $path    The file path 
     267  * @param string  $data    The data to put in cache 
     268  * @param integer $timeout The timeout timestamp 
    265269  * 
    266270  * @return boolean true if ok, otherwise false 
  • branches/1.2/lib/cache/sfFunctionCache.class.php

    r9084 r17858  
    4848   * $cache->call(array($object, 'methodName'), array($arg1, $arg2)); 
    4949   * 
    50    * @param mixed $callable  A PHP callable 
    51    * @param array $arguments An array of arguments to pass to the callable 
     50   * @param mixed $callable  A PHP callable 
     51   * @param array $arguments An array of arguments to pass to the callable 
    5252   * 
    5353   * @return mixed The result of the function/method 
  • branches/1.2/lib/cache/sfMemcacheCache.class.php

    r17749 r17858  
    208208   * Gets metadata about a key in the cache. 
    209209   * 
    210    * @param string $key A cache key 
    211    * 
    212    * @return array An array of metadata information 
     210   * @param string $key A cache key 
     211   * 
     212   * @return array An array of metadata information 
    213213   */ 
    214214  protected function getMetadata($key) 
     
    220220   * Stores metadata about a key in the cache. 
    221221   * 
    222    * @param string $key      A cache key 
    223    * @param string $lifetime The lifetime 
     222   * @param string $key      A cache key 
     223   * @param string $lifetime The lifetime 
    224224   */ 
    225225  protected function setMetadata($key, $lifetime) 
  • branches/1.2/lib/cache/sfXCacheCache.class.php

    r17478 r17858  
    5151    $set = $this->getBaseValue($key); 
    5252     
    53     if(!is_array($set) || !array_key_exists('data', $set)) 
     53    if (!is_array($set) || !array_key_exists('data', $set)) 
    5454    { 
    5555       
     
    122122    $set = $this->getBaseValue($key); 
    123123     
    124     if(!is_array($set) || !array_key_exists('ctime', $set)) 
     124    if (!is_array($set) || !array_key_exists('ctime', $set)) 
    125125    { 
    126126       
     
    139139    $set = $this->getBaseValue($key); 
    140140     
    141     if(!is_array($set) || !array_key_exists('timeout', $set)) 
     141    if (!is_array($set) || !array_key_exists('timeout', $set)) 
    142142    { 
    143143       
  • branches/1.2/lib/command/sfAnsiColorFormatter.class.php

    r11301 r17858  
    4444   * Formats a text according to the given style or parameters. 
    4545   * 
    46    * @param string   $text       The test to style 
    47    * @param mixed    $parameters An array of options or a style name 
    48    * @param resource $stream     The stream to format for 
     46   * @param string   $text       The test to style 
     47   * @param mixed    $parameters An array of options or a style name 
     48   * @param resource $stream     The stream to format for 
    4949   * 
    5050   * @return string The styled text 
     
    9090   * Formats a message within a section. 
    9191   * 
    92    * @param string $section The section name 
     92   * @param string $section The section name 
    9393   * @param string  $text     The text message 
    9494   * @param integer $size     The maximum size allowed for a line (65 by default) 
     
    137137   *  -  non tty consoles 
    138138   * 
    139    * @param mixed  $stream A stream 
     139   * @param mixed $stream A stream 
    140140   * 
    141141   * @return Boolean true if the stream supports colorization, false otherwise 
  • branches/1.2/lib/command/sfCommandApplication.class.php

    r11505 r17858  
    3636   * Constructor. 
    3737   * 
    38    * @param sfEventDispatcher $dispatcher   A sfEventDispatcher instance 
    39    * @param sfFormatter       $formatter    A sfFormatter instance 
    40    * @param array             $options      An array of options 
     38   * @param sfEventDispatcher $dispatcher A sfEventDispatcher instance 
     39   * @param sfFormatter       $formatter  A sfFormatter instance 
     40   * @param array             $options    An array of options 
    4141   */ 
    4242  public function __construct(sfEventDispatcher $dispatcher, sfFormatter $formatter, $options = array()) 
     
    6161   * Returns the value of a given option. 
    6262   * 
    63    * @param string  $name The option name 
    64    * 
    65    * @return mixed The option value 
     63   * @param string $name The option name 
     64   * 
     65   * @return mixed The option value 
    6666   */ 
    6767  public function getOption($name) 
     
    8585   * If you pass null, this method will register all available tasks. 
    8686   * 
    87    * @param array $tasks An array of tasks 
     87   * @param array $tasks An array of tasks 
    8888   */ 
    8989  public function registerTasks($tasks = null) 
     
    405405   * Gets a task from a task name or a shortcut. 
    406406   * 
    407    * @param string  $name The task name or a task shortcut 
     407   * @param string $name The task name or a task shortcut 
    408408   * 
    409409   * @return sfTask A sfTask object 
  • branches/1.2/lib/command/sfCommandArgument.class.php

    r9076 r17858  
    3333   * Constructor. 
    3434   * 
    35    * @param string  $name    The argument name 
    36    * @param integer $mode    The argument mode: self::REQUIRED or self::OPTIONAL 
    37    * @param string  $help    A help text 
    38    * @param mixed   $default The default value (for self::OPTIONAL mode only) 
     35   * @param string  $name    The argument name 
     36   * @param integer $mode    The argument mode: self::REQUIRED or self::OPTIONAL 
     37   * @param string  $help    A help text 
     38   * @param mixed   $default The default value (for self::OPTIONAL mode only) 
    3939   */ 
    4040  public function __construct($name, $mode = null, $help = '', $default = null) 
  • branches/1.2/lib/command/sfCommandArgumentSet.class.php

    r9076 r17858  
    106106   * Returns an argument by name. 
    107107   * 
    108    * @param string $name The argument name 
     108   * @param string $name The argument name 
    109109   * 
    110110   * @return sfCommandArgument A sfCommandArgument object 
     
    123123   * Returns true if an argument object exists by name. 
    124124   * 
    125    * @param string  $name The argument name 
     125   * @param string $name The argument name 
    126126   * 
    127127   * @return Boolean true if the argument object exists, false otherwise 
  • branches/1.2/lib/command/sfCommandLogger.class.php

    r15485 r17858  
    2121   * Initializes this logger. 
    2222   * 
    23    * @param sfEventDispatcher $dispatcher A sfEventDispatcher instance 
    24    * @param array             $options     An array of options. 
     23   * @param sfEventDispatcher $dispatcher A sfEventDispatcher instance 
     24   * @param array             $options    An array of options. 
    2525   */ 
    2626  public function initialize(sfEventDispatcher $dispatcher, $options = array()) 
  • branches/1.2/lib/command/sfCommandManager.class.php

    r16343 r17858  
    206206   * Returns the argument value for a given argument name. 
    207207   * 
    208    * @param string $name The argument name 
     208   * @param string $name The argument name 
    209209   * 
    210210   * @return mixed The argument value 
     
    233233   * Returns the option value for a given option name. 
    234234   * 
    235    * @param string $name The option name 
     235   * @param string $name The option name 
    236236   * 
    237237   * @return mixed The option value 
  • branches/1.2/lib/command/sfCommandOption.class.php

    r9076 r17858  
    3535   * Constructor. 
    3636   * 
    37    * @param string  $name       The option name 
    38    * @param string  $shortcut   The shortcut (can be null) 
    39    * @param integer $mode       The option mode: self::PARAMETER_REQUIRED, self::PARAMETER_NONE or self::PARAMETER_OPTIONAL 
    40    * @param string  $help       A help text 
    41    * @param mixed   $default    The default value (must be null for self::PARAMETER_REQUIRED or self::PARAMETER_NONE) 
     37   * @param string  $name     The option name 
     38   * @param string  $shortcut The shortcut (can be null) 
     39   * @param integer $mode     The option mode: self::PARAMETER_REQUIRED, self::PARAMETER_NONE or self::PARAMETER_OPTIONAL 
     40   * @param string  $help     A help text 
     41   * @param mixed   $default  The default value (must be null for self::PARAMETER_REQUIRED or self::PARAMETER_NONE) 
    4242   */ 
    4343  public function __construct($name, $shortcut = null, $mode = null, $help = '', $default = null) 
  • branches/1.2/lib/command/sfCommandOptionSet.class.php

    r9076 r17858  
    8484   * Returns an option by name. 
    8585   * 
    86    * @param string $name The option name 
     86   * @param string $name The option name 
    8787   * 
    8888   * @return sfCommandOption A sfCommandOption object 
     
    101101   * Returns true if an option object exists by name. 
    102102   * 
    103    * @param string  $name The option name 
     103   * @param string $name The option name 
    104104   * 
    105105   * @return Boolean true if the option object exists, false otherwise 
     
    123123   * Returns true if an option object exists by shortcut. 
    124124   * 
    125    * @param string  $name The option shortcut 
     125   * @param string $name The option shortcut 
    126126   * 
    127127   * @return Boolean true if the option object exists, false otherwise 
     
    161161   * Returns the option name given a shortcut. 
    162162   * 
    163    * @param string $shortcut The shortcut 
     163   * @param string $shortcut The shortcut 
    164164   * 
    165165   * @return string The option name 
  • branches/1.2/lib/command/sfFormatter.class.php

    r14274 r17858  
    3030   * Formats a text according to the given parameters. 
    3131   * 
    32    * @param string $text         The test to style 
    33    * @param mixed  $parameters  An array of parameters 
    34    * @param stream $stream       A stream (default to STDOUT) 
     32   * @param string $text       The test to style 
     33   * @param mixed  $parameters An array of parameters 
     34   * @param stream $stream     A stream (default to STDOUT) 
    3535   * 
    3636   * @return string The formatted text 
     
    4444   * Formats a message within a section. 
    4545   * 
    46    * @param string  $section The section name 
    47    * @param string  $text    The text message 
    48    * @param integer $size    The maximum size allowed for a line (65 by default) 
     46   * @param string  $section The section name 
     47   * @param string  $text    The text message 
     48   * @param integer $size    The maximum size allowed for a line (65 by default) 
    4949   */ 
    5050  public function formatSection($section, $text, $size = null) 
  • branches/1.2/lib/config/sfApplicationConfiguration.class.php

    r13947 r17858  
    3333   * Constructor. 
    3434   * 
    35    * @param string            $environment    The environment name 
    36    * @param Boolean           $debug          true to enable debug mode 
    37    * @param string            $rootDir        The project root directory 
    38    * @param sfEventDispatcher $dispatcher     An event dispatcher 
     35   * @param string            $environment The environment name 
     36   * @param Boolean           $debug       true to enable debug mode 
     37   * @param string            $rootDir     The project root directory 
     38   * @param sfEventDispatcher $dispatcher  An event dispatcher 
    3939   */ 
    4040  public function __construct($environment, $debug, $rootDir = null, sfEventDispatcher $dispatcher = null) 
     
    182182   * Adds enabled plugins to autoload config. 
    183183   *  
    184    * @param   sfEvent $event 
    185    * @param   array   $config 
     184   * @param sfEvent $event 
     185   * @param array   $config 
    186186   *  
    187    * @return array 
     187   * @return array 
    188188   */ 
    189189  public function filterAutoloadConfig(sfEvent $event, array $config) 
     
    397397   * Gets the helper directories for a given module name. 
    398398   * 
    399    * @param string $moduleName The module name 
    400    * 
    401    * @return array An array of directories 
     399   * @param string $moduleName The module name 
     400   * 
     401   * @return array An array of directories 
    402402   */ 
    403403  public function getHelperDirs($moduleName = '') 
     
    426426   * Gets the template directory to use for a given module and template file. 
    427427   * 
    428    * @param string $moduleName    The module name 
    429    * @param string $templateFile The template file 
     428   * @param string $moduleName   The module name 
     429   * @param string $templateFile The template file 
    430430   * 
    431431   * @return string A template directory 
     
    447447   * Gets the template to use for a given module and template file. 
    448448   * 
    449    * @param string $moduleName    The module name 
    450    * @param string $templateFile The template file 
     449   * @param string $moduleName   The module name 
     450   * @param string $templateFile The template file 
    451451   * 
    452452   * @return string A template path 
     
    462462   * Gets the decorator directories. 
    463463   * 
    464    * @return array An array of the decorator directories 
     464   * @return array An array of the decorator directories 
    465465   */ 
    466466  public function getDecoratorDirs() 
     
    472472   * Gets the decorator directory for a given template. 
    473473   * 
    474    * @param string $template The template file 
     474   * @param string $template The template file 
    475475   * 
    476476   * @return string A template directory 
     
    591591   * Loads helpers. 
    592592   * 
    593    * @param array  $helpers    An array of helpers to load 
    594    * @param string $moduleName A module name (optional) 
     593   * @param array  $helpers    An array of helpers to load 
     594   * @param string $moduleName A module name (optional) 
    595595   */ 
    596596  public function loadHelpers($helpers, $moduleName = '') 
  • branches/1.2/lib/config/sfCacheConfigHandler.class.php

    r9085 r17858  
    6868   * Returns a single addCache statement. 
    6969   * 
    70    * @param string $actionName The action name 
     70   * @param string $actionName The action name 
    7171   * 
    7272   * @return string PHP code for the addCache statement 
  • branches/1.2/lib/config/sfCompileConfigHandler.class.php

    r13547 r17858  
    6767 
    6868      // replace windows and mac format with unix format 
    69       $contents = str_replace("\r", "\n", $contents); 
     69      $contents = str_replace("\r", "\n", $contents); 
    7070 
    7171      // replace multiple new lines with a single newline 
  • branches/1.2/lib/config/sfConfigCache.class.php

    r16899 r17858  
    4141   * Loads a configuration handler. 
    4242   * 
    43    * @param string $handler   The handler to use when parsing a configuration file 
    44    * @param array  $configs   An array of absolute filesystem paths to configuration files 
    45    * @param string $cache     An absolute filesystem path to the cache file that will be written 
     43   * @param string $handler The handler to use when parsing a configuration file 
     44   * @param array  $configs An array of absolute filesystem paths to configuration files 
     45   * @param string $cache   An absolute filesystem path to the cache file that will be written 
    4646   * 
    4747   * @throws <b>sfConfigurationException</b> If a requested configuration file does not have an associated configuration handler 
     
    111111   * Returns the config handler configured for the given name 
    112112   * 
    113    * @param string $name The config handler name 
     113   * @param string $name The config handler name 
    114114   * 
    115115   * @return sfConfigHandler A sfConfigHandler instance 
     
    135135   * defined in the sfConfiguration::getConfigPaths() method. 
    136136   * 
    137    * @param string  $configPath A filesystem path to a configuration file 
    138    * @param boolean $optional    If true, config path does not need to exist 
     137   * @param string  $configPath A filesystem path to a configuration file 
     138   * @param boolean $optional   If true, config path does not need to exist 
    139139   * 
    140140   * @return string An absolute filesystem path to the cache filename associated with this specified configuration file 
     
    236236   * Imports a configuration file. 
    237237   * 
    238    * @param string $config    A filesystem path to a configuration file 
    239    * @param bool   $once      Only allow this configuration file to be included once per request? 
    240    * @param bool   $optional Only include if true 
     238   * @param string $config   A filesystem path to a configuration file 
     239   * @param bool   $once     Only allow this configuration file to be included once per request? 
     240   * @param bool   $optional Only include if true 
    241241   * 
    242242   * @see checkConfig() 
     
    322322   * Writes a cache file. 
    323323   * 
    324    * @param string $config An absolute filesystem path to a configuration file 
    325    * @param string $cache  An absolute filesystem path to the cache file that will be written 
    326    * @param string $data    Data to be written to the cache file 
     324   * @param string $config An absolute filesystem path to a configuration file 
     325   * @param string $cache  An absolute filesystem path to the cache file that will be written 
     326   * @param string $data   Data to be written to the cache file 
    327327   * 
    328328   * @throws sfCacheException If the cache file cannot be written 
     
    367367   * Registers a configuration handler. 
    368368   * 
    369    * @param string $handler   The handler to use when parsing a configuration file 
    370    * @param class  $class     A configuration handler class 
    371    * @param string $params    An array of options for the handler class initialization 
     369   * @param string $handler The handler to use when parsing a configuration file 
     370   * @param class  $class   A configuration handler class 
     371   * @param string $params  An array of options for the handler class initialization 
    372372   */ 
    373373  public function registerConfigHandler($handler, $class, $params = array()) 
  • branches/1.2/lib/config/sfDefineEnvironmentConfigHandler.class.php

    r9085 r17858  
    2121   * Executes this configuration handler. 
    2222   * 
    23    * @param string $configFiles An absolute filesystem path to a configuration file 
     23   * @param string $configFiles An absolute filesystem path to a configuration file 
    2424   * 
    2525   * @return string Data to be written to a cache file 
     
    7070   * Gets values from the configuration array. 
    7171   * 
    72    * @param string $prefix    The prefix name 
    73    * @param string $category The category name 
     72   * @param string $prefix   The prefix name 
     73   * @param string $category The category name 
    7474   * @param mixed  $keys      The key/value array 
    7575   * 
     
    102102   * Fixes the category name and replaces constants in the value. 
    103103   * 
    104    * @param string $category The category name 
    105    * @param string $key      The key name 
    106    * @param string $value    The value 
     104   * @param string $category The category name 
     105   * @param string $key      The key name 
     106   * @param string $value    The value 
    107107   * 
    108108   * @return string Return the new key and value 
     
    116116   * Fixes the category name. 
    117117   * 
    118    * @param string $category The category name 
    119    * @param string $prefix    The prefix 
     118   * @param string $category The category name 
     119   * @param string $prefix   The prefix 
    120120   * 
    121121   * @return string The fixed category name 
  • branches/1.2/lib/config/sfFilterConfigHandler.class.php

    r17749 r17858  
    130130   * Adds a filter statement to the data. 
    131131   * 
    132    * @param string $category    The category name 
    133    * @param string $class      The filter class name 
    134    * @param array  $parameters Filter default parameters 
     132   * @param string $category   The category name 
     133   * @param string $class      The filter class name 
     134   * @param array  $parameters Filter default parameters 
    135135   * 
    136136   * @return string The PHP statement 
  • branches/1.2/lib/config/sfLoader.class.php

    r11783 r17858  
    4040   * Loads helpers. 
    4141   * 
    42    * @param array  $helpers    An array of helpers to load 
    43    * @param string $moduleName A module name (optional) 
     42   * @param array  $helpers    An array of helpers to load 
     43   * @param string $moduleName A module name (optional) 
    4444   * 
    4545   * @throws sfViewException 
  • branches/1.2/lib/config/sfPluginConfiguration.class.php

    r17749 r17858  
    2828   * Constructor. 
    2929   *  
    30    * @param sfProjectConfiguration $configuration 
    31    * @param string                  $rootDir        The plugin root directory 
    32    * @param string                  $name           The plugin name 
     30   * @param sfProjectConfiguration $configuration The project configuration 
     31   * @param string                 $rootDir       The plugin root directory 
     32   * @param string                 $name          The plugin name 
    3333   */ 
    3434  public function __construct(sfProjectConfiguration $configuration, $rootDir = null, $name = null) 
     
    137137   * @param array   $config  
    138138   *  
    139    * @return array 
     139   * @return array 
    140140   */ 
    141141  public function filterAutoloadConfig(sfEvent $event, array $config) 
  • branches/1.2/lib/config/sfProjectConfiguration.class.php

    r17749 r17858  
    3434   * Constructor. 
    3535   * 
    36    * @param string              $rootDir    The project root directory 
    37    * @param sfEventDispatcher   $dispatcher The event dispatcher 
     36   * @param string            $rootDir    The project root directory 
     37   * @param sfEventDispatcher $dispatcher The event dispatcher 
    3838   */ 
    3939  public function __construct($rootDir = null, sfEventDispatcher $dispatcher = null) 
     
    184184   * Gets directories where template files are stored for a generator class and a specific theme. 
    185185   * 
    186    * @param string $class The generator class name 
    187    * @param string $theme The theme name 
     186   * @param string $class The generator class name 
     187   * @param string $theme The theme name 
    188188   * 
    189189   * @return array An array of directories 
     
    202202   * Gets directories where the skeleton is stored for a generator class and a specific theme. 
    203203   * 
    204    * @param string $class   The generator class name 
    205    * @param string $theme   The theme name 
     204   * @param string $class The generator class name 
     205   * @param string $theme The theme name 
    206206   * 
    207207   * @return array An array of directories 
     
    220220   * Gets the template to use for a generator class. 
    221221   * 
    222    * @param string $class   The generator class name 
    223    * @param string $theme   The theme name 
    224    * @param string $path    The template path 
     222   * @param string $class The generator class name 
     223   * @param string $theme The theme name 
     224   * @param string $path  The template path 
    225225   * 
    226226   * @return string A template path 
     
    389389   * Gets the paths plugin sub-directories, minding overloaded plugins. 
    390390   * 
    391    * @param string $subPath The subdirectory to look for 
     391   * @param string $subPath The subdirectory to look for 
    392392   * 
    393393   * @return array The plugin paths. 
     
    489489   * Returns the configuration for the requested plugin. 
    490490   *  
    491    * @param   string $name 
    492    *  
    493    * @return sfPluginConfiguration 
     491   * @param string $name 
     492   *  
     493   * @return sfPluginConfiguration 
    494494   */ 
    495495  public function getPluginConfiguration($name) 
     
    548548   * Returns a sfApplicationConfiguration configuration for a given application. 
    549549   * 
    550    * @param string            $application    An application name 
    551    * @param string            $environment    The environment name 
    552    * @param Boolean           $debug          true to enable debug mode 
    553    * @param string            $rootDir        The project root directory 
    554    * @param sfEventDispatcher $dispatcher     An event dispatcher 
     550   * @param string            $application An application name 
     551   * @param string            $environment The environment name 
     552   * @param Boolean           $debug       true to enable debug mode 
     553   * @param string            $rootDir     The project root directory 
     554   * @param sfEventDispatcher $dispatcher  An event dispatcher 
    555555   * 
    556556   * @return sfApplicationConfiguration A sfApplicationConfiguration instance 
  • branches/1.2/lib/config/sfViewConfigHandler.class.php

    r17714 r17858  
    155155   * Adds a layout statement statement to the data. 
    156156   * 
    157    * @param string $viewName The view name 
     157   * @param string $viewName The view name 
    158158   * 
    159159   * @return string The PHP statement 
     
    209209   * Adds http metas and metas statements to the data. 
    210210   * 
    211    * @param string $viewName The view name 
     211   * @param string $viewName The view name 
    212212   * 
    213213   * @return string The PHP statement 
  • branches/1.2/lib/config/sfYamlConfigHandler.class.php

    r9085 r17858  
    2626   * Parses an array of YAMLs files and merges them in one configuration array. 
    2727   * 
    28    * @param array $configFiles An array of configuration file paths 
     28   * @param array $configFiles An array of configuration file paths 
    2929   * 
    3030   * @return array A merged configuration array 
     
    7474   * Merges configuration values for a given key and category. 
    7575   * 
    76    * @param string $keyName  The key name 
    77    * @param string $category The category name 
     76   * @param string $keyName  The key name 
     77   * @param string $category The category name 
    7878   * 
    7979   * @return string The value associated with this key name and category 
     
    9999   * Gets a configuration value for a given key and category. 
    100100   * 
    101    * @param string $keyName      The key name 
    102    * @param string $category      The category name 
    103    * @param string $defaultValue The default value 
     101   * @param string $keyName      The key name 
     102   * @param string $category     The category name 
     103   * @param string $defaultValue The default value 
    104104   * 
    105105   * @return string The value associated with this key name and category 
  • branches/1.2/lib/controller/sfConsoleController.class.php

    r9078 r17858  
    2020   * Dispatches a request. 
    2121   * 
    22    * @param string $moduleName A module name 
    23    * @param string $actionName An action name 
    24    * @param array  $parameters An associative array of parameters to be set 
     22   * @param string $moduleName A module name 
     23   * @param string $actionName An action name 
     24   * @param array  $parameters An associative array of parameters to be set 
    2525   */ 
    2626  public function dispatch($moduleName, $actionName, $parameters = array()) 
  • branches/1.2/lib/controller/sfController.class.php

    r17749 r17858  
    6868   * Indicates whether or not a module has a specific action. 
    6969   * 
    70    * @param string $moduleName A module name 
    71    * @param string $actionName An action name 
     70   * @param string $moduleName A module name 
     71   * @param string $actionName An action name 
    7272   * 
    7373   * @return bool true, if the action exists, otherwise false 
     
    8282   * in the case of {@link getController()}). 
    8383   * 
    84    * @param string  $moduleName      The name of the module 
    85    * @param string  $controllerName  The name of the controller within the module 
    86    * @param string  $extension        Either 'action' or 'component' depending on the type of controller to look for 
    87    * @param boolean $throwExceptions Whether to throw exceptions if the controller doesn't exist 
     84   * @param string  $moduleName      The name of the module 
     85   * @param string  $controllerName  The name of the controller within the module 
     86   * @param string  $extension       Either 'action' or 'component' depending on the type of controller to look for 
     87   * @param boolean $throwExceptions Whether to throw exceptions if the controller doesn't exist 
    8888   * 
    8989   * @throws sfConfigurationException thrown if the module is not enabled 
     
    169169   * Forwards the request to another action. 
    170170   * 
    171    * @param string $moduleName A module name 
    172    * @param string $actionName An action name 
     171   * @param string $moduleName A module name 
     172   * @param string $actionName An action name 
    173173   * 
    174174   * @throws <b>sfConfigurationException</b> If an invalid configuration setting has been found 
     
    263263   * Retrieves an sfAction implementation instance. 
    264264   * 
    265    * @param string  $moduleName A module name 
    266    * @param string  $actionName An action name 
     265   * @param string $moduleName A module name 
     266   * @param string $actionName An action name 
    267267   * 
    268268   * @return sfAction An sfAction implementation instance, if the action exists, otherwise null 
     
    276276   * Retrieves a sfComponent implementation instance. 
    277277   * 
    278    * @param string $moduleName    A module name 
    279    * @param string $componentName A component name 
     278   * @param string $moduleName    A module name 
     279   * @param string $componentName A component name 
    280280   * 
    281281   * @return sfComponent A sfComponent implementation instance, if the component exists, otherwise null 
     
    289289   * Retrieves a controller implementation instance. 
    290290   * 
    291    * @param string $moduleName     A module name 
    292    * @param string $controllerName A component name 
    293    * @param string $extension      Either 'action' or 'component' depending on the type of controller to look for 
     291   * @param string $moduleName     A module name 
     292   * @param string $controllerName A component name 
     293   * @param string $extension      Either 'action' or 'component' depending on the type of controller to look for 
    294294   * 
    295295   * @return object A controller implementation instance, if the controller exists, otherwise null 
     
    343343   * Retrieves a sfView implementation instance. 
    344344   * 
    345    * @param string $moduleName A module name 
    346    * @param string $actionName An action name 
    347    * @param string $viewName    A view name 
     345   * @param string $moduleName A module name 
     346   * @param string $actionName An action name 
     347   * @param string $viewName   A view name 
    348348   * 
    349349   * @return sfView A sfView implementation instance, if the view exists, otherwise null 
     
    382382   * This methods calls a module/action with the sfMailView class. 
    383383   * 
    384    * @param string  $module A module name 
    385    * @param string  $action An action name 
     384   * @param string $module A module name 
     385   * @param string $action An action name 
    386386   * 
    387387   * @return string The generated mail content 
     
    403403   * Returns the rendered view presentation of a given module/action. 
    404404   * 
    405    * @param string  $module    A module name 
    406    * @param string  $action    An action name 
    407    * @param string  $viewName A View class name 
     405   * @param string $module   A module name 
     406   * @param string $action   An action name 
     407   * @param string $viewName A View class name 
    408408   * 
    409409   * @return string The generated content 
  • branches/1.2/lib/controller/sfWebController.class.php

    r16711 r17858  
    168168   * Redirects the request to another URL. 
    169169   * 
    170    * @param string $url        An existing URL 
    171    * @param int    $delay      A delay in seconds before redirecting. This is only needed on 
    172    *                            browsers that do not support HTTP headers 
    173    * @param int    $statusCode The status code 
     170   * @param string $url        An existing URL 
     171   * @param int    $delay      A delay in seconds before redirecting. This is only needed on 
     172   *                           browsers that do not support HTTP headers 
     173   * @param int    $statusCode The status code 
    174174   */ 
    175175  public function redirect($url, $delay = 0, $statusCode = 302) 
  • branches/1.2/lib/database/sfDatabaseManager.class.php

    r17749 r17858  
    4545   * Initializes this sfDatabaseManager object 
    4646   * 
    47    * @param sfProjectConfiguration $configuration A sfProjectConfiguration instance 
     47   * @param sfProjectConfiguration $configuration A sfProjectConfiguration instance 
    4848   * 
    4949   * @return bool true, if initialization completes successfully, otherwise false 
     
    8282   * Sets a database connection. 
    8383   * 
    84    * @param string     $name        The database name 
    85    * @param sfDatabase $database A sfDatabase instance 
     84   * @param string     $name     The database name 
     85   * @param sfDatabase $database A sfDatabase instance 
    8686   */ 
    8787  public function setDatabase($name, sfDatabase $database) 
     
    9393   * Retrieves the database connection associated with this sfDatabase implementation. 
    9494   * 
    95    * @param string $name A database name 
     95   * @param string $name A database name 
    9696   * 
    9797   * @return mixed A Database instance 
  • branches/1.2/lib/database/sfMySQLDatabase.class.php

    r12763 r17858  
    114114 
    115115    // set encoding if specified 
    116     if($encoding) 
     116    if ($encoding) 
    117117    { 
    118118      @mysql_query("SET NAMES '".$encoding."'", $this->connection); 
     
    127127   * Returns the appropriate connect method. 
    128128   *  
    129    * @param bool $persistent wether persistent connections are use or not 
     129   * @param bool $persistent wether persistent connections are use or not 
    130130   * @return string name of connect method. 
    131131   */ 
     
    138138   * Selects the database to be used in this connection 
    139139   *  
    140    * @param string $database Name of database to be connected 
     140   * @param string $database Name of database to be connected 
    141141   * 
    142142   * @return bool true if this was successful 
  • branches/1.2/lib/database/sfMySQLiDatabase.class.php

    r14869 r17858  
    2020   * Returns the appropriate connect method. 
    2121   * 
    22    * @param bool $persistent Whether persistent connections are use or not 
    23    *                          The MySQLi driver does not support persistent 
    24    *                          connections so this argument is ignored. 
     22   * @param bool $persistent Whether persistent connections are use or not 
     23   *                         The MySQLi driver does not support persistent 
     24   *                         connections so this argument is ignored. 
    2525   * 
    2626   * @return string name of connect method 
     
    3434   * Selects the database to be used in this connection 
    3535   * 
    36    * @param string $database Name of database to be connected 
     36   * @param string $database Name of database to be connected 
    3737   * 
    3838   * @return bool true if this was successful 
  • branches/1.2/lib/database/sfPDODatabase.class.php

    r9372 r17858  
    6767 
    6868    // lets generate exceptions instead of silent failures 
    69     if(sfConfig::get('sf_debug')) 
     69    if (sfConfig::get('sf_debug')) 
    7070    { 
    7171      $this->connection->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); 
     
    7878    // compatability 
    7979    $compatability = $this->getParameter('compat'); 
    80     if($compatability) 
     80    if ($compatability) 
    8181    { 
    8282      $this->connection->setAttribute(PDO::ATTR_CASE, PDO::CASE_NATURAL); 
     
    8585    // nulls 
    8686    $nulls = $this->getParameter('nulls'); 
    87     if($nulls) 
     87    if ($nulls) 
    8888    { 
    8989      $this->connection->setAttribute(PDO::ATTR_ORACLE_NULLS, PDO::NULL_EMPTY_STRING); 
     
    9292    // auto commit 
    9393    $autocommit = $this->getParameter('autocommit'); 
    94     if($autocommit) 
     94    if ($autocommit) 
    9595    { 
    9696      $this->connection->setAttribute(PDO::ATTR_AUTOCOMMIT, true); 
  • branches/1.2/lib/debug/sfDebug.class.php

    r13931 r17858  
    4848    if ($values['extensions']) 
    4949    { 
    50       foreach($values['extensions'] as $key => $extension) 
     50      foreach ($values['extensions'] as $key => $extension) 
    5151      { 
    5252        $values['extensions'][$key] = phpversion($extension) ? sprintf('%s (%s)', $extension, phpversion($extension)) : $extension; 
  • branches/1.2/lib/debug/sfWebDebug.class.php

    r16169 r17858  
    118118   * Removes a panel by name. 
    119119   * 
    120    * @param string          $name The panel name 
     120   * @param string $name The panel name 
    121121   */ 
    122122  public function removePanel($name) 
     
    128128   * Gets an option value by name. 
    129129   * 
    130    * @param string $name The option name 
    131    * 
    132    * @return mixed The option value 
     130   * @param string $name The option name 
     131   * 
     132   * @return mixed The option value 
    133133   */ 
    134134  public function getOption($name, $default = null) 
     
    140140   * Injects the web debug toolbar into a given HTML string. 
    141141   * 
    142    * @param string $content The HTML content 
     142   * @param string $content The HTML content 
    143143   * 
    144144   * @return string The content with the web debug toolbar injected 
  • branches/1.2/lib/debug/sfWebDebugPanelConfig.class.php

    r13931 r17858  
    6565   * Converts an array to HTML. 
    6666   * 
    67    * @param string $id      The identifier to use 
    68    * @param array  $values The array of values 
     67   * @param string $id     The identifier to use 
     68   * @param array  $values The array of values 
    6969   * 
    7070   * @return string An HTML string 
  • branches/1.2/lib/event/sfEvent.class.php

    r8698 r17858  
    2929   * Constructs a new sfEvent. 
    3030   * 
    31    * @param mixed  $subject      The subject 
    32    * @param string $name         The event name 
    33    * @param array  $parameters  An array of parameters 
     31   * @param mixed  $subject    The subject 
     32   * @param string $name       The event name 
     33   * @param array  $parameters An array of parameters 
    3434   */ 
    3535  public function __construct($subject, $name, $parameters = array()) 
     
    114114   * Returns true if the parameter exists (implements the ArrayAccess interface). 
    115115   * 
    116    * @param string  $name The parameter name 
     116   * @param string $name The parameter name 
    117117   * 
    118118   * @return Boolean true if the parameter exists, false otherwise 
     
    126126   * Returns a parameter value (implements the ArrayAccess interface). 
    127127   * 
    128    * @param string  $name The parameter name 
     128   * @param string $name The parameter name 
    129129   * 
    130    * @return mixed The parameter value 
     130   * @return mixed The parameter value 
    131131   */ 
    132132  public function offsetGet($name) 
     
    143143   * Sets a parameter (implements the ArrayAccess interface). 
    144144   * 
    145    * @param string $name   The parameter name 
    146    * @param mixed  $value The parameter value  
     145   * @param string $name  The parameter name 
     146   * @param mixed  $value The parameter value  
    147147   */ 
    148148  public function offsetSet($name, $value) 
     
    154154   * Removes a parameter (implements the ArrayAccess interface). 
    155155   * 
    156    * @param string $name    The parameter name 
     156   * @param string $name The parameter name 
    157157   */ 
    158158  public function offsetUnset($name) 
  • branches/1.2/lib/event/sfEventDispatcher.class.php

    r10631 r17858  
    2727   * Connects a listener to a given event name. 
    2828   * 
    29    * @param string $name      An event name 
    30    * @param mixed  $listener A PHP callable 
     29   * @param string $name     An event name 
     30   * @param mixed  $listener A PHP callable 
    3131   */ 
    3232  public function connect($name, $listener) 
     
    4343   * Disconnects a listener for a given event name. 
    4444   * 
    45    * @param string   $name      An event name 
    46    * @param mixed    $listener A PHP callable 
     45   * @param string $name     An event name 
     46   * @param mixed  $listener A PHP callable 
    4747   * 
    4848   * @return mixed false if listener does not exist, null otherwise 
     
    8484   * Notifies all listeners of a given event until one returns a non null value. 
    8585   * 
    86    * @param sfEvent $event A sfEvent instance 
     86   * @param sfEvent $event A sfEvent instance 
    8787   * 
    8888   * @return sfEvent The sfEvent instance 
     
    105105   * Filters a value by calling all listeners of a given event. 
    106106   * 
    107    * @param sfEvent  $event  A sfEvent instance 
    108    * @param mixed    $value  The value to be filtered 
     107   * @param sfEvent $event A sfEvent instance 
     108   * @param mixed   $value The value to be filtered 
    109109   * 
    110110   * @return sfEvent The sfEvent instance 
     
    125125   * Returns true if the given event name has some listeners. 
    126126   * 
    127    * @param string   $name    The event name 
     127   * @param string $name The event name 
    128128   * 
    129129   * @return Boolean true if some listeners are connected, false otherwise 
     
    142142   * Returns all listeners associated with a given event name. 
    143143   * 
    144    * @param string   $name    The event name 
     144   * @param string $name The event name 
    145145   * 
    146    * @return array An array of listeners 
     146   * @return array An array of listeners 
    147147   */ 
    148148  public function getListeners($name) 
  • branches/1.2/lib/exception/sfException.class.php

    r15223 r17858  
    191191   * Returns the path for the template error message. 
    192192   * 
    193    * @param string  $format The request format 
    194    * @param Boolean $debug  Whether to return a template for the debug mode or not 
    195    * 
    196    * @return string|Boolean false if the template cannot be found for the given format, 
    197    *                        the absolute path to the template otherwise 
     193   * @param string  $format The request format 
     194   * @param Boolean $debug  Whether to return a template for the debug mode or not 
     195   * 
     196   * @return string|Boolean false if the template cannot be found for the given format, 
     197   *                        the absolute path to the template otherwise 
    198198   */ 
    199199  static public function getTemplatePathForError($format, $debug) 
     
    220220   * Returns an array of exception traces. 
    221221   * 
    222    * @param Exception $exception An Exception implementation instance 
    223    * @param string    $format    The trace format (plain or html) 
     222   * @param Exception $exception An Exception implementation instance 
     223   * @param string    $format    The trace format (plain or html) 
    224224   * 
    225225   * @return array An array of traces 
     
    282282   * Returns an excerpt of a code file around the given line number. 
    283283   * 
    284    * @param string $file A file path 
    285    * @param int    $line The selected line number 
     284   * @param string $file A file path 
     285   * @param int    $line The selected line number 
    286286   * 
    287287   * @return string An HTML string 
     
    306306   * Formats an array as a string. 
    307307   * 
    308    * @param array   $args     The argument array 
     308   * @param array   $args   The argument array 
    309309   * @param boolean $single 
    310    * @param string  $format   The format string (html or plain) 
     310   * @param string  $format The format string (html or plain) 
    311311   * 
    312312   * @return string 
  • branches/1.2/lib/filter/sfCacheFilter.class.php

    r17749 r17858  
    2929   * Initializes this Filter. 
    3030   * 
    31    * @param sfContext $context      The current application context 
    32    * @param array     $parameters   An associative array of initialization parameters 
     31   * @param sfContext $context    The current application context 
     32   * @param array     $parameters An associative array of initialization parameters 
    3333   * 
    3434   * @return bool true, if initialization completes successfully, otherwise false 
  • branches/1.2/lib/filter/sfExecutionFilter.class.php

    r16250 r17858  
    5959   * Handles the action. 
    6060   * 
    61    * @param sfFilterChain $filterChain     The current filter chain 
    62    * @param sfAction      $actionInstance An sfAction instance 
     61   * @param sfFilterChain $filterChain    The current filter chain 
     62   * @param sfAction      $actionInstance An sfAction instance 
    6363   * 
    64    * @return string        The view type 
     64   * @return string The view type 
    6565   */ 
    6666  protected function handleAction($filterChain, $actionInstance) 
     
    8080   * Executes the execute method of an action. 
    8181   * 
    82    * @param sfAction $actionInstance An sfAction instance 
     82   * @param sfAction $actionInstance An sfAction instance 
    8383   * 
    84    * @return string   The view type 
     84   * @return string The view type 
    8585   */ 
    8686  protected function executeAction($actionInstance) 
     
    9797   * Handles the view. 
    9898   * 
    99    * @param sfFilterChain $filterChain     The current filter chain 
    100    * @param sfAction      $actionInstance An sfAction instance 
    101    * @param string        $viewName        The view name 
     99   * @param sfFilterChain $filterChain    The current filter chain 
     100   * @param sfAction      $actionInstance An sfAction instance 
     101   * @param string        $viewName       The view name 
    102102   */ 
    103103  protected function handleView($filterChain, $actionInstance, $viewName) 
     
    124124   *   - sfView::RENDER_DATA: View data populates the data presentation variable. 
    125125   * 
    126    * @param string $moduleName     The module name 
    127    * @param string $actionName     The action name 
    128    * @param string $viewName       The view name 
    129    * @param array  $viewAttributes An array of view attributes 
     126   * @param string $moduleName     The module name 
     127   * @param string $actionName     The action name 
     128   * @param string $viewName       The view name 
     129   * @param array  $viewAttributes An array of view attributes 
    130130   * 
    131131   * @return string The view data 
  • branches/1.2/lib/filter/sfFilter.class.php

    r9087 r17858  
    124124   * <code>$this->getParameterHolder()->has()</code> 
    125125   * 
    126    * @param string $name The key name 
     126   * @param string $name The key name 
    127127   * 
    128128   * @return boolean true if the given key exists, false otherwise 
  • branches/1.2/lib/form/sfForm.class.php

    r17749 r17858  
    4848   * Constructor. 
    4949   * 
    50    * @param array  $defaults    An array of field default values 
    51    * @param array  $options    An array of options 
    52    * @param string $CSRFSecret A CSRF secret (false to disable CSRF protection, null to use the global CSRF secret) 
     50   * @param array  $defaults   An array of field default values 
     51   * @param array  $options    An array of options 
     52   * @param string $CSRFSecret A CSRF secret (false to disable CSRF protection, null to use the global CSRF secret) 
    5353   */ 
    5454  public function __construct($defaults = array(), $options = array(), $CSRFSecret = null) 
     
    113113   * Renders the widget schema associated with this form. 
    114114   * 
    115    * @param array  $attributes An array of HTML attributes 
     115   * @param array $attributes An array of HTML attributes 
    116116   * 
    117117   * @return string The rendered widget schema 
     
    125125   * Renders the widget schema using a specific form formatter 
    126126   * 
    127    * @param string  $formatterName The form formatter name 
    128    * @param array   $attributes     An array of HTML attributes 
     127   * @param string $formatterName The form formatter name 
     128   * @param array  $attributes    An array of HTML attributes 
    129129   * 
    130130   * @return string The rendered widget schema 
     
    197197   * It triggers the validator schema validation. 
    198198   * 
    199    * @param array $taintedValues An array of input values 
    200    * @param array $taintedFiles  An array of uploaded files (in the $_FILES or $_GET format) 
     199   * @param array $taintedValues An array of input values 
     200   * @param array $taintedFiles  An array of uploaded files (in the $_FILES or $_GET format) 
    201201   */ 
    202202  public function bind(array $taintedValues = null, array $taintedFiles = null) 
     
    313313   * If the form is not bound, it will return null. 
    314314   * 
    315    * @param string  $field The name of the value required 
    316    * @return string The cleaned value 
     315   * @param string $field The name of the value required 
     316   * @return string The cleaned value 
    317317   */ 
    318318  public function getValue($field) 
     
    351351   * Embeds a sfForm into the current form. 
    352352   * 
    353    * @param string $name      The field name 
    354    * @param sfForm $form      A sfForm instance 
    355    * @param string $decorator A HTML decorator for the embedded form 
     353   * @param string $name      The field name 
     354   * @param sfForm $form      A sfForm instance 
     355   * @param string $decorator A HTML decorator for the embedded form 
    356356   */ 
    357357  public function embedForm($name, sfForm $form, $decorator = null) 
     
    383383   * Embeds a sfForm into the current form n times. 
    384384   * 
    385    * @param string  $name             The field name 
    386    * @param sfForm  $form             A sfForm instance 
    387    * @param integer $n                The number of times to embed the form 
    388    * @param string  $decorator        A HTML decorator for the main form around embedded forms 
    389    * @param string  $innerDecorator   A HTML decorator for each embedded form 
    390    * @param array   $options          Options for schema 
    391    * @param array   $attributes       Attributes for schema 
    392    * @param array   $labels           Labels for schema 
     385   * @param string  $name           The field name 
     386   * @param sfForm  $form           A sfForm instance 
     387   * @param integer $n              The number of times to embed the form 
     388   * @param string  $decorator      A HTML decorator for the main form around embedded forms 
     389   * @param string  $innerDecorator A HTML decorator for each embedded form 
     390   * @param array   $options        Options for schema 
     391   * @param array   $attributes     Attributes for schema 
     392   * @param array   $labels         Labels for schema 
    393393   */ 
    394394  public function embedFormForEach($name, sfForm $form, $n, $decorator = null, $innerDecorator = null, $options = array(), $attributes = array(), $labels = array()) 
     
    451451   * sfForm object passed as parameter. Please note it also merge defaults. 
    452452   * 
    453    * @param sfForm   $form      The sfForm instance to merge with current form 
    454    * 
    455    * @throws LogicException      If one of the form has already been bound 
     453   * @param sfForm $form The sfForm instance to merge with current form 
     454   * 
     455   * @throws LogicException If one of the form has already been bound 
    456456   */ 
    457457  public function mergeForm(sfForm $form) 
     
    562562   * Gets a validator for the given field name. 
    563563   * 
    564    * @param string      $name      The field name 
     564   * @param string $name The field name 
    565565   * 
    566566   * @return sfValidator $validator The validator 
     
    624624   * Gets a widget for the given field name. 
    625625   * 
    626    * @param string       $name      The field name 
     626   * @param string $name The field name 
    627627   * 
    628628   * @return sfWidgetForm $widget The widget 
     
    805805   * can override this method. 
    806806   * 
    807    * @param string $secret The secret string to use (null to use the current secret) 
     807   * @param string $secret The secret string to use (null to use the current secret) 
    808808   * 
    809809   * @return string A token string 
     
    899899   * for later processing. 
    900900   * 
    901    * @param string $url         The URL for the action 
    902    * @param array  $attributes An array of HTML attributes 
     901   * @param string $url        The URL for the action 
     902   * @param array  $attributes An array of HTML attributes 
    903903   * 
    904904   * @return string An HTML representation of the opening form tag 
     
    932932   * Returns true if the bound field exists (implements the ArrayAccess interface). 
    933933   * 
    934    * @param string $name The name of the bound field 
     934   * @param string $name The name of the bound field 
    935935   * 
    936936   * @return Boolean true if the widget exists, false otherwise 
     
    944944   * Returns the form field associated with the name (implements the ArrayAccess interface). 
    945945   * 
    946    * @param string $name The offset of the value to get 
    947    * 
    948    * @return sfFormField   A form field instance 
     946   * @param string $name The offset of the value to get 
     947   * 
     948   * @return sfFormField A form field instance 
    949949   */ 
    950950  public function offsetGet($name) 
     
    10941094   * It's safe to pass an already converted array, in which case this method just returns the original array unmodified. 
    10951095   * 
    1096    * @param array $taintedFiles An array representing uploaded file information 
     1096   * @param array $taintedFiles An array representing uploaded file information 
    10971097   * 
    10981098   * @return array An array of re-ordered uploaded file information 
  • branches/1.2/lib/form/sfFormField.class.php

    r15807 r17858  
    3232   * Constructor. 
    3333   * 
    34    * @param sfWidgetForm     $widget    A sfWidget instance 
    35    * @param sfFormField      $parent    The sfFormField parent instance (null for the root widget) 
    36    * @param string           $name      The field name 
    37    * @param string           $value     The field value 
    38    * @param sfValidatorError $error     A sfValidatorError instance 
     34   * @param sfWidgetForm     $widget A sfWidget instance 
     35   * @param sfFormField      $parent The sfFormField parent instance (null for the root widget) 
     36   * @param string           $name   The field name 
     37   * @param string           $value  The field value 
     38   * @param sfValidatorError $error  A sfValidatorError instance 
    3939   */ 
    4040  public function __construct(sfWidgetForm $widget, sfFormField $parent = null, $name, $value, sfValidatorError $error = null) 
     
    109109   * Renders the form field. 
    110110   * 
    111    * @param array  $attributes  An array of HTML attributes 
     111   * @param array $attributes An array of HTML attributes 
    112112   * 
    113113   * @return string The rendered widget 
     
    125125   * the help message. 
    126126   * 
    127    * @param array  $attributes  An array of HTML attributes to merge with the current attributes 
    128    * @param string $label        The label name (not null to override the current value) 
    129    * @param string $help         The help text (not null to override the current value) 
     127   * @param array  $attributes An array of HTML attributes to merge with the current attributes 
     128   * @param string $label      The label name (not null to override the current value) 
     129   * @param string $help       The help text (not null to override the current value) 
    130130   * 
    131131   * @return string The formatted row 
     
    184184   * Returns the label tag. 
    185185   * 
    186    * @param string $label       The label name (not null to override the current value) 
    187    * @param array  $attributes Optional html attributes 
     186   * @param string $label      The label name (not null to override the current value) 
     187   * @param array  $attributes Optional html attributes 
    188188   * 
    189189   * @return string The label tag 
  • branches/1.2/lib/form/sfFormFieldSchema.class.php

    r17587 r17858  
    2727   * Constructor. 
    2828   * 
    29    * @param sfWidgetFormSchema $widget A sfWidget instance 
    30    * @param sfFormField        $parent The sfFormField parent instance (null for the root widget) 
    31    * @param string             $name    The field name 
    32    * @param string             $value  The field value 
    33    * @param sfValidatorError   $error  A sfValidatorError instance 
     29   * @param sfWidgetFormSchema $widget A sfWidget instance 
     30   * @param sfFormField        $parent The sfFormField parent instance (null for the root widget) 
     31   * @param string             $name   The field name 
     32   * @param string             $value  The field value 
     33   * @param sfValidatorError   $error  A sfValidatorError instance 
    3434   */ 
    3535  public function __construct(sfWidgetFormSchema $widget, sfFormField $parent = null, $name, $value, sfValidatorError $error = null) 
     
    4343   * Returns true if the bound field exists (implements the ArrayAccess interface). 
    4444   * 
    45    * @param string  $name The name of the bound field 
     45   * @param string $name The name of the bound field 
    4646   * 
    4747   * @return Boolean true if the widget exists, false otherwise 
     
    5555   * Returns the form field associated with the name (implements the ArrayAccess interface). 
    5656   * 
    57    * @param string $name The offset of the value to get 
     57   * @param string $name The offset of the value to get 
    5858   * 
    5959   * @return sfFormField A form field instance 
  • branches/1.2/lib/generator/sfAdminGenerator.class.php

    r13060 r17858  
    3333   * Returns HTML code for a help icon. 
    3434   * 
    35    * @param string $column The column name 
    36    * @param string $type    The field type (list, edit) 
     35   * @param string $column The column name 
     36   * @param string $type   The field type (list, edit) 
    3737   * 
    3838   * @return string HTML code 
     
    5252   * Returns HTML code for a help text. 
    5353   * 
    54    * @param string $column The column name 
    55    * @param string $type    The field type (list, edit) 
     54   * @param string $column The column name 
     55   * @param string $type   The field type (list, edit) 
    5656   * 
    5757   * @return string HTML code 
     
    7171   * Returns HTML code for an action button. 
    7272   * 
    73    * @param string  $actionName   The action name 
    74    * @param array   $params       The parameters 
    75    * @param boolean $pk_link      Whether to add a primary key link or not 
     73   * @param string  $actionName The action name 
     74   * @param array   $params     The parameters 
     75   * @param boolean $pk_link    Whether to add a primary key link or not 
    7676   * 
    7777   * @return string HTML code 
     
    182182   * Returns HTML code for an action link. 
    183183   * 
    184    * @param string  $actionName   The action name 
    185    * @param array   $params       The parameters 
    186    * @param boolean $pk_link      Whether to add a primary key link or not 
     184   * @param string  $actionName The action name 
     185   * @param array   $params     The parameters 
     186   * @param boolean $pk_link    Whether to add a primary key link or not 
    187187   * 
    188188   * @return string HTML code 
     
    229229   * Returns HTML code for an action option in a select tag. 
    230230   * 
    231    * @param string $actionName The action name 
    232    * @param array  $params     The parameters 
     231   * @param string $actionName The action name 
     232   * @param array  $params     The parameters 
    233233   * 
    234234   * @return string HTML code 
     
    259259   * Returns HTML code for a column in edit mode. 
    260260   * 
    261    * @param string $column  The column name 
    262    * @param array  $params  The parameters 
     261   * @param string $column The column name 
     262   * @param array  $params The parameters 
    263263   * 
    264264   * @return string HTML code 
     
    338338   * Wraps content with a credential condition. 
    339339   * 
    340    * @param string $content The content 
    341    * @param array  $params   The parameters 
     340   * @param string $content The content 
     341   * @param array  $params  The parameters 
    342342   * 
    343343   * @return string HTML code 
     
    515515   * Wraps a content for I18N. 
    516516   * 
    517    * @param string $key      The key name 
    518    * @param string $default  The defaul value 
    519    * @param bool   $withEcho If true, string is wrapped in php echo 
     517   * @param string $key      The key name 
     518   * @param string $default  The defaul value 
     519   * @param bool   $withEcho If true, string is wrapped in php echo 
    520520   * 
    521521   * @return string HTML code 
     
    590590   * Returns HTML code for a column in list mode. 
    591591   * 
    592    * @param string $column The column name 
    593    * @param array  $params The parameters 
     592   * @param string $column The column name 
     593   * @param array  $params The parameters 
    594594   * 
    595595   * @return string HTML code 
     
    631631   * Returns HTML code for a column in filter mode. 
    632632   * 
    633    * @param string $column The column name 
    634    * @param array  $params The parameters 
     633   * @param string $column The column name 
     634   * @param array  $params The parameters 
    635635   * 
    636636   * @return string HTML code 
  • branches/1.2/lib/generator/sfCrudGenerator.class.php

    r11471 r17858  
    314314   * Returns HTML code for a column in list mode. 
    315315   * 
    316    * @param string $column  The column name 
    317    * @param array  $params  The parameters 
     316   * @param string $column The column name 
     317   * @param array  $params The parameters 
    318318   * 
    319319   * @return string HTML code 
     
    342342   * Returns HTML code for a column in edit mode. 
    343343   * 
    344    * @param string $column  The column name 
    345    * @param array  $params  The parameters 
     344   * @param string $column The column name 
     345   * @param array  $params The parameters 
    346346   * 
    347347   * @return string HTML code 
     
    420420   * This method is ORM dependant. 
    421421   * 
    422    * @param string $helperName    The helper name 
    423    * @param string $column        The column name 
    424    * @param array  $params        An array of parameters 
    425    * @param array  $localParams   An array of local parameters 
     422   * @param string $helperName  The helper name 
     423   * @param string $column      The column name 
     424   * @param array  $params      An array of parameters 
     425   * @param array  $localParams An array of local parameters 
    426426   * 
    427427   * @return string PHP code 
     
    434434   * This method is ORM dependant. 
    435435   * 
    436    * @param string  $column    The column name 
    437    * @param boolean $developed true if you want developped method names, false otherwise 
    438    * @param string  $prefix    The prefix value 
     436   * @param string  $column    The column name 
     437   * @param boolean $developed true if you want developped method names, false otherwise 
     438   * @param string  $prefix    The prefix value 
    439439   * 
    440440   * @return string PHP code 
  • branches/1.2/lib/generator/sfGenerator.class.php

    r9123 r17858  
    5858   * Generates PHP files for a given module name. 
    5959   * 
    60    * @param string $generatedModuleName   The name of module name to generate 
    61    * @param array  $files                 A list of template files to generate 
     60   * @param string $generatedModuleName The name of module name to generate 
     61   * @param array  $files               A list of template files to generate 
    6262   */ 
    6363  protected function generatePhpFiles($generatedModuleName, $files = array()) 
     
    7272   * Evaluates a template file. 
    7373   * 
    74    * @param string $templateFile The template file path 
     74   * @param string $templateFile The template file path 
    7575   * 
    7676   * @return string The evaluated template 
  • branches/1.2/lib/generator/sfGeneratorManager.class.php

    r12264 r17858  
    4040   * Initializes the sfGeneratorManager instance. 
    4141   * 
    42    * @param      sfProjectConfiguration $configuration A sfProjectConfiguration instance 
     42   * @param sfProjectConfiguration $configuration A sfProjectConfiguration instance 
    4343   * @deprecated 
    4444   */ 
     
    115115   * Generates classes and templates for a given generator class. 
    116116   * 
    117    * @param string $generatorClass    The generator class name 
    118    * @param array  $param             An array of parameters 
     117   * @param string $generatorClass The generator class name 
     118   * @param array  $param          An array of parameters 
    119119   * 
    120120   * @return string The cache for the configuration file 
  • branches/1.2/lib/generator/sfModelGenerator.class.php

    r17063 r17858  
    182182   * This method is ORM dependant. 
    183183   * 
    184    * @param string  $column    The column name 
    185    * @param boolean $developed true if you want developped method names, false otherwise 
    186    * @param string  $prefix    The prefix value 
     184   * @param string  $column    The column name 
     185   * @param boolean $developed true if you want developped method names, false otherwise 
     186   * @param string  $prefix    The prefix value 
    187187   * 
    188188   * @return string PHP code 
     
    195195   * Returns HTML code for an action link. 
    196196   * 
    197    * @param string  $actionName   The action name 
    198    * @param array   $params       The parameters 
    199    * @param boolean $pk_link      Whether to add a primary key link or not 
     197   * @param string  $actionName The action name 
     198   * @param array   $params     The parameters 
     199   * @param boolean $pk_link    Whether to add a primary key link or not 
    200200   * 
    201201   * @return string HTML code 
     
    213213   * Wraps content with a credential condition. 
    214214   * 
    215    * @param string $content The content 
    216    * @param array  $params   The parameters 
     215   * @param string $content The content 
     216   * @param array  $params  The parameters 
    217217   * 
    218218   * @return string HTML code 
  • branches/1.2/lib/generator/sfModelGeneratorConfiguration.class.php

    r17749 r17858  
    210210   * Gets the configuration for a given field. 
    211211   * 
    212    * @param string  $key     The configuration key (title.list.name for example) 
    213    * @param mixed   $default The default value if none has been defined 
    214    * @param Boolean $escaped Whether to escape single quote (false by default) 
    215    * 
    216    * @return mixed           The configuration value 
     212   * @param string  $key     The configuration key (title.list.name for example) 
     213   * @param mixed   $default The default value if none has been defined 
     214   * @param Boolean $escaped Whether to escape single quote (false by default) 
     215   * 
     216   * @return mixed The configuration value 
    217217   */ 
    218218  public function getValue($key, $default = null, $escaped = false) 
  • branches/1.2/lib/generator/sfModelGeneratorConfigurationField.class.php

    r17749 r17858  
    4848   * If the key is null, the method returns all the configuration array. 
    4949   * 
    50    * @param string  $key     A key string 
    51    * @param mixed   $default The default value if the key does not exist 
    52    * @param Boolean $escaped Whether to escape single quote (false by default) 
    53    * 
    54    * @return mixed   The configuration value associated with the key 
     50   * @param string  $key     A key string 
     51   * @param mixed   $default The default value if the key does not exist 
     52   * @param Boolean $escaped Whether to escape single quote (false by default) 
     53   * 
     54   * @return mixed The configuration value associated with the key 
    5555   */ 
    5656  public function getConfig($key = null, $default = null, $escaped = false) 
  • branches/1.2/lib/helper/AssetHelper.php

    r17078 r17858  
    3838 * </code> 
    3939 * 
    40  * @param string $type         feed type ('rss', 'atom') 
    41  * @param string $url          'module/action' or '@rule' of the feed 
    42  * @param array  $tag_options additional HTML compliant <link> tag parameters 
     40 * @param string $type        feed type ('rss', 'atom') 
     41 * @param string $url         'module/action' or '@rule' of the feed 
     42 * @param array  $tag_options additional HTML compliant <link> tag parameters 
    4343 * 
    4444 * @return string XHTML compliant <link> tag 
     
    6868 * - file name without extension, like "myscript", that gets expanded to "/js/myscript.js" 
    6969 * 
    70  * @param string $source    asset name 
    71  * @param bool   $absolute return absolute path ? 
     70 * @param string $source   asset name 
     71 * @param bool   $absolute return absolute path ? 
    7272 * 
    7373 * @return string file path to the JavaScript file 
     
    9191 * </code> 
    9292 * 
    93  * @param string asset names 
    94  * @param array additional HTML compliant <link> tag parameters 
     93 * @param string asset names 
     94 * @param array additional HTML compliant <link> tag parameters 
    9595 * 
    9696 * @return string XHTML compliant <script> tag(s) 
     
    156156 * - file name without extension, like "style", that gets expanded to "/css/style.css" 
    157157 * 
    158  * @param string $source    asset name 
    159  * @param bool   $absolute return absolute path ? 
     158 * @param string $source   asset name 
     159 * @param bool   $absolute return absolute path ? 
    160160 * 
    161161 * @return string file path to the stylesheet file 
     
    189189 * </code> 
    190190 * 
    191  * @param string asset names 
    192  * @param array additional HTML compliant <link> tag parameters 
     191 * @param string asset names 
     192 * @param array additional HTML compliant <link> tag parameters 
    193193 * 
    194194 * @return string XHTML compliant <link> tag(s) 
     
    263263 * Decorates the current template with a given layout. 
    264264 * 
    265  * @param mixed $layout The layout name or path or false to disable the layout 
     265 * @param mixed $layout The layout name or path or false to disable the layout 
    266266 */ 
    267267function decorate_with($layout) 
     
    291291 * - file name without extension, like "logo", that gets expanded to "/images/logo.png" 
    292292 * 
    293  * @param string $source    asset name 
    294  * @param bool   $absolute return absolute path ? 
     293 * @param string $source   asset name 
     294 * @param bool   $absolute return absolute path ? 
    295295 * 
    296296 * @return string file path to the image file 
     
    318318 * </code> 
    319319 * 
    320  * @param string $source   image asset name 
    321  * @param array  $options additional HTML compliant <img> tag parameters 
     320 * @param string $source  image asset name 
     321 * @param array  $options additional HTML compliant <img> tag parameters 
    322322 * 
    323323 * @return string XHTML compliant <img> tag 
     
    561561 * The helper automatically adds the sf_format to the internal URI, so you don't have to. 
    562562 * 
    563  * @param string $uri       The internal URI for the dynamic javascript 
    564  * @param bool   $absolute Whether to generate an absolute URL 
    565  * @param array  $options   An array of options 
    566  * 
    567  * @return string XHTML compliant <script> tag(s) 
     563 * @param string $uri      The internal URI for the dynamic javascript 
     564 * @param bool   $absolute Whether to generate an absolute URL 
     565 * @param array  $options  An array of options 
     566 * 
     567 * @return string XHTML compliant <script> tag(s) 
    568568 * @see    javascript_include_tag 
    569569 */ 
  • branches/1.2/lib/helper/DateFormHelper.php

    r14264 r17858  
    3838 * </code> 
    3939 * 
    40  * @param string $name          field name 
    41  * @param int    $value         selected value (1 - 31) 
    42  * @param array  $options       special options for the select tag 
    43  * @param array  $html_options additional HTML compliant <select> tag parameters 
     40 * @param string $name         field name 
     41 * @param int    $value        selected value (1 - 31) 
     42 * @param array  $options      special options for the select tag 
     43 * @param array  $html_options additional HTML compliant <select> tag parameters 
    4444 * 
    4545 * @return string <select> tag populated with all the days of the month (1 - 31). 
     
    9292 * </code> 
    9393 * 
    94  * @param string $name          field name 
    95  * @param int    $value         selected value (1 - 12) 
    96  * @param array  $options       special options for the select tag 
    97  * @param array  $html_options additional HTML compliant <select> tag parameters 
     94 * @param string $name         field name 
     95 * @param int    $value        selected value (1 - 12) 
     96 * @param array  $options      special options for the select tag 
     97 * @param array  $html_options additional HTML compliant <select> tag parameters 
    9898 * 
    9999 * @return string <select> tag populated with all the months of the year (1 - 12). 
     
    172172 * </code> 
    173173 * 
    174  * @param string $name          field name 
    175  * @param int    $value         selected value within the range of years. 
    176  * @param array  $options       special options for the select tag 
    177  * @param array  $html_options additional HTML compliant <select> tag parameters 
     174 * @param string $name         field name 
     175 * @param int    $value        selected value within the range of years. 
     176 * @param array  $options      special options for the select tag 
     177 * @param array  $html_options additional HTML compliant <select> tag parameters 
    178178 *  
    179179 * @return string <select> tag populated with a range of years. 
     
    259259 * </code> 
    260260 * 
    261  * @param string $name          field name (automatically becomes an array of parts: name[year], name[month], year[day]) 
    262  * @param mixed  $value         accepts a valid date string or properly formatted date array 
    263  * @param array  $options       special options for the select tags 
    264  * @param array  $html_options additional HTML compliant <select> tag parameters 
     261 * @param string $name         field name (automatically becomes an array of parts: name[year], name[month], year[day]) 
     262 * @param mixed  $value        accepts a valid date string or properly formatted date array 
     263 * @param array  $options      special options for the select tags 
     264 * @param array  $html_options additional HTML compliant <select> tag parameters 
    265265 * 
    266266 * @return string three <select> tags populated with a months, days and years 
     
    375375 * </code> 
    376376 * 
    377  * @param string $name          field name 
    378  * @param int    $value         selected value (0 - 59) 
    379  * @param array  $options       special options for the select tag 
    380  * @param array  $html_options additional HTML compliant <select> tag parameters 
     377 * @param string $name         field name 
     378 * @param int    $value        selected value (0 - 59) 
     379 * @param array  $options      special options for the select tag 
     380 * @param array  $html_options additional HTML compliant <select> tag parameters 
    381381 * 
    382382 * @return string <select> tag populated with 60 seconds (0 - 59). 
     
    428428 * </code> 
    429429 * 
    430  * @param string $name          field name 
    431  * @param int    $value         selected value (0 - 59) 
    432  * @param array  $options       special options for the select tag 
    433  * @param array  $html_options additional HTML compliant <select> tag parameters 
     430 * @param string $name         field name 
     431 * @param int    $value        selected value (0 - 59) 
     432 * @param array  $options      special options for the select tag 
     433 * @param array  $html_options additional HTML compliant <select> tag parameters 
    434434 * 
    435435 * @return string <select> tag populated with 60 minutes (0 - 59). 
     
    479479 * </code> 
    480480 * 
    481  * @param string $name          field name 
    482  * @param int    $value         selected value (0 - 23 or 1 - 12 if '12hour_time' = true) 
    483  * @param array  $options       special options for the select tag 
    484  * @param array  $html_options additional HTML compliant <select> tag parameters 
     481 * @param string $name         field name 
     482 * @param int    $value        selected value (0 - 23 or 1 - 12 if '12hour_time' = true) 
     483 * @param array  $options      special options for the select tag 
     484 * @param array  $html_options additional HTML compliant <select> tag parameters 
    485485 * 
    486486 * @return string <select> tag populated with 24 hours (0 - 23), or optionally 12 hours (1 - 12). 
     
    534534 * </code> 
    535535 * 
    536  * @param string $name          field name 
    537  * @param string $value         selected value (AM or PM) 
    538  * @param array  $options       special options for the select tag 
    539  * @param array  $html_options additional HTML compliant <select> tag parameters  
     536 * @param string $name         field name 
     537 * @param string $value        selected value (AM or PM) 
     538 * @param array  $options      special options for the select tag 
     539 * @param array  $html_options additional HTML compliant <select> tag parameters  
    540540 * @return string <select> tag populated with AM and PM options for use with 12-Hour time. 
    541541 * @see select_time_tag, select datetime_tag 
     
    597597 * </code> 
    598598 * 
    599  * @param string $name          field name (automatically becomes an array of parts: name[hour], name[minute], year[second]) 
    600  * @param mixed  $value         accepts a valid time string or properly formatted time array 
    601  * @param array  $options       special options for the select tag 
    602  * @param array  $html_options additional HTML compliant <select> tag parameters 
     599 * @param string $name         field name (automatically becomes an array of parts: name[hour], name[minute], year[second]) 
     600 * @param mixed  $value        accepts a valid time string or properly formatted time array 
     601 * @param array  $options      special options for the select tag 
     602 * @param array  $html_options additional HTML compliant <select> tag parameters 
    603603 * @return string three <select> tags populated with a hours, minutes and optionally seconds. 
    604604 * @see select datetime_tag, select_hour_tag, select_minute_tag, select_second_tag 
     
    718718 * </code> 
    719719 * 
    720  * @param string $name          field name (automatically becomes an array of date and time parts) 
    721  * @param mixed  $value         accepts a valid time string or properly formatted time array 
    722  * @param array  $options       special options for the select tagss 
    723  * @param array  $html_options additional HTML compliant <select> tag parameters 
     720 * @param string $name         field name (automatically becomes an array of date and time parts) 
     721 * @param mixed  $value        accepts a valid time string or properly formatted time array 
     722 * @param array  $options      special options for the select tagss 
     723 * @param array  $html_options additional HTML compliant <select> tag parameters 
    724724 * 
    725725 * @return string a variable number of <select> tags populated with date and time related select boxes 
     
    768768 * </code> 
    769769 * 
    770  * @param string $name          field name 
    771  * @param string $value         the selected option 
    772  * @param array  $options       special options for the select tagss 
    773  * @param array  $html_options additional HTML compliant <select> tag parameters 
     770 * @param string $name         field name 
     771 * @param string $value        the selected option 
     772 * @param array  $options      special options for the select tagss 
     773 * @param array  $html_options additional HTML compliant <select> tag parameters 
    774774 * 
    775775 * @return string <select> tag populated with a range of numbers. 
     
    822822 * </code> 
    823823 * 
    824  * @param string $name      field name  
    825  * @param string $selected selected field value (timezone identifier) 
    826  * @param array  $options   additional HTML compliant <select> tag parameters 
     824 * @param string $name     field name  
     825 * @param string $selected selected field value (timezone identifier) 
     826 * @param array  $options  additional HTML compliant <select> tag parameters 
    827827 * 
    828828 * @return string <select> tag populated with all the timezones in the world. 
     
    877877 * <b>Note:</b> If <i>$value</i> is empty, it will be populated with the current date and time. 
    878878 * 
    879  * @param string $value        date or date part 
    880  * @param string $key          custom key for array values 
    881  * @param string $format_char date format 
     879 * @param string $value       date or date part 
     880 * @param string $key         custom key for array values 
     881 * @param string $format_char date format 
    882882 * 
    883883 * @return string properly formatted date part value. 
     
    912912 * <b>Note:</b> If no <i>$culture</i> is defined, the user's culture setting will be used in its place. 
    913913 * 
    914  * @param string $culture two or three character culture setting variable 
     914 * @param string $culture two or three character culture setting variable 
    915915 * 
    916916 * @return string formatted date/time format based on the specified date/time setting 
  • branches/1.2/lib/helper/EscapingHelper.php

    r9101 r17858  
    3535 * Runs the PHP function htmlentities on the value passed. 
    3636 * 
    37  * @param string $value the value to escape 
     37 * @param string $value the value to escape 
    3838 * @return string the escaped value 
    3939 */ 
     
    5050 * Runs the PHP function htmlspecialchars on the value passed. 
    5151 * 
    52  * @param string $value the value to escape 
     52 * @param string $value the value to escape 
    5353 * @return string the escaped value 
    5454 */ 
     
    6666 * being to be able to specify that the value is not to be escaped in any way. 
    6767 * 
    68  * @param string $value the value to escape 
     68 * @param string $value the value to escape 
    6969 * @return string the escaped value 
    7070 */ 
     
    8585 * that is ultimately not going to end up as text in an HTML document. 
    8686 * 
    87  * @param string $value the value to escape 
     87 * @param string $value the value to escape 
    8888 * @return string the escaped value 
    8989 */ 
     
    9999 * JavaScript string. 
    100100 * 
    101  * @param string $value the value to escape 
     101 * @param string $value the value to escape 
    102102 * @return string the escaped value 
    103103 */ 
  • branches/1.2/lib/helper/FormHelper.php

    r14153 r17858  
    4848 * </code> 
    4949 * 
    50  * @param array  $options       dataset to create <option> tags and <optgroup> tags from 
    51  * @param string $selected      selected option value 
    52  * @param array  $html_options additional HTML compliant <option> tag parameters 
     50 * @param array  $options      dataset to create <option> tags and <optgroup> tags from 
     51 * @param string $selected     selected option value 
     52 * @param array  $html_options additional HTML compliant <option> tag parameters 
    5353 * 
    5454 * @return string populated with <option> tags derived from the <i>$options</i> array variable 
     
    410410 * </code> 
    411411 * 
    412  * @param string $name     field name  
    413  * @param array  $options additional HTML compliant <input> tag parameters 
     412 * @param string $name    field name  
     413 * @param array  $options additional HTML compliant <input> tag parameters 
    414414 * 
    415415 * @return string XHTML compliant <input> tag with type="file" 
     
    440440 * </code> 
    441441 * 
    442  * @param string $name     field name 
    443  * @param string $value    populated field value 
    444  * @param array  $options additional HTML compliant <input> tag parameters 
     442 * @param string $name    field name 
     443 * @param string $value   populated field value 
     444 * @param array  $options additional HTML compliant <input> tag parameters 
    445445 * 
    446446 * @return string XHTML compliant <input> tag with type="password" 
     
    679679 * </code> 
    680680 * 
    681  * @param string $name     field name  
    682  * @param string $value    date 
    683  * @param array  $options additional HTML compliant <input> tag parameters 
     681 * @param string $name    field name  
     682 * @param string $value   date 
     683 * @param array  $options additional HTML compliant <input> tag parameters 
    684684 * 
    685685 * @return string XHTML compliant <input> tag with optional JS calendar integration 
     
    732732  // register our javascripts and stylesheets 
    733733  $langFile = sfConfig::get('sf_calendar_web_dir').'/lang/calendar-'.$culture; 
    734   if((!is_readable(sfConfig::get('sf_web_dir').'/'.$langFile.'.js')) && 
     734  if ((!is_readable(sfConfig::get('sf_web_dir').'/'.$langFile.'.js')) && 
    735735     (!is_readable(sfConfig::get('sf_symfony_lib_dir').'/../data/web/'.$langFile.'.js')) && 
    736736     (!is_readable(sfConfig::get('sf_symfony_lib_dir').'/../data/symfony/web/'.$langFile.'.js'))) 
    737737  { 
    738738   $langFile = sfConfig::get('sf_calendar_web_dir').'/lang/calendar-'.substr($culture,0,2); 
    739    if((!is_readable(sfConfig::get('sf_web_dir').'/'.$langFile.'.js')) && 
     739   if ((!is_readable(sfConfig::get('sf_web_dir').'/'.$langFile.'.js')) && 
    740740      (!is_readable(sfConfig::get('sf_symfony_lib_dir').'/../data/web/'.$langFile.'.js')) && 
    741741      (!is_readable(sfConfig::get('sf_symfony_lib_dir').'/../data/symfony/web/'.$langFile.'.js'))) 
     
    855855 * </code> 
    856856 * 
    857  * @param string $name     field value (title of submit button) 
    858  * @param array  $options additional HTML compliant <input> tag parameters 
     857 * @param string $name    field value (title of submit button) 
     858 * @param array  $options additional HTML compliant <input> tag parameters 
    859859 * 
    860860 * @return string XHTML compliant <input> tag with type="submit" 
     
    881881 * </code> 
    882882 * 
    883  * @param string $name     field value (title of reset button) 
    884  * @param array  $options additional HTML compliant <input> tag parameters 
     883 * @param string $name    field value (title of reset button) 
     884 * @param array  $options additional HTML compliant <input> tag parameters 
    885885 * 
    886886 * @return string XHTML compliant <input> tag with type="reset" 
     
    910910 * </code> 
    911911 * 
    912  * @param string $source   path to image file 
    913  * @param array  $options additional HTML compliant <input> tag parameters 
     912 * @param string $source  path to image file 
     913 * @param array  $options additional HTML compliant <input> tag parameters 
    914914 * 
    915915 * @return string XHTML compliant <input> tag with type="image" 
     
    932932 * Returns a <label> tag with <i>$label</i> for the specified <i>$id</i> parameter. 
    933933 * 
    934  * @param string $id       id 
    935  * @param string $label    label or title 
    936  * @param array  $options additional HTML compliant <label> tag parameters 
     934 * @param string $id      id 
     935 * @param string $label   label or title 
     936 * @param array  $options additional HTML compliant <label> tag parameters 
    937937 * 
    938938 * @return string <label> tag with <i>$label</i> for the specified <i>$id</i> parameter. 

The Sensio Labs Network

Since 1998, Sensio Labs has been promoting the Open-Source software movement by providing quality web application development, training, consulting.
Sensio Labs also supports several large Open-Source projects.