Changeset 17858
- Timestamp:
- 05/01/09 23:22:50 (11 months ago)
- Files:
-
- branches/1.1/lib/action/sfActionStack.class.php (modified) (1 diff)
- branches/1.1/lib/action/sfActionStackEntry.class.php (modified) (1 diff)
- branches/1.1/lib/action/sfActions.class.php (modified) (1 diff)
- branches/1.1/lib/autoload/sfAutoload.class.php (modified) (2 diffs)
- branches/1.1/lib/cache/sfCache.class.php (modified) (10 diffs)
- branches/1.1/lib/cache/sfFunctionCache.class.php (modified) (1 diff)
- branches/1.1/lib/cache/sfXCacheCache.class.php (modified) (3 diffs)
- branches/1.1/lib/command/sfCommandArgument.class.php (modified) (1 diff)
- branches/1.1/lib/command/sfCommandArgumentSet.class.php (modified) (2 diffs)
- branches/1.1/lib/command/sfCommandLogger.class.php (modified) (1 diff)
- branches/1.1/lib/command/sfCommandManager.class.php (modified) (2 diffs)
- branches/1.1/lib/command/sfCommandOption.class.php (modified) (1 diff)
- branches/1.1/lib/command/sfCommandOptionSet.class.php (modified) (4 diffs)
- branches/1.1/lib/command/sfFormatter.class.php (modified) (2 diffs)
- branches/1.1/lib/config/sfCacheConfigHandler.class.php (modified) (1 diff)
- branches/1.1/lib/config/sfCompileConfigHandler.class.php (modified) (1 diff)
- branches/1.1/lib/config/sfConfigCache.class.php (modified) (6 diffs)
- branches/1.1/lib/config/sfDefineEnvironmentConfigHandler.class.php (modified) (4 diffs)
- branches/1.1/lib/config/sfFilterConfigHandler.class.php (modified) (1 diff)
- branches/1.1/lib/config/sfViewConfigHandler.class.php (modified) (2 diffs)
- branches/1.1/lib/config/sfYamlConfigHandler.class.php (modified) (3 diffs)
- branches/1.1/lib/controller/sfConsoleController.class.php (modified) (1 diff)
- branches/1.1/lib/database/sfMySQLiDatabase.class.php (modified) (2 diffs)
- branches/1.1/lib/database/sfPDODatabase.class.php (modified) (4 diffs)
- branches/1.1/lib/debug/sfDebug.class.php (modified) (1 diff)
- branches/1.1/lib/event/sfEvent.class.php (modified) (5 diffs)
- branches/1.1/lib/event/sfEventDispatcher.class.php (modified) (6 diffs)
- branches/1.1/lib/filter/sfCacheFilter.class.php (modified) (1 diff)
- branches/1.1/lib/filter/sfExecutionFilter.class.php (modified) (4 diffs)
- branches/1.1/lib/filter/sfFilter.class.php (modified) (1 diff)
- branches/1.1/lib/form/sfFormFieldSchema.class.php (modified) (3 diffs)
- branches/1.1/lib/generator/sfGenerator.class.php (modified) (2 diffs)
- branches/1.1/lib/helper/EscapingHelper.php (modified) (5 diffs)
- branches/1.2/lib/action/sfAction.class.php (modified) (14 diffs)
- branches/1.2/lib/action/sfActionStack.class.php (modified) (1 diff)
- branches/1.2/lib/action/sfActionStackEntry.class.php (modified) (1 diff)
- branches/1.2/lib/action/sfActions.class.php (modified) (1 diff)
- branches/1.2/lib/action/sfComponent.class.php (modified) (10 diffs)
- branches/1.2/lib/addon/sfData.class.php (modified) (1 diff)
- branches/1.2/lib/autoload/sfAutoload.class.php (modified) (2 diffs)
- branches/1.2/lib/autoload/sfCoreAutoload.class.php (modified) (2 diffs)
- branches/1.2/lib/autoload/sfSimpleAutoload.class.php (modified) (6 diffs)
- branches/1.2/lib/cache/sfCache.class.php (modified) (10 diffs)
- branches/1.2/lib/cache/sfFileCache.class.php (modified) (5 diffs)
- branches/1.2/lib/cache/sfFunctionCache.class.php (modified) (1 diff)
- branches/1.2/lib/cache/sfMemcacheCache.class.php (modified) (2 diffs)
- branches/1.2/lib/cache/sfXCacheCache.class.php (modified) (3 diffs)
- branches/1.2/lib/command/sfAnsiColorFormatter.class.php (modified) (3 diffs)
- branches/1.2/lib/command/sfCommandApplication.class.php (modified) (4 diffs)
- branches/1.2/lib/command/sfCommandArgument.class.php (modified) (1 diff)
- branches/1.2/lib/command/sfCommandArgumentSet.class.php (modified) (2 diffs)
- branches/1.2/lib/command/sfCommandLogger.class.php (modified) (1 diff)
- branches/1.2/lib/command/sfCommandManager.class.php (modified) (2 diffs)
- branches/1.2/lib/command/sfCommandOption.class.php (modified) (1 diff)
- branches/1.2/lib/command/sfCommandOptionSet.class.php (modified) (4 diffs)
- branches/1.2/lib/command/sfFormatter.class.php (modified) (2 diffs)
- branches/1.2/lib/config/sfApplicationConfiguration.class.php (modified) (8 diffs)
- branches/1.2/lib/config/sfCacheConfigHandler.class.php (modified) (1 diff)
- branches/1.2/lib/config/sfCompileConfigHandler.class.php (modified) (1 diff)
- branches/1.2/lib/config/sfConfigCache.class.php (modified) (6 diffs)
- branches/1.2/lib/config/sfDefineEnvironmentConfigHandler.class.php (modified) (4 diffs)
- branches/1.2/lib/config/sfFilterConfigHandler.class.php (modified) (1 diff)
- branches/1.2/lib/config/sfLoader.class.php (modified) (1 diff)
- branches/1.2/lib/config/sfPluginConfiguration.class.php (modified) (2 diffs)
- branches/1.2/lib/config/sfProjectConfiguration.class.php (modified) (7 diffs)
- branches/1.2/lib/config/sfViewConfigHandler.class.php (modified) (2 diffs)
- branches/1.2/lib/config/sfYamlConfigHandler.class.php (modified) (3 diffs)
- branches/1.2/lib/controller/sfConsoleController.class.php (modified) (1 diff)
- branches/1.2/lib/controller/sfController.class.php (modified) (9 diffs)
- branches/1.2/lib/controller/sfWebController.class.php (modified) (1 diff)
- branches/1.2/lib/database/sfDatabaseManager.class.php (modified) (3 diffs)
- branches/1.2/lib/database/sfMySQLDatabase.class.php (modified) (3 diffs)
- branches/1.2/lib/database/sfMySQLiDatabase.class.php (modified) (2 diffs)
- branches/1.2/lib/database/sfPDODatabase.class.php (modified) (4 diffs)
- branches/1.2/lib/debug/sfDebug.class.php (modified) (1 diff)
- branches/1.2/lib/debug/sfWebDebug.class.php (modified) (3 diffs)
- branches/1.2/lib/debug/sfWebDebugPanelConfig.class.php (modified) (1 diff)
- branches/1.2/lib/event/sfEvent.class.php (modified) (5 diffs)
- branches/1.2/lib/event/sfEventDispatcher.class.php (modified) (6 diffs)
- branches/1.2/lib/exception/sfException.class.php (modified) (4 diffs)
- branches/1.2/lib/filter/sfCacheFilter.class.php (modified) (1 diff)
- branches/1.2/lib/filter/sfExecutionFilter.class.php (modified) (4 diffs)
- branches/1.2/lib/filter/sfFilter.class.php (modified) (1 diff)
- branches/1.2/lib/form/sfForm.class.php (modified) (15 diffs)
- branches/1.2/lib/form/sfFormField.class.php (modified) (4 diffs)
- branches/1.2/lib/form/sfFormFieldSchema.class.php (modified) (3 diffs)
- branches/1.2/lib/generator/sfAdminGenerator.class.php (modified) (10 diffs)
- branches/1.2/lib/generator/sfCrudGenerator.class.php (modified) (4 diffs)
- branches/1.2/lib/generator/sfGenerator.class.php (modified) (2 diffs)
- branches/1.2/lib/generator/sfGeneratorManager.class.php (modified) (2 diffs)
- branches/1.2/lib/generator/sfModelGenerator.class.php (modified) (3 diffs)
- branches/1.2/lib/generator/sfModelGeneratorConfiguration.class.php (modified) (1 diff)
- branches/1.2/lib/generator/sfModelGeneratorConfigurationField.class.php (modified) (1 diff)
- branches/1.2/lib/helper/AssetHelper.php (modified) (9 diffs)
- branches/1.2/lib/helper/DateFormHelper.php (modified) (14 diffs)
- branches/1.2/lib/helper/EscapingHelper.php (modified) (5 diffs)
- branches/1.2/lib/helper/FormHelper.php (modified) (9 diffs)
Legend:
- Unmodified
- Added
- Removed
- Modified
- Copied
- Moved
branches/1.1/lib/action/sfActionStack.class.php
r9044 r17858 28 28 * Adds an entry to the action stack. 29 29 * 30 * @param string $moduleName A module name31 * @param string $actionName An action name32 * @param sfAction $actionInstance An sfAction implementation instance30 * @param string $moduleName A module name 31 * @param string $actionName An action name 32 * @param sfAction $actionInstance An sfAction implementation instance 33 33 * 34 34 * @return sfActionStackEntry sfActionStackEntry instance branches/1.1/lib/action/sfActionStackEntry.class.php
r9044 r17858 30 30 * Class constructor. 31 31 * 32 * @param string $moduleName A module name33 * @param string $actionName An action name34 * @param sfAction $actionInstance An sfAction implementation instance32 * @param string $moduleName A module name 33 * @param string $actionName An action name 34 * @param sfAction $actionInstance An sfAction implementation instance 35 35 */ 36 36 public function __construct($moduleName, $actionName, $actionInstance) branches/1.1/lib/action/sfActions.class.php
r9044 r17858 27 27 * defined action name. 28 28 * 29 * @param sfRequest $request The current sfRequest object29 * @param sfRequest $request The current sfRequest object 30 30 * 31 31 * @return string A string containing the view name associated with this action branches/1.1/lib/autoload/sfAutoload.class.php
r12676 r17858 123 123 * Handles autoloading of classes that have been specified in autoload.yml. 124 124 * 125 * @param string $classA class name.125 * @param string $class A class name. 126 126 * 127 127 * @return boolean Returns true if the class has been loaded … … 148 148 * Tries to load a class that has been specified in autoload.yml. 149 149 * 150 * @param string $classA class name.150 * @param string $class A class name. 151 151 * 152 152 * @return boolean Returns true if the class has been loaded branches/1.1/lib/cache/sfCache.class.php
r9084 r17858 39 39 * Initializes this sfCache instance. 40 40 * 41 * @param array $options An array of options.41 * @param array $options An array of options. 42 42 * 43 43 * Available options: … … 67 67 * Gets the cache content for a given key. 68 68 * 69 * @param string $keyThe cache key70 * @param mixed $defaultThe default value is the key does not exist or not valid anymore71 * 72 * @return mixed The data of the cache69 * @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 73 73 */ 74 74 abstract public function get($key, $default = null); … … 77 77 * Returns true if there is a cache for the given key. 78 78 * 79 * @param string $keyThe cache key79 * @param string $key The cache key 80 80 * 81 81 * @return Boolean true if the cache exists, false otherwise … … 86 86 * Saves some data in the cache. 87 87 * 88 * @param string $key The cache key89 * @param mixed $data The data to put in cache90 * @param int $lifetime The lifetime88 * @param string $key The cache key 89 * @param mixed $data The data to put in cache 90 * @param int $lifetime The lifetime 91 91 * 92 92 * @return Boolean true if no problem … … 106 106 * Removes content from the cache that matches the given pattern. 107 107 * 108 * @param string$pattern The cache key pattern108 * @param string $pattern The cache key pattern 109 109 * 110 110 * @return Boolean true if no problem … … 117 117 * Cleans the cache. 118 118 * 119 * @param string $modeThe clean mode120 * sfCache::ALL: remove all keys (default)121 * sfCache::OLD: remove all expired keys119 * @param string $mode The clean mode 120 * sfCache::ALL: remove all keys (default) 121 * sfCache::OLD: remove all expired keys 122 122 * 123 123 * @return Boolean true if no problem … … 146 146 * Gets many keys at once. 147 147 * 148 * @param array $keys An array of keys148 * @param array $keys An array of keys 149 149 * 150 150 * @return array An associative array of data from cache … … 164 164 * Computes lifetime. 165 165 * 166 * @param integer $lifetime Lifetime in seconds166 * @param integer $lifetime Lifetime in seconds 167 167 * 168 168 * @return integer Lifetime in seconds … … 186 186 * Gets an option value. 187 187 * 188 * @param string $nameThe option name189 * @param mixed $defaultThe default value190 * 191 * @return mixed The option value188 * @param string $name The option name 189 * @param mixed $default The default value 190 * 191 * @return mixed The option value 192 192 */ 193 193 public function getOption($name, $default = null) … … 215 215 * - ** Matches one or more namespaces (foo:**:bar) 216 216 * 217 * @param string $patternA pattern217 * @param string $pattern A pattern 218 218 * 219 219 * @return string A regular expression branches/1.1/lib/cache/sfFunctionCache.class.php
r9084 r17858 48 48 * $cache->call(array($object, 'methodName'), array($arg1, $arg2)); 49 49 * 50 * @param mixed $callable A PHP callable51 * @param array $arguments An array of arguments to pass to the callable50 * @param mixed $callable A PHP callable 51 * @param array $arguments An array of arguments to pass to the callable 52 52 * 53 53 * @return mixed The result of the function/method branches/1.1/lib/cache/sfXCacheCache.class.php
r17478 r17858 51 51 $set = $this->getBaseValue($key); 52 52 53 if (!is_array($set) || !array_key_exists('data', $set))53 if (!is_array($set) || !array_key_exists('data', $set)) 54 54 { 55 55 … … 122 122 $set = $this->getBaseValue($key); 123 123 124 if (!is_array($set) || !array_key_exists('ctime', $set))124 if (!is_array($set) || !array_key_exists('ctime', $set)) 125 125 { 126 126 … … 139 139 $set = $this->getBaseValue($key); 140 140 141 if (!is_array($set) || !array_key_exists('timeout', $set))141 if (!is_array($set) || !array_key_exists('timeout', $set)) 142 142 { 143 143 branches/1.1/lib/command/sfCommandArgument.class.php
r9076 r17858 33 33 * Constructor. 34 34 * 35 * @param string $name The argument name36 * @param integer $mode The argument mode: self::REQUIRED or self::OPTIONAL37 * @param string $help A help text38 * @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) 39 39 */ 40 40 public function __construct($name, $mode = null, $help = '', $default = null) branches/1.1/lib/command/sfCommandArgumentSet.class.php
r9076 r17858 106 106 * Returns an argument by name. 107 107 * 108 * @param string $name The argument name108 * @param string $name The argument name 109 109 * 110 110 * @return sfCommandArgument A sfCommandArgument object … … 123 123 * Returns true if an argument object exists by name. 124 124 * 125 * @param string $nameThe argument name125 * @param string $name The argument name 126 126 * 127 127 * @return Boolean true if the argument object exists, false otherwise branches/1.1/lib/command/sfCommandLogger.class.php
r15485 r17858 21 21 * Initializes this logger. 22 22 * 23 * @param sfEventDispatcher $dispatcherA sfEventDispatcher instance24 * @param array $optionsAn array of options.23 * @param sfEventDispatcher $dispatcher A sfEventDispatcher instance 24 * @param array $options An array of options. 25 25 */ 26 26 public function initialize(sfEventDispatcher $dispatcher, $options = array()) branches/1.1/lib/command/sfCommandManager.class.php
r16343 r17858 206 206 * Returns the argument value for a given argument name. 207 207 * 208 * @param string $name The argument name208 * @param string $name The argument name 209 209 * 210 210 * @return mixed The argument value … … 233 233 * Returns the option value for a given option name. 234 234 * 235 * @param string $name The option name235 * @param string $name The option name 236 236 * 237 237 * @return mixed The option value branches/1.1/lib/command/sfCommandOption.class.php
r9076 r17858 35 35 * Constructor. 36 36 * 37 * @param string $name The option name38 * @param string $shortcut The shortcut (can be null)39 * @param integer $mode The option mode: self::PARAMETER_REQUIRED, self::PARAMETER_NONE or self::PARAMETER_OPTIONAL40 * @param string $help A help text41 * @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) 42 42 */ 43 43 public function __construct($name, $shortcut = null, $mode = null, $help = '', $default = null) branches/1.1/lib/command/sfCommandOptionSet.class.php
r9076 r17858 84 84 * Returns an option by name. 85 85 * 86 * @param string $name The option name86 * @param string $name The option name 87 87 * 88 88 * @return sfCommandOption A sfCommandOption object … … 101 101 * Returns true if an option object exists by name. 102 102 * 103 * @param string $nameThe option name103 * @param string $name The option name 104 104 * 105 105 * @return Boolean true if the option object exists, false otherwise … … 123 123 * Returns true if an option object exists by shortcut. 124 124 * 125 * @param string $nameThe option shortcut125 * @param string $name The option shortcut 126 126 * 127 127 * @return Boolean true if the option object exists, false otherwise … … 161 161 * Returns the option name given a shortcut. 162 162 * 163 * @param string $shortcut The shortcut163 * @param string $shortcut The shortcut 164 164 * 165 165 * @return string The option name branches/1.1/lib/command/sfFormatter.class.php
r9076 r17858 30 30 * Formats a text according to the given parameters. 31 31 * 32 * @param string $textThe test to style33 * @param mixed $parametersAn array of parameters34 * @param stream $streamA 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) 35 35 * 36 36 * @return string The formatted text … … 44 44 * Formats a message within a section. 45 45 * 46 * @param string $section The section name47 * @param string $text The text message48 * @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) 49 49 */ 50 50 public function formatSection($section, $text, $size = null) branches/1.1/lib/config/sfCacheConfigHandler.class.php
r9085 r17858 68 68 * Returns a single addCache statement. 69 69 * 70 * @param string $actionName The action name70 * @param string $actionName The action name 71 71 * 72 72 * @return string PHP code for the addCache statement branches/1.1/lib/config/sfCompileConfigHandler.class.php
r9085 r17858 67 67 68 68 // replace windows and mac format with unix format 69 $contents = str_replace("\r", "\n", $contents);69 $contents = str_replace("\r", "\n", $contents); 70 70 71 71 // replace multiple new lines with a single newline branches/1.1/lib/config/sfConfigCache.class.php
r16899 r17858 41 41 * Loads a configuration handler. 42 42 * 43 * @param string $handler The handler to use when parsing a configuration file44 * @param array $configs An array of absolute filesystem paths to configuration files45 * @param string $cache An absolute filesystem path to the cache file that will be written43 * @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 46 46 * 47 47 * @throws <b>sfConfigurationException</b> If a requested configuration file does not have an associated configuration handler … … 111 111 * Returns the config handler configured for the given name 112 112 * 113 * @param string $name The config handler name113 * @param string $name The config handler name 114 114 * 115 115 * @return sfConfigHandler A sfConfigHandler instance … … 135 135 * defined in the sfConfiguration::getConfigPaths() method. 136 136 * 137 * @param string $configPath A filesystem path to a configuration file138 * @param boolean $optional If true, config path does not need to exist137 * @param string $configPath A filesystem path to a configuration file 138 * @param boolean $optional If true, config path does not need to exist 139 139 * 140 140 * @return string An absolute filesystem path to the cache filename associated with this specified configuration file … … 236 236 * Imports a configuration file. 237 237 * 238 * @param string $config A filesystem path to a configuration file239 * @param bool $once Only allow this configuration file to be included once per request?240 * @param bool $optional Only include if true238 * @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 241 241 * 242 242 * @see checkConfig() … … 322 322 * Writes a cache file. 323 323 * 324 * @param string $config An absolute filesystem path to a configuration file325 * @param string $cache An absolute filesystem path to the cache file that will be written326 * @param string $data Data to be written to the cache file324 * @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 327 327 * 328 328 * @throws sfCacheException If the cache file cannot be written … … 367 367 * Registers a configuration handler. 368 368 * 369 * @param string $handler The handler to use when parsing a configuration file370 * @param class $class A configuration handler class371 * @param string $params An array of options for the handler class initialization369 * @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 372 372 */ 373 373 public function registerConfigHandler($handler, $class, $params = array()) branches/1.1/lib/config/sfDefineEnvironmentConfigHandler.class.php
r9085 r17858 21 21 * Executes this configuration handler. 22 22 * 23 * @param string $configFiles An absolute filesystem path to a configuration file23 * @param string $configFiles An absolute filesystem path to a configuration file 24 24 * 25 25 * @return string Data to be written to a cache file … … 70 70 * Gets values from the configuration array. 71 71 * 72 * @param string $prefix The prefix name73 * @param string $category The category name72 * @param string $prefix The prefix name 73 * @param string $category The category name 74 74 * @param mixed $keys The key/value array 75 75 * … … 102 102 * Fixes the category name and replaces constants in the value. 103 103 * 104 * @param string $category The category name105 * @param string $key The key name106 * @param string $value The value104 * @param string $category The category name 105 * @param string $key The key name 106 * @param string $value The value 107 107 * 108 108 * @return string Return the new key and value … … 116 116 * Fixes the category name. 117 117 * 118 * @param string $category The category name119 * @param string $prefix The prefix118 * @param string $category The category name 119 * @param string $prefix The prefix 120 120 * 121 121 * @return string The fixed category name branches/1.1/lib/config/sfFilterConfigHandler.class.php
r9400 r17858 130 130 * Adds a filter statement to the data. 131 131 * 132 * @param string $category The category name133 * @param string $class The filter class name134 * @param array $parameters Filter default parameters132 * @param string $category The category name 133 * @param string $class The filter class name 134 * @param array $parameters Filter default parameters 135 135 * 136 136 * @return string The PHP statement branches/1.1/lib/config/sfViewConfigHandler.class.php
r17714 r17858 155 155 * Adds a layout statement statement to the data. 156 156 * 157 * @param string $viewName The view name157 * @param string $viewName The view name 158 158 * 159 159 * @return string The PHP statement … … 209 209 * Adds http metas and metas statements to the data. 210 210 * 211 * @param string $viewName The view name211 * @param string $viewName The view name 212 212 * 213 213 * @return string The PHP statement branches/1.1/lib/config/sfYamlConfigHandler.class.php
r9085 r17858 26 26 * Parses an array of YAMLs files and merges them in one configuration array. 27 27 * 28 * @param array $configFiles An array of configuration file paths28 * @param array $configFiles An array of configuration file paths 29 29 * 30 30 * @return array A merged configuration array … … 74 74 * Merges configuration values for a given key and category. 75 75 * 76 * @param string $keyName The key name77 * @param string $category The category name76 * @param string $keyName The key name 77 * @param string $category The category name 78 78 * 79 79 * @return string The value associated with this key name and category … … 99 99 * Gets a configuration value for a given key and category. 100 100 * 101 * @param string $keyName The key name102 * @param string $category The category name103 * @param string $defaultValue The default value101 * @param string $keyName The key name 102 * @param string $category The category name 103 * @param string $defaultValue The default value 104 104 * 105 105 * @return string The value associated with this key name and category branches/1.1/lib/controller/sfConsoleController.class.php
r9078 r17858 20 20 * Dispatches a request. 21 21 * 22 * @param string $moduleName A module name23 * @param string $actionName An action name24 * @param array $parameters An associative array of parameters to be set22 * @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 25 25 */ 26 26 public function dispatch($moduleName, $actionName, $parameters = array()) branches/1.1/lib/database/sfMySQLiDatabase.class.php
r14869 r17858 20 20 * Returns the appropriate connect method. 21 21 * 22 * @param bool $persistent Whether persistent connections are use or not23 * The MySQLi driver does not support persistent24 * 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. 25 25 * 26 26 * @return string name of connect method … … 34 34 * Selects the database to be used in this connection 35 35 * 36 * @param string $database Name of database to be connected36 * @param string $database Name of database to be connected 37 37 * 38 38 * @return bool true if this was successful branches/1.1/lib/database/sfPDODatabase.class.php
r9372 r17858 67 67 68 68 // lets generate exceptions instead of silent failures 69 if (sfConfig::get('sf_debug'))69 if (sfConfig::get('sf_debug')) 70 70 { 71 71 $this->connection->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); … … 78 78 // compatability 79 79 $compatability = $this->getParameter('compat'); 80 if ($compatability)80 if ($compatability) 81 81 { 82 82 $this->connection->setAttribute(PDO::ATTR_CASE, PDO::CASE_NATURAL); … … 85 85 // nulls 86 86 $nulls = $this->getParameter('nulls'); 87 if ($nulls)87 if ($nulls) 88 88 { 89 89 $this->connection->setAttribute(PDO::ATTR_ORACLE_NULLS, PDO::NULL_EMPTY_STRING); … … 92 92 // auto commit 93 93 $autocommit = $this->getParameter('autocommit'); 94 if ($autocommit)94 if ($autocommit) 95 95 { 96 96 $this->connection->setAttribute(PDO::ATTR_AUTOCOMMIT, true); branches/1.1/lib/debug/sfDebug.class.php
r9079 r17858 48 48 if ($values['extensions']) 49 49 { 50 foreach ($values['extensions'] as $key => $extension)50 foreach ($values['extensions'] as $key => $extension) 51 51 { 52 52 $values['extensions'][$key] = phpversion($extension) ? sprintf('%s (%s)', $extension, phpversion($extension)) : $extension; branches/1.1/lib/event/sfEvent.class.php
r8698 r17858 29 29 * Constructs a new sfEvent. 30 30 * 31 * @param mixed $subjectThe subject32 * @param string $nameThe event name33 * @param array $parametersAn array of parameters31 * @param mixed $subject The subject 32 * @param string $name The event name 33 * @param array $parameters An array of parameters 34 34 */ 35 35 public function __construct($subject, $name, $parameters = array()) … … 114 114 * Returns true if the parameter exists (implements the ArrayAccess interface). 115 115 * 116 * @param string $nameThe parameter name116 * @param string $name The parameter name 117 117 * 118 118 * @return Boolean true if the parameter exists, false otherwise … … 126 126 * Returns a parameter value (implements the ArrayAccess interface). 127 127 * 128 * @param string $nameThe parameter name128 * @param string $name The parameter name 129 129 * 130 * @return mixed The parameter value130 * @return mixed The parameter value 131 131 */ 132 132 public function offsetGet($name) … … 143 143 * Sets a parameter (implements the ArrayAccess interface). 144 144 * 145 * @param string $nameThe parameter name146 * @param mixed $valueThe parameter value145 * @param string $name The parameter name 146 * @param mixed $value The parameter value 147 147 */ 148 148 public function offsetSet($name, $value) … … 154 154 * Removes a parameter (implements the ArrayAccess interface). 155 155 * 156 * @param string $name The parameter name156 * @param string $name The parameter name 157 157 */ 158 158 public function offsetUnset($name) branches/1.1/lib/event/sfEventDispatcher.class.php
r10632 r17858 27 27 * Connects a listener to a given event name. 28 28 * 29 * @param string $nameAn event name30 * @param mixed $listenerA PHP callable29 * @param string $name An event name 30 * @param mixed $listener A PHP callable 31 31 */ 32 32 public function connect($name, $listener) … … 43 43 * Disconnects a listener for a given event name. 44 44 * 45 * @param string $nameAn event name46 * @param mixed $listenerA PHP callable45 * @param string $name An event name 46 * @param mixed $listener A PHP callable 47 47 * 48 48 * @return mixed false if listener does not exist, null otherwise … … 84 84 * Notifies all listeners of a given event until one returns a non null value. 85 85 * 86 * @param sfEvent $event A sfEvent instance86 * @param sfEvent $event A sfEvent instance 87 87 * 88 88 * @return sfEvent The sfEvent instance … … 105 105 * Filters a value by calling all listeners of a given event. 106 106 * 107 * @param sfEvent $eventA sfEvent instance108 * @param mixed $valueThe value to be filtered107 * @param sfEvent $event A sfEvent instance 108 * @param mixed $value The value to be filtered 109 109 * 110 110 * @return sfEvent The sfEvent instance … … 125 125 * Returns true if the given event name has some listeners. 126 126 * 127 * @param string $nameThe event name127 * @param string $name The event name 128 128 * 129 129 * @return Boolean true if some listeners are connected, false otherwise … … 142 142 * Returns all listeners associated with a given event name. 143 143 * 144 * @param string $nameThe event name144 * @param string $name The event name 145 145 * 146 * @return array An array of listeners146 * @return array An array of listeners 147 147 */ 148 148 public function getListeners($name) branches/1.1/lib/filter/sfCacheFilter.class.php
r17468 r17858 29 29 * Initializes this Filter. 30 30 * 31 * @param sfContext $context The current application context32 * @param array $parameters An associative array of initialization parameters31 * @param sfContext $context The current application context 32 * @param array $parameters An associative array of initialization parameters 33 33 * 34 34 * @return bool true, if initialization completes successfully, otherwise false branches/1.1/lib/filter/sfExecutionFilter.class.php
r16250 r17858 59 59 * Handles the action. 60 60 * 61 * @param sfFilterChain $filterChainThe current filter chain62 * @param sfAction $actionInstanceAn sfAction instance61 * @param sfFilterChain $filterChain The current filter chain 62 * @param sfAction $actionInstance An sfAction instance 63 63 * 64 * @return string The view type64 * @return string The view type 65 65 */ 66 66 protected function handleAction($filterChain, $actionInstance) … … 80 80 * Executes the execute method of an action. 81 81 * 82 * @param sfAction $actionInstance An sfAction instance82 * @param sfAction $actionInstance An sfAction instance 83 83 * 84 * @return string The view type84 * @return string The view type 85 85 */ 86 86 protected function executeAction($actionInstance) … … 97 97 * Handles the view. 98 98 * 99 * @param sfFilterChain $filterChainThe current filter chain100 * @param sfAction $actionInstanceAn sfAction instance101 * @param string $viewNameThe view name99 * @param sfFilterChain $filterChain The current filter chain 100 * @param sfAction $actionInstance An sfAction instance 101 * @param string $viewName The view name 102 102 */ 103 103 protected function handleView($filterChain, $actionInstance, $viewName) … … 124 124 * - sfView::RENDER_DATA: View data populates the data presentation variable. 125 125 * 126 * @param string $moduleName The module name127 * @param string $actionName The action name128 * @param string $viewName The view name129 * @param array $viewAttributes An array of view attributes126 * @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 130 130 * 131 131 * @return string The view data branches/1.1/lib/filter/sfFilter.class.php
r9087 r17858 124 124 * <code>$this->getParameterHolder()->has()</code> 125 125 * 126 * @param string $name The key name126 * @param string $name The key name 127 127 * 128 128 * @return boolean true if the given key exists, false otherwise branches/1.1/lib/form/sfFormFieldSchema.class.php
r17587 r17858 27 27 * Constructor. 28 28 * 29 * @param sfWidgetFormSchema $widget A sfWidget instance30 * @param sfFormField $parent The sfFormField parent instance (null for the root widget)31 * @param string $name The field name32 * @param string $value The field value33 * @param sfValidatorError $error A sfValidatorError instance29 * @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 34 34 */ 35 35 public function __construct(sfWidgetFormSchema $widget, sfFormField $parent = null, $name, $value, sfValidatorError $error = null) … … 43 43 * Returns true if the bound field exists (implements the ArrayAccess interface). 44 44 * 45 * @param string $nameThe name of the bound field45 * @param string $name The name of the bound field 46 46 * 47 47 * @return Boolean true if the widget exists, false otherwise … … 55 55 * Returns the form field associated with the name (implements the ArrayAccess interface). 56 56 * 57 * @param string $name The offset of the value to get57 * @param string $name The offset of the value to get 58 58 * 59 59 * @return sfFormField A form field instance branches/1.1/lib/generator/sfGenerator.class.php
r9123 r17858 58 58 * Generates PHP files for a given module name. 59 59 * 60 * @param string $generatedModuleName The name of module name to generate61 * @param array $files A list of template files to generate60 * @param string $generatedModuleName The name of module name to generate 61 * @param array $files A list of template files to generate 62 62 */ 63 63 protected function generatePhpFiles($generatedModuleName, $files = array()) … … 72 72 * Evaluates a template file. 73 73 * 74 * @param string $templateFile The template file path74 * @param string $templateFile The template file path 75 75 * 76 76 * @return string The evaluated template branches/1.1/lib/helper/EscapingHelper.php
r9101 r17858 35 35 * Runs the PHP function htmlentities on the value passed. 36 36 * 37 * @param string $valuethe value to escape37 * @param string $value the value to escape 38 38 * @return string the escaped value 39 39 */ … … 50 50 * Runs the PHP function htmlspecialchars on the value passed. 51 51 * 52 * @param string $valuethe value to escape52 * @param string $value the value to escape 53 53 * @return string the escaped value 54 54 */ … … 66 66 * being to be able to specify that the value is not to be escaped in any way. 67 67 * 68 * @param string $valuethe value to escape68 * @param string $value the value to escape 69 69 * @return string the escaped value 70 70 */ … … 85 85 * that is ultimately not going to end up as text in an HTML document. 86 86 * 87 * @param string $valuethe value to escape87 * @param string $value the value to escape 88 88 * @return string the escaped value 89 89 */ … … 99 99 * JavaScript string. 100 100 * 101 * @param string $valuethe value to escape101 * @param string $value the value to escape 102 102 * @return string the escaped value 103 103 */ branches/1.2/lib/action/sfAction.class.php
r17749 r17858 78 78 * Forwards current action to the default 404 error action unless the specified condition is true. 79 79 * 80 * @param bool $conditionA condition that evaluates to true or false81 * @param string $messageMessage of the generated exception80 * @param bool $condition A condition that evaluates to true or false 81 * @param string $message Message of the generated exception 82 82 * 83 83 * @throws sfError404Exception … … 94 94 * Forwards current action to the default 404 error action if the specified condition is true. 95 95 * 96 * @param bool $conditionA condition that evaluates to true or false97 * @param string $messageMessage of the generated exception96 * @param bool $condition A condition that evaluates to true or false 97 * @param string $message Message of the generated exception 98 98 * 99 99 * @throws sfError404Exception … … 122 122 * This method stops the action. So, no code is executed after a call to this method. 123 123 * 124 * @param string $moduleA module name125 * @param string $actionAn action name124 * @param string $module A module name 125 * @param string $action An action name 126 126 * 127 127 * @throws sfStopException … … 144 144 * This method stops the action. So, no code is executed after a call to this method. 145 145 * 146 * @param bool $conditionA condition that evaluates to true or false147 * @param string $moduleA module name148 * @param string $actionAn action name146 * @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 149 149 * 150 150 * @throws sfStopException … … 163 163 * This method stops the action. So, no code is executed after a call to this method. 164 164 * 165 * @param bool $conditionA condition that evaluates to true or false166 * @param string $moduleA module name167 * @param string $actionAn action name165 * @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 168 168 * 169 169 * @throws sfStopException … … 186 186 * This method stops the action. So, no code is executed after a call to this method. 187 187 * 188 * @param string $urlUrl189 * @param string $statusCodeStatus code (default to 302)188 * @param string $url Url 189 * @param string $statusCode Status code (default to 302) 190 190 * 191 191 * @throws sfStopException … … 203 203 * This method stops the action. So, no code is executed after a call to this method. 204 204 * 205 * @param bool $condition A condition that evaluates to true or false206 * @param string $url Url207 * @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) 208 208 * 209 209 * @throws sfStopException … … 224 224 * This method stops the action. So, no code is executed after a call to this method. 225 225 * 226 * @param bool $condition A condition that evaluates to true or false227 * @param string $url Url228 * @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) 229 229 * 230 230 * @throws sfStopException … … 267 267 * available in the partial. 268 268 * 269 * @param string $templateName partial name270 * @param array $vars vars269 * @param string $templateName partial name 270 * @param array $vars vars 271 271 * 272 272 * @return string The partial content … … 288 288 * <code>return $this->renderPartial('foo/bar')</code> 289 289 * 290 * @param string $templateName partial name291 * @param array $vars vars290 * @param string $templateName partial name 291 * @param array $vars vars 292 292 * 293 293 * @return sfView::NONE … … 309 309 * available in the component. 310 310 * 311 * @param string$moduleName module name312 * @param string $componentNamecomponent name313 * @param array$vars vars311 * @param string $moduleName module name 312 * @param string $componentName component name 313 * @param array $vars vars 314 314 * 315 315 * @return string The component rendered content … … 331 331 * <code>return $this->renderComponent('foo', 'bar')</code> 332 332 * 333 * @param string$moduleName module name334 * @param string $componentNamecomponent name335 * @param array$vars vars333 * @param string $moduleName module name 334 * @param string $componentName component name 335 * @param array $vars vars 336 336 * 337 337 * @return sfView::NONE … … 461 461 * See 'Naming Conventions' in the 'Symfony View' documentation. 462 462 * 463 * @param string $name Template name464 * @param string $module The module (current if null)463 * @param string $name Template name 464 * @param string $module The module (current if null) 465 465 */ 466 466 public function setTemplate($name, $module = null) … … 544 544 * Returns a formatted message for a 404 error. 545 545 * 546 * @param string $message An error message (null by default)546 * @param string $message An error message (null by default) 547 547 * 548 548 * @return string The error message or a default one if null branches/1.2/lib/action/sfActionStack.class.php
r9044 r17858 28 28 * Adds an entry to the action stack. 29 29 * 30 * @param string $moduleName A module name31 * @param string $actionName An action name32 * @param sfAction $actionInstance An sfAction implementation instance30 * @param string $moduleName A module name 31 * @param string $actionName An action name 32 * @param sfAction $actionInstance An sfAction implementation instance 33 33 * 34 34 * @return sfActionStackEntry sfActionStackEntry instance branches/1.2/lib/action/sfActionStackEntry.class.php
r9044 r17858 30 30 * Class constructor. 31 31 * 32 * @param string $moduleName A module name33 * @param string $actionName An action name34 * @param sfAction $actionInstance An sfAction implementation instance32 * @param string $moduleName A module name 33 * @param string $actionName An action name 34 * @param sfAction $actionInstance An sfAction implementation instance 35 35 */ 36 36 public function __construct($moduleName, $actionName, $actionInstance) branches/1.2/lib/action/sfActions.class.php
r9044 r17858 27 27 * defined action name. 28 28 * 29 * @param sfRequest $request The current sfRequest object29 * @param sfRequest $request The current sfRequest object 30 30 * 31 31 * @return string A string containing the view name associated with this action branches/1.2/lib/action/sfComponent.class.php
r11599 r17858 71 71 * single product. 72 72 * 73 * @param sfRequest $request The current sfRequest object73 * @param sfRequest $request The current sfRequest object 74 74 * 75 75 * @return mixed A string containing the view name associated with this action … … 157 157 * <code>$this->getRequest()->getParameterHolder()->get($name)</code> 158 158 * 159 * @param string $nameThe parameter name160 * @param mixed $defaultThe default value if parameter does not exist159 * @param string $name The parameter name 160 * @param mixed $default The default value if parameter does not exist 161 161 * 162 162 * @return string The request parameter value … … 174 174 * <code>$this->getRequest()->getParameterHolder()->has($name)</code> 175 175 * 176 * @param string $nameThe parameter name176 * @param string $name The parameter name 177 177 * @return boolean true if the request parameter exists, false otherwise 178 178 */ … … 231 231 * <code>$this->getContext()->getRouting()->generate(...)</code> 232 232 * 233 * @param string The route name234 * @param array An array of parameters for the route235 * @param Boolean Whether to generate an absolute URL or not233 * @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 236 236 * 237 237 * @return string The URL … … 263 263 * value is escaped properly. 264 264 * 265 * @param string $name The variable name266 * @param mixed $value The variable value267 * @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) 268 268 */ 269 269 public function setVar($name, $value, $safe = false) … … 275 275 * Gets a variable set for the template. 276 276 * 277 * @param string $name The variable name 277 * @param string $name The variable name 278 * 278 279 * @return mixed The variable value 279 280 */ … … 300 301 * <code>$this->setVar('name', 'value')</code> 301 302 * 302 * @param string$key The variable name303 * @param string$value The variable value303 * @param string $key The variable name 304 * @param string $value The variable value 304 305 * 305 306 * @return boolean always true … … 319 320 * <code>$this->getVar('name')</code> 320 321 * 321 * @param string $key The variable name322 * @param string $key The variable name 322 323 * 323 324 * @return mixed The variable value … … 337 338 * <code>$this->getVarHolder()->has('name')</code> 338 339 * 339 * @param string $name The variable name340 * @param string $name The variable name 340 341 * 341 342 * @return boolean true if the variable is set … … 353 354 * <code>$this->getVarHolder()->remove('name')</code> 354 355 * 355 * @param string $name The variable Name356 * @param string $name The variable Name 356 357 */ 357 358 public function __unset($name) branches/1.2/lib/addon/sfData.class.php
r15803 r17858 89 89 * The returned array of files is sorted by alphabetical order. 90 90 * 91 * @param string|array $element A directory or file name or an array of directories and/or file names92 * If null, then defaults to 'sf_data_dir'/fixtures91 * @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 93 93 * 94 94 * @return array A list of *.yml files branches/1.2/lib/autoload/sfAutoload.class.php
r12676 r17858 123 123 * Handles autoloading of classes that have been specified in autoload.yml. 124 124 * 125 * @param string $classA class name.125 * @param string $class A class name. 126 126 * 127 127 * @return boolean Returns true if the class has been loaded … … 148 148 * Tries to load a class that has been specified in autoload.yml. 149 149 * 150 * @param string $classA class name.150 * @param string $class A class name. 151 151 * 152 152 * @return boolean Returns true if the class has been loaded branches/1.2/lib/autoload/sfCoreAutoload.class.php
r17692 r17858 89 89 * Handles autoloading of classes. 90 90 * 91 * @param string $classA class name.91 * @param string $class A class name. 92 92 * 93 93 * @return boolean Returns true if the class has been loaded … … 110 110 * @return base directory 111 111 */ 112 public function getBaseDir()113 {114 return $this->baseDir;115 }112 public function getBaseDir() 113 { 114 return $this->baseDir; 115 } 116 116 117 117 /** branches/1.2/lib/autoload/sfSimpleAutoload.class.php
r17749 r17858 47 47 * Retrieves the singleton instance of this class. 48 48 * 49 * @param string $cacheFileThe file path to save the cache50 * 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. 52 52 */ 53 53 static public function getInstance($cacheFile = null) … … 64 64 * Register sfSimpleAutoload in spl autoloader. 65 65 * 66 * @return void 66 * @return void 67 67 */ 68 68 static public function register() … … 101 101 * Handles autoloading of classes. 102 102 * 103 * @param string $class A class name.103 * @param string $class A class name. 104 104 * 105 105 * @return boolean Returns true if the class has been loaded … … 161 161 public function reload() 162 162 { 163 $this->classes = array();163 $this->classes = array(); 164 164 $this->cacheLoaded = false; 165 165 … … 174 174 } 175 175 176 $this->cacheLoaded = true;176 $this->cacheLoaded = true; 177 177 $this->cacheChanged = true; 178 178 } … … 196 196 $finder = sfFinder::type('file')->follow_link()->name('*'.$ext); 197 197 198 if ($dirs = glob($dir))198 if ($dirs = glob($dir)) 199 199 { 200 200 foreach ($dirs as $dir) branches/1.2/lib/cache/sfCache.class.php
r9084 r17858 39 39 * Initializes this sfCache instance. 40 40 * 41 * @param array $options An array of options.41 * @param array $options An array of options. 42 42 * 43 43 * Available options: … … 67 67 * Gets the cache content for a given key. 68 68 * 69 * @param string $keyThe cache key70 * @param mixed $defaultThe default value is the key does not exist or not valid anymore71 * 72 * @return mixed The data of the cache69 * @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 73 73 */ 74 74 abstract public function get($key, $default = null); … … 77 77 * Returns true if there is a cache for the given key. 78 78 * 79 * @param string $keyThe cache key79 * @param string $key The cache key 80 80 * 81 81 * @return Boolean true if the cache exists, false otherwise … … 86 86 * Saves some data in the cache. 87 87 * 88 * @param string $key The cache key89 * @param mixed $data The data to put in cache90 * @param int $lifetime The lifetime88 * @param string $key The cache key 89 * @param mixed $data The data to put in cache 90 * @param int $lifetime The lifetime 91 91 * 92 92 * @return Boolean true if no problem … … 106 106 * Removes content from the cache that matches the given pattern. 107 107 * 108 * @param string$pattern The cache key pattern108 * @param string $pattern The cache key pattern 109 109 * 110 110 * @return Boolean true if no problem … … 117 117 * Cleans the cache. 118 118 * 119 * @param string $modeThe clean mode120 * sfCache::ALL: remove all keys (default)121 * sfCache::OLD: remove all expired keys119 * @param string $mode The clean mode 120 * sfCache::ALL: remove all keys (default) 121 * sfCache::OLD: remove all expired keys 122 122 * 123 123 * @return Boolean true if no problem … … 146 146 * Gets many keys at once. 147 147 * 148 * @param array $keys An array of keys148 * @param array $keys An array of keys 149 149 * 150 150 * @return array An associative array of data from cache … … 164 164 * Computes lifetime. 165 165 * 166 * @param integer $lifetime Lifetime in seconds166 * @param integer $lifetime Lifetime in seconds 167 167 * 168 168 * @return integer Lifetime in seconds … … 186 186 * Gets an option value. 187 187 * 188 * @param string $nameThe option name189 * @param mixed $defaultThe default value190 * 191 * @return mixed The option value188 * @param string $name The option name 189 * @param mixed $default The default value 190 * 191 * @return mixed The option value 192 192 */ 193 193 public function getOption($name, $default = null) … … 215 215 * - ** Matches one or more namespaces (foo:**:bar) 216 216 * 217 * @param string $patternA pattern217 * @param string $pattern A pattern 218 218 * 219 219 * @return string A regular expression branches/1.2/lib/cache/sfFileCache.class.php
r16899 r17858 61 61 $data = $this->read($file_path, self::READ_DATA); 62 62 63 if ($data[self::READ_DATA] === null) { 63 if ($data[self::READ_DATA] === null) 64 { 64 65 return $default; 65 66 } … … 204 205 * Converts a cache key to a full path. 205 206 * 206 * @param string $keyThe cache key207 * @param string $key The cache key 207 208 * 208 209 * @return string The full path to the cache file … … 235 236 @flock($fp, LOCK_SH); 236 237 $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 { 238 240 if ($type & self::READ_LAST_MODIFIED) 239 241 { … … 247 249 $data[self::READ_DATA] = @fread($fp, $length); 248 250 } 249 } else { 251 } 252 else 253 { 250 254 $data[self::READ_LAST_MODIFIED] = null; 251 255 $data[self::READ_DATA] = null; … … 260 264 * Writes the given data in the cache file. 261 265 * 262 * @param string $pathThe file path263 * @param string $dataThe data to put in cache264 * @param integer $timeoutThe timeout timestamp266 * @param string $path The file path 267 * @param string $data The data to put in cache 268 * @param integer $timeout The timeout timestamp 265 269 * 266 270 * @return boolean true if ok, otherwise false branches/1.2/lib/cache/sfFunctionCache.class.php
r9084 r17858 48 48 * $cache->call(array($object, 'methodName'), array($arg1, $arg2)); 49 49 * 50 * @param mixed $callable A PHP callable51 * @param array $arguments An array of arguments to pass to the callable50 * @param mixed $callable A PHP callable 51 * @param array $arguments An array of arguments to pass to the callable 52 52 * 53 53 * @return mixed The result of the function/method branches/1.2/lib/cache/sfMemcacheCache.class.php
r17749 r17858 208 208 * Gets metadata about a key in the cache. 209 209 * 210 * @param string $key A cache key211 * 212 * @return array An array of metadata information210 * @param string $key A cache key 211 * 212 * @return array An array of metadata information 213 213 */ 214 214 protected function getMetadata($key) … … 220 220 * Stores metadata about a key in the cache. 221 221 * 222 * @param string $key A cache key223 * @param string $lifetime The lifetime222 * @param string $key A cache key 223 * @param string $lifetime The lifetime 224 224 */ 225 225 protected function setMetadata($key, $lifetime) branches/1.2/lib/cache/sfXCacheCache.class.php
r17478 r17858 51 51 $set = $this->getBaseValue($key); 52 52 53 if (!is_array($set) || !array_key_exists('data', $set))53 if (!is_array($set) || !array_key_exists('data', $set)) 54 54 { 55 55 … … 122 122 $set = $this->getBaseValue($key); 123 123 124 if (!is_array($set) || !array_key_exists('ctime', $set))124 if (!is_array($set) || !array_key_exists('ctime', $set)) 125 125 { 126 126 … … 139 139 $set = $this->getBaseValue($key); 140 140 141 if (!is_array($set) || !array_key_exists('timeout', $set))141 if (!is_array($set) || !array_key_exists('timeout', $set)) 142 142 { 143 143 branches/1.2/lib/command/sfAnsiColorFormatter.class.php
r11301 r17858 44 44 * Formats a text according to the given style or parameters. 45 45 * 46 * @param string $text The test to style47 * @param mixed $parameters An array of options or a style name48 * @param resource $stream The stream to format for46 * @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 49 49 * 50 50 * @return string The styled text … … 90 90 * Formats a message within a section. 91 91 * 92 * @param string $sectionThe section name92 * @param string $section The section name 93 93 * @param string $text The text message 94 94 * @param integer $size The maximum size allowed for a line (65 by default) … … 137 137 * - non tty consoles 138 138 * 139 * @param mixed $streamA stream139 * @param mixed $stream A stream 140 140 * 141 141 * @return Boolean true if the stream supports colorization, false otherwise branches/1.2/lib/command/sfCommandApplication.class.php
r11505 r17858 36 36 * Constructor. 37 37 * 38 * @param sfEventDispatcher $dispatcher A sfEventDispatcher instance39 * @param sfFormatter $formatter A sfFormatter instance40 * @param array $options An array of options38 * @param sfEventDispatcher $dispatcher A sfEventDispatcher instance 39 * @param sfFormatter $formatter A sfFormatter instance 40 * @param array $options An array of options 41 41 */ 42 42 public function __construct(sfEventDispatcher $dispatcher, sfFormatter $formatter, $options = array()) … … 61 61 * Returns the value of a given option. 62 62 * 63 * @param string $nameThe option name64 * 65 * @return mixed The option value63 * @param string $name The option name 64 * 65 * @return mixed The option value 66 66 */ 67 67 public function getOption($name) … … 85 85 * If you pass null, this method will register all available tasks. 86 86 * 87 * @param array $tasksAn array of tasks87 * @param array $tasks An array of tasks 88 88 */ 89 89 public function registerTasks($tasks = null) … … 405 405 * Gets a task from a task name or a shortcut. 406 406 * 407 * @param string $nameThe task name or a task shortcut407 * @param string $name The task name or a task shortcut 408 408 * 409 409 * @return sfTask A sfTask object branches/1.2/lib/command/sfCommandArgument.class.php
r9076 r17858 33 33 * Constructor. 34 34 * 35 * @param string $name The argument name36 * @param integer $mode The argument mode: self::REQUIRED or self::OPTIONAL37 * @param string $help A help text38 * @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) 39 39 */ 40 40 public function __construct($name, $mode = null, $help = '', $default = null) branches/1.2/lib/command/sfCommandArgumentSet.class.php
r9076 r17858 106 106 * Returns an argument by name. 107 107 * 108 * @param string $name The argument name108 * @param string $name The argument name 109 109 * 110 110 * @return sfCommandArgument A sfCommandArgument object … … 123 123 * Returns true if an argument object exists by name. 124 124 * 125 * @param string $nameThe argument name125 * @param string $name The argument name 126 126 * 127 127 * @return Boolean true if the argument object exists, false otherwise branches/1.2/lib/command/sfCommandLogger.class.php
r15485 r17858 21 21 * Initializes this logger. 22 22 * 23 * @param sfEventDispatcher $dispatcherA sfEventDispatcher instance24 * @param array $optionsAn array of options.23 * @param sfEventDispatcher $dispatcher A sfEventDispatcher instance 24 * @param array $options An array of options. 25 25 */ 26 26 public function initialize(sfEventDispatcher $dispatcher, $options = array()) branches/1.2/lib/command/sfCommandManager.class.php
r16343 r17858 206 206 * Returns the argument value for a given argument name. 207 207 * 208 * @param string $name The argument name208 * @param string $name The argument name 209 209 * 210 210 * @return mixed The argument value … … 233 233 * Returns the option value for a given option name. 234 234 * 235 * @param string $name The option name235 * @param string $name The option name 236 236 * 237 237 * @return mixed The option value branches/1.2/lib/command/sfCommandOption.class.php
r9076 r17858 35 35 * Constructor. 36 36 * 37 * @param string $name The option name38 * @param string $shortcut The shortcut (can be null)39 * @param integer $mode The option mode: self::PARAMETER_REQUIRED, self::PARAMETER_NONE or self::PARAMETER_OPTIONAL40 * @param string $help A help text41 * @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) 42 42 */ 43 43 public function __construct($name, $shortcut = null, $mode = null, $help = '', $default = null) branches/1.2/lib/command/sfCommandOptionSet.class.php
r9076 r17858 84 84 * Returns an option by name. 85 85 * 86 * @param string $name The option name86 * @param string $name The option name 87 87 * 88 88 * @return sfCommandOption A sfCommandOption object … … 101 101 * Returns true if an option object exists by name. 102 102 * 103 * @param string $nameThe option name103 * @param string $name The option name 104 104 * 105 105 * @return Boolean true if the option object exists, false otherwise … … 123 123 * Returns true if an option object exists by shortcut. 124 124 * 125 * @param string $nameThe option shortcut125 * @param string $name The option shortcut 126 126 * 127 127 * @return Boolean true if the option object exists, false otherwise … … 161 161 * Returns the option name given a shortcut. 162 162 * 163 * @param string $shortcut The shortcut163 * @param string $shortcut The shortcut 164 164 * 165 165 * @return string The option name branches/1.2/lib/command/sfFormatter.class.php
r14274 r17858 30 30 * Formats a text according to the given parameters. 31 31 * 32 * @param string $textThe test to style33 * @param mixed $parametersAn array of parameters34 * @param stream $streamA 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) 35 35 * 36 36 * @return string The formatted text … … 44 44 * Formats a message within a section. 45 45 * 46 * @param string $section The section name47 * @param string $text The text message48 * @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) 49 49 */ 50 50 public function formatSection($section, $text, $size = null) branches/1.2/lib/config/sfApplicationConfiguration.class.php
r13947 r17858 33 33 * Constructor. 34 34 * 35 * @param string $environment The environment name36 * @param Boolean $debug true to enable debug mode37 * @param string $rootDir The project root directory38 * @param sfEventDispatcher $dispatcher An event dispatcher35 * @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 39 39 */ 40 40 public function __construct($environment, $debug, $rootDir = null, sfEventDispatcher $dispatcher = null) … … 182 182 * Adds enabled plugins to autoload config. 183 183 * 184 * @param sfEvent $event185 * @param array $config184 * @param sfEvent $event 185 * @param array $config 186 186 * 187 * @return array187 * @return array 188 188 */ 189 189 public function filterAutoloadConfig(sfEvent $event, array $config) … … 397 397 * Gets the helper directories for a given module name. 398 398 * 399 * @param string $moduleName The module name400 * 401 * @return array An array of directories399 * @param string $moduleName The module name 400 * 401 * @return array An array of directories 402 402 */ 403 403 public function getHelperDirs($moduleName = '') … … 426 426 * Gets the template directory to use for a given module and template file. 427 427 * 428 * @param string $moduleName The module name429 * @param string $templateFile The template file428 * @param string $moduleName The module name 429 * @param string $templateFile The template file 430 430 * 431 431 * @return string A template directory … … 447 447 * Gets the template to use for a given module and template file. 448 448 * 449 * @param string $moduleName The module name450 * @param string $templateFile The template file449 * @param string $moduleName The module name 450 * @param string $templateFile The template file 451 451 * 452 452 * @return string A template path … … 462 462 * Gets the decorator directories. 463 463 * 464 * @return array An array of the decorator directories464 * @return array An array of the decorator directories 465 465 */ 466 466 public function getDecoratorDirs() … … 472 472 * Gets the decorator directory for a given template. 473 473 * 474 * @param string $template The template file474 * @param string $template The template file 475 475 * 476 476 * @return string A template directory … … 591 591 * Loads helpers. 592 592 * 593 * @param array $helpers An array of helpers to load594 * @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) 595 595 */ 596 596 public function loadHelpers($helpers, $moduleName = '') branches/1.2/lib/config/sfCacheConfigHandler.class.php
r9085 r17858 68 68 * Returns a single addCache statement. 69 69 * 70 * @param string $actionName The action name70 * @param string $actionName The action name 71 71 * 72 72 * @return string PHP code for the addCache statement branches/1.2/lib/config/sfCompileConfigHandler.class.php
r13547 r17858 67 67 68 68 // replace windows and mac format with unix format 69 $contents = str_replace("\r", "\n", $contents);69 $contents = str_replace("\r", "\n", $contents); 70 70 71 71 // replace multiple new lines with a single newline branches/1.2/lib/config/sfConfigCache.class.php
r16899 r17858 41 41 * Loads a configuration handler. 42 42 * 43 * @param string $handler The handler to use when parsing a configuration file44 * @param array $configs An array of absolute filesystem paths to configuration files45 * @param string $cache An absolute filesystem path to the cache file that will be written43 * @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 46 46 * 47 47 * @throws <b>sfConfigurationException</b> If a requested configuration file does not have an associated configuration handler … … 111 111 * Returns the config handler configured for the given name 112 112 * 113 * @param string $name The config handler name113 * @param string $name The config handler name 114 114 * 115 115 * @return sfConfigHandler A sfConfigHandler instance … … 135 135 * defined in the sfConfiguration::getConfigPaths() method. 136 136 * 137 * @param string $configPath A filesystem path to a configuration file138 * @param boolean $optional If true, config path does not need to exist137 * @param string $configPath A filesystem path to a configuration file 138 * @param boolean $optional If true, config path does not need to exist 139 139 * 140 140 * @return string An absolute filesystem path to the cache filename associated with this specified configuration file … … 236 236 * Imports a configuration file. 237 237 * 238 * @param string $config A filesystem path to a configuration file239 * @param bool $once Only allow this configuration file to be included once per request?240 * @param bool $optional Only include if true238 * @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 241 241 * 242 242 * @see checkConfig() … … 322 322 * Writes a cache file. 323 323 * 324 * @param string $config An absolute filesystem path to a configuration file325 * @param string $cache An absolute filesystem path to the cache file that will be written326 * @param string $data Data to be written to the cache file324 * @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 327 327 * 328 328 * @throws sfCacheException If the cache file cannot be written … … 367 367 * Registers a configuration handler. 368 368 * 369 * @param string $handler The handler to use when parsing a configuration file370 * @param class $class A configuration handler class371 * @param string $params An array of options for the handler class initialization369 * @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 372 372 */ 373 373 public function registerConfigHandler($handler, $class, $params = array()) branches/1.2/lib/config/sfDefineEnvironmentConfigHandler.class.php
r9085 r17858 21 21 * Executes this configuration handler. 22 22 * 23 * @param string $configFiles An absolute filesystem path to a configuration file23 * @param string $configFiles An absolute filesystem path to a configuration file 24 24 * 25 25 * @return string Data to be written to a cache file … … 70 70 * Gets values from the configuration array. 71 71 * 72 * @param string $prefix The prefix name73 * @param string $category The category name72 * @param string $prefix The prefix name 73 * @param string $category The category name 74 74 * @param mixed $keys The key/value array 75 75 * … … 102 102 * Fixes the category name and replaces constants in the value. 103 103 * 104 * @param string $category The category name105 * @param string $key The key name106 * @param string $value The value104 * @param string $category The category name 105 * @param string $key The key name 106 * @param string $value The value 107 107 * 108 108 * @return string Return the new key and value … … 116 116 * Fixes the category name. 117 117 * 118 * @param string $category The category name119 * @param string $prefix The prefix118 * @param string $category The category name 119 * @param string $prefix The prefix 120 120 * 121 121 * @return string The fixed category name branches/1.2/lib/config/sfFilterConfigHandler.class.php
r17749 r17858 130 130 * Adds a filter statement to the data. 131 131 * 132 * @param string $category The category name133 * @param string $class The filter class name134 * @param array $parameters Filter default parameters132 * @param string $category The category name 133 * @param string $class The filter class name 134 * @param array $parameters Filter default parameters 135 135 * 136 136 * @return string The PHP statement branches/1.2/lib/config/sfLoader.class.php
r11783 r17858 40 40 * Loads helpers. 41 41 * 42 * @param array $helpers An array of helpers to load43 * @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) 44 44 * 45 45 * @throws sfViewException branches/1.2/lib/config/sfPluginConfiguration.class.php
r17749 r17858 28 28 * Constructor. 29 29 * 30 * @param sfProjectConfiguration $configuration31 * @param string $rootDirThe plugin root directory32 * @param string $nameThe plugin name30 * @param sfProjectConfiguration $configuration The project configuration 31 * @param string $rootDir The plugin root directory 32 * @param string $name The plugin name 33 33 */ 34 34 public function __construct(sfProjectConfiguration $configuration, $rootDir = null, $name = null) … … 137 137 * @param array $config 138 138 * 139 * @return array139 * @return array 140 140 */ 141 141 public function filterAutoloadConfig(sfEvent $event, array $config) branches/1.2/lib/config/sfProjectConfiguration.class.php
r17749 r17858 34 34 * Constructor. 35 35 * 36 * @param string $rootDir The project root directory37 * @param sfEventDispatcher $dispatcher The event dispatcher36 * @param string $rootDir The project root directory 37 * @param sfEventDispatcher $dispatcher The event dispatcher 38 38 */ 39 39 public function __construct($rootDir = null, sfEventDispatcher $dispatcher = null) … … 184 184 * Gets directories where template files are stored for a generator class and a specific theme. 185 185 * 186 * @param string $class The generator class name187 * @param string $theme The theme name186 * @param string $class The generator class name 187 * @param string $theme The theme name 188 188 * 189 189 * @return array An array of directories … … 202 202 * Gets directories where the skeleton is stored for a generator class and a specific theme. 203 203 * 204 * @param string $class The generator class name205 * @param string $theme The theme name204 * @param string $class The generator class name 205 * @param string $theme The theme name 206 206 * 207 207 * @return array An array of directories … … 220 220 * Gets the template to use for a generator class. 221 221 * 222 * @param string $class The generator class name223 * @param string $theme The theme name224 * @param string $path The template path222 * @param string $class The generator class name 223 * @param string $theme The theme name 224 * @param string $path The template path 225 225 * 226 226 * @return string A template path … … 389 389 * Gets the paths plugin sub-directories, minding overloaded plugins. 390 390 * 391 * @param string $subPath The subdirectory to look for391 * @param string $subPath The subdirectory to look for 392 392 * 393 393 * @return array The plugin paths. … … 489 489 * Returns the configuration for the requested plugin. 490 490 * 491 * @param string $name492 * 493 * @return sfPluginConfiguration491 * @param string $name 492 * 493 * @return sfPluginConfiguration 494 494 */ 495 495 public function getPluginConfiguration($name) … … 548 548 * Returns a sfApplicationConfiguration configuration for a given application. 549 549 * 550 * @param string $application An application name551 * @param string $environment The environment name552 * @param Boolean $debug true to enable debug mode553 * @param string $rootDir The project root directory554 * @param sfEventDispatcher $dispatcher An event dispatcher550 * @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 555 555 * 556 556 * @return sfApplicationConfiguration A sfApplicationConfiguration instance branches/1.2/lib/config/sfViewConfigHandler.class.php
r17714 r17858 155 155 * Adds a layout statement statement to the data. 156 156 * 157 * @param string $viewName The view name157 * @param string $viewName The view name 158 158 * 159 159 * @return string The PHP statement … … 209 209 * Adds http metas and metas statements to the data. 210 210 * 211 * @param string $viewName The view name211 * @param string $viewName The view name 212 212 * 213 213 * @return string The PHP statement branches/1.2/lib/config/sfYamlConfigHandler.class.php
r9085 r17858 26 26 * Parses an array of YAMLs files and merges them in one configuration array. 27 27 * 28 * @param array $configFiles An array of configuration file paths28 * @param array $configFiles An array of configuration file paths 29 29 * 30 30 * @return array A merged configuration array … … 74 74 * Merges configuration values for a given key and category. 75 75 * 76 * @param string $keyName The key name77 * @param string $category The category name76 * @param string $keyName The key name 77 * @param string $category The category name 78 78 * 79 79 * @return string The value associated with this key name and category … … 99 99 * Gets a configuration value for a given key and category. 100 100 * 101 * @param string $keyName The key name102 * @param string $category The category name103 * @param string $defaultValue The default value101 * @param string $keyName The key name 102 * @param string $category The category name 103 * @param string $defaultValue The default value 104 104 * 105 105 * @return string The value associated with this key name and category branches/1.2/lib/controller/sfConsoleController.class.php
r9078 r17858 20 20 * Dispatches a request. 21 21 * 22 * @param string $moduleName A module name23 * @param string $actionName An action name24 * @param array $parameters An associative array of parameters to be set22 * @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 25 25 */ 26 26 public function dispatch($moduleName, $actionName, $parameters = array()) branches/1.2/lib/controller/sfController.class.php
r17749 r17858 68 68 * Indicates whether or not a module has a specific action. 69 69 * 70 * @param string $moduleName A module name71 * @param string $actionName An action name70 * @param string $moduleName A module name 71 * @param string $actionName An action name 72 72 * 73 73 * @return bool true, if the action exists, otherwise false … … 82 82 * in the case of {@link getController()}). 83 83 * 84 * @param string $moduleName The name of the module85 * @param string $controllerName The name of the controller within the module86 * @param string $extension Either 'action' or 'component' depending on the type of controller to look for87 * @param boolean $throwExceptions Whether to throw exceptions if the controller doesn't exist84 * @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 88 88 * 89 89 * @throws sfConfigurationException thrown if the module is not enabled … … 169 169 * Forwards the request to another action. 170 170 * 171 * @param string $moduleNameA module name172 * @param string $actionNameAn action name171 * @param string $moduleName A module name 172 * @param string $actionName An action name 173 173 * 174 174 * @throws <b>sfConfigurationException</b> If an invalid configuration setting has been found … … 263 263 * Retrieves an sfAction implementation instance. 264 264 * 265 * @param string $moduleNameA module name266 * @param string $actionNameAn action name265 * @param string $moduleName A module name 266 * @param string $actionName An action name 267 267 * 268 268 * @return sfAction An sfAction implementation instance, if the action exists, otherwise null … … 276 276 * Retrieves a sfComponent implementation instance. 277 277 * 278 * @param string$moduleName A module name279 * @param string$componentName A component name278 * @param string $moduleName A module name 279 * @param string $componentName A component name 280 280 * 281 281 * @return sfComponent A sfComponent implementation instance, if the component exists, otherwise null … … 289 289 * Retrieves a controller implementation instance. 290 290 * 291 * @param string $moduleName A module name292 * @param string $controllerName A component name293 * @param string $extension Either 'action' or 'component' depending on the type of controller to look for291 * @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 294 294 * 295 295 * @return object A controller implementation instance, if the controller exists, otherwise null … … 343 343 * Retrieves a sfView implementation instance. 344 344 * 345 * @param string $moduleName A module name346 * @param string $actionName An action name347 * @param string $viewName A view name345 * @param string $moduleName A module name 346 * @param string $actionName An action name 347 * @param string $viewName A view name 348 348 * 349 349 * @return sfView A sfView implementation instance, if the view exists, otherwise null … … 382 382 * This methods calls a module/action with the sfMailView class. 383 383 * 384 * @param string $moduleA module name385 * @param string $actionAn action name384 * @param string $module A module name 385 * @param string $action An action name 386 386 * 387 387 * @return string The generated mail content … … 403 403 * Returns the rendered view presentation of a given module/action. 404 404 * 405 * @param string $moduleA module name406 * @param string $actionAn action name407 * @param string $viewNameA View class name405 * @param string $module A module name 406 * @param string $action An action name 407 * @param string $viewName A View class name 408 408 * 409 409 * @return string The generated content branches/1.2/lib/controller/sfWebController.class.php
r16711 r17858 168 168 * Redirects the request to another URL. 169 169 * 170 * @param string $url An existing URL171 * @param int $delay A delay in seconds before redirecting. This is only needed on172 * browsers that do not support HTTP headers173 * @param int $statusCode The status code170 * @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 174 174 */ 175 175 public function redirect($url, $delay = 0, $statusCode = 302) branches/1.2/lib/database/sfDatabaseManager.class.php
r17749 r17858 45 45 * Initializes this sfDatabaseManager object 46 46 * 47 * @param sfProjectConfiguration $configuration A sfProjectConfiguration instance47 * @param sfProjectConfiguration $configuration A sfProjectConfiguration instance 48 48 * 49 49 * @return bool true, if initialization completes successfully, otherwise false … … 82 82 * Sets a database connection. 83 83 * 84 * @param string $name The database name85 * @param sfDatabase $database A sfDatabase instance84 * @param string $name The database name 85 * @param sfDatabase $database A sfDatabase instance 86 86 */ 87 87 public function setDatabase($name, sfDatabase $database) … … 93 93 * Retrieves the database connection associated with this sfDatabase implementation. 94 94 * 95 * @param string $name A database name95 * @param string $name A database name 96 96 * 97 97 * @return mixed A Database instance branches/1.2/lib/database/sfMySQLDatabase.class.php
r12763 r17858 114 114 115 115 // set encoding if specified 116 if ($encoding)116 if ($encoding) 117 117 { 118 118 @mysql_query("SET NAMES '".$encoding."'", $this->connection); … … 127 127 * Returns the appropriate connect method. 128 128 * 129 * @param bool $persistent wether persistent connections are use or not129 * @param bool $persistent wether persistent connections are use or not 130 130 * @return string name of connect method. 131 131 */ … … 138 138 * Selects the database to be used in this connection 139 139 * 140 * @param string $database Name of database to be connected140 * @param string $database Name of database to be connected 141 141 * 142 142 * @return bool true if this was successful branches/1.2/lib/database/sfMySQLiDatabase.class.php
r14869 r17858 20 20 * Returns the appropriate connect method. 21 21 * 22 * @param bool $persistent Whether persistent connections are use or not23 * The MySQLi driver does not support persistent24 * 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. 25 25 * 26 26 * @return string name of connect method … … 34 34 * Selects the database to be used in this connection 35 35 * 36 * @param string $database Name of database to be connected36 * @param string $database Name of database to be connected 37 37 * 38 38 * @return bool true if this was successful branches/1.2/lib/database/sfPDODatabase.class.php
r9372 r17858 67 67 68 68 // lets generate exceptions instead of silent failures 69 if (sfConfig::get('sf_debug'))69 if (sfConfig::get('sf_debug')) 70 70 { 71 71 $this->connection->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); … … 78 78 // compatability 79 79 $compatability = $this->getParameter('compat'); 80 if ($compatability)80 if ($compatability) 81 81 { 82 82 $this->connection->setAttribute(PDO::ATTR_CASE, PDO::CASE_NATURAL); … … 85 85 // nulls 86 86 $nulls = $this->getParameter('nulls'); 87 if ($nulls)87 if ($nulls) 88 88 { 89 89 $this->connection->setAttribute(PDO::ATTR_ORACLE_NULLS, PDO::NULL_EMPTY_STRING); … … 92 92 // auto commit 93 93 $autocommit = $this->getParameter('autocommit'); 94 if ($autocommit)94 if ($autocommit) 95 95 { 96 96 $this->connection->setAttribute(PDO::ATTR_AUTOCOMMIT, true); branches/1.2/lib/debug/sfDebug.class.php
r13931 r17858 48 48 if ($values['extensions']) 49 49 { 50 foreach ($values['extensions'] as $key => $extension)50 foreach ($values['extensions'] as $key => $extension) 51 51 { 52 52 $values['extensions'][$key] = phpversion($extension) ? sprintf('%s (%s)', $extension, phpversion($extension)) : $extension; branches/1.2/lib/debug/sfWebDebug.class.php
r16169 r17858 118 118 * Removes a panel by name. 119 119 * 120 * @param string $nameThe panel name120 * @param string $name The panel name 121 121 */ 122 122 public function removePanel($name) … … 128 128 * Gets an option value by name. 129 129 * 130 * @param string $nameThe option name131 * 132 * @return mixed The option value130 * @param string $name The option name 131 * 132 * @return mixed The option value 133 133 */ 134 134 public function getOption($name, $default = null) … … 140 140 * Injects the web debug toolbar into a given HTML string. 141 141 * 142 * @param string $content The HTML content142 * @param string $content The HTML content 143 143 * 144 144 * @return string The content with the web debug toolbar injected branches/1.2/lib/debug/sfWebDebugPanelConfig.class.php
r13931 r17858 65 65 * Converts an array to HTML. 66 66 * 67 * @param string $id The identifier to use68 * @param array $values The array of values67 * @param string $id The identifier to use 68 * @param array $values The array of values 69 69 * 70 70 * @return string An HTML string branches/1.2/lib/event/sfEvent.class.php
r8698 r17858 29 29 * Constructs a new sfEvent. 30 30 * 31 * @param mixed $subjectThe subject32 * @param string $nameThe event name33 * @param array $parametersAn array of parameters31 * @param mixed $subject The subject 32 * @param string $name The event name 33 * @param array $parameters An array of parameters 34 34 */ 35 35 public function __construct($subject, $name, $parameters = array()) … … 114 114 * Returns true if the parameter exists (implements the ArrayAccess interface). 115 115 * 116 * @param string $nameThe parameter name116 * @param string $name The parameter name 117 117 * 118 118 * @return Boolean true if the parameter exists, false otherwise … … 126 126 * Returns a parameter value (implements the ArrayAccess interface). 127 127 * 128 * @param string $nameThe parameter name128 * @param string $name The parameter name 129 129 * 130 * @return mixed The parameter value130 * @return mixed The parameter value 131 131 */ 132 132 public function offsetGet($name) … … 143 143 * Sets a parameter (implements the ArrayAccess interface). 144 144 * 145 * @param string $nameThe parameter name146 * @param mixed $valueThe parameter value145 * @param string $name The parameter name 146 * @param mixed $value The parameter value 147 147 */ 148 148 public function offsetSet($name, $value) … … 154 154 * Removes a parameter (implements the ArrayAccess interface). 155 155 * 156 * @param string $name The parameter name156 * @param string $name The parameter name 157 157 */ 158 158 public function offsetUnset($name) branches/1.2/lib/event/sfEventDispatcher.class.php
r10631 r17858 27 27 * Connects a listener to a given event name. 28 28 * 29 * @param string $nameAn event name30 * @param mixed $listenerA PHP callable29 * @param string $name An event name 30 * @param mixed $listener A PHP callable 31 31 */ 32 32 public function connect($name, $listener) … … 43 43 * Disconnects a listener for a given event name. 44 44 * 45 * @param string $nameAn event name46 * @param mixed $listenerA PHP callable45 * @param string $name An event name 46 * @param mixed $listener A PHP callable 47 47 * 48 48 * @return mixed false if listener does not exist, null otherwise … … 84 84 * Notifies all listeners of a given event until one returns a non null value. 85 85 * 86 * @param sfEvent $event A sfEvent instance86 * @param sfEvent $event A sfEvent instance 87 87 * 88 88 * @return sfEvent The sfEvent instance … … 105 105 * Filters a value by calling all listeners of a given event. 106 106 * 107 * @param sfEvent $eventA sfEvent instance108 * @param mixed $valueThe value to be filtered107 * @param sfEvent $event A sfEvent instance 108 * @param mixed $value The value to be filtered 109 109 * 110 110 * @return sfEvent The sfEvent instance … … 125 125 * Returns true if the given event name has some listeners. 126 126 * 127 * @param string $nameThe event name127 * @param string $name The event name 128 128 * 129 129 * @return Boolean true if some listeners are connected, false otherwise … … 142 142 * Returns all listeners associated with a given event name. 143 143 * 144 * @param string $nameThe event name144 * @param string $name The event name 145 145 * 146 * @return array An array of listeners146 * @return array An array of listeners 147 147 */ 148 148 public function getListeners($name) branches/1.2/lib/exception/sfException.class.php
r15223 r17858 191 191 * Returns the path for the template error message. 192 192 * 193 * @param string $format The request format194 * @param Boolean $debug Whether to return a template for the debug mode or not195 * 196 * @return string|Boolean false if the template cannot be found for the given format,197 * the absolute path to the template otherwise193 * @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 198 198 */ 199 199 static public function getTemplatePathForError($format, $debug) … … 220 220 * Returns an array of exception traces. 221 221 * 222 * @param Exception $exception An Exception implementation instance223 * @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) 224 224 * 225 225 * @return array An array of traces … … 282 282 * Returns an excerpt of a code file around the given line number. 283 283 * 284 * @param string $file A file path285 * @param int $line The selected line number284 * @param string $file A file path 285 * @param int $line The selected line number 286 286 * 287 287 * @return string An HTML string … … 306 306 * Formats an array as a string. 307 307 * 308 * @param array $args The argument array308 * @param array $args The argument array 309 309 * @param boolean $single 310 * @param string $format The format string (html or plain)310 * @param string $format The format string (html or plain) 311 311 * 312 312 * @return string branches/1.2/lib/filter/sfCacheFilter.class.php
r17749 r17858 29 29 * Initializes this Filter. 30 30 * 31 * @param sfContext $context The current application context32 * @param array $parameters An associative array of initialization parameters31 * @param sfContext $context The current application context 32 * @param array $parameters An associative array of initialization parameters 33 33 * 34 34 * @return bool true, if initialization completes successfully, otherwise false branches/1.2/lib/filter/sfExecutionFilter.class.php
r16250 r17858 59 59 * Handles the action. 60 60 * 61 * @param sfFilterChain $filterChainThe current filter chain62 * @param sfAction $actionInstanceAn sfAction instance61 * @param sfFilterChain $filterChain The current filter chain 62 * @param sfAction $actionInstance An sfAction instance 63 63 * 64 * @return string The view type64 * @return string The view type 65 65 */ 66 66 protected function handleAction($filterChain, $actionInstance) … … 80 80 * Executes the execute method of an action. 81 81 * 82 * @param sfAction $actionInstance An sfAction instance82 * @param sfAction $actionInstance An sfAction instance 83 83 * 84 * @return string The view type84 * @return string The view type 85 85 */ 86 86 protected function executeAction($actionInstance) … … 97 97 * Handles the view. 98 98 * 99 * @param sfFilterChain $filterChainThe current filter chain100 * @param sfAction $actionInstanceAn sfAction instance101 * @param string $viewNameThe view name99 * @param sfFilterChain $filterChain The current filter chain 100 * @param sfAction $actionInstance An sfAction instance 101 * @param string $viewName The view name 102 102 */ 103 103 protected function handleView($filterChain, $actionInstance, $viewName) … … 124 124 * - sfView::RENDER_DATA: View data populates the data presentation variable. 125 125 * 126 * @param string $moduleName The module name127 * @param string $actionName The action name128 * @param string $viewName The view name129 * @param array $viewAttributes An array of view attributes126 * @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 130 130 * 131 131 * @return string The view data branches/1.2/lib/filter/sfFilter.class.php
r9087 r17858 124 124 * <code>$this->getParameterHolder()->has()</code> 125 125 * 126 * @param string $name The key name126 * @param string $name The key name 127 127 * 128 128 * @return boolean true if the given key exists, false otherwise branches/1.2/lib/form/sfForm.class.php
r17749 r17858 48 48 * Constructor. 49 49 * 50 * @param array $defaults An array of field default values51 * @param array $options An array of options52 * @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) 53 53 */ 54 54 public function __construct($defaults = array(), $options = array(), $CSRFSecret = null) … … 113 113 * Renders the widget schema associated with this form. 114 114 * 115 * @param array $attributesAn array of HTML attributes115 * @param array $attributes An array of HTML attributes 116 116 * 117 117 * @return string The rendered widget schema … … 125 125 * Renders the widget schema using a specific form formatter 126 126 * 127 * @param string $formatterNameThe form formatter name128 * @param array $attributesAn array of HTML attributes127 * @param string $formatterName The form formatter name 128 * @param array $attributes An array of HTML attributes 129 129 * 130 130 * @return string The rendered widget schema … … 197 197 * It triggers the validator schema validation. 198 198 * 199 * @param array $taintedValues An array of input values200 * @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) 201 201 */ 202 202 public function bind(array $taintedValues = null, array $taintedFiles = null) … … 313 313 * If the form is not bound, it will return null. 314 314 * 315 * @param string $fieldThe name of the value required316 * @return string The cleaned value315 * @param string $field The name of the value required 316 * @return string The cleaned value 317 317 */ 318 318 public function getValue($field) … … 351 351 * Embeds a sfForm into the current form. 352 352 * 353 * @param string $name The field name354 * @param sfForm $form A sfForm instance355 * @param string $decorator A HTML decorator for the embedded form353 * @param string $name The field name 354 * @param sfForm $form A sfForm instance 355 * @param string $decorator A HTML decorator for the embedded form 356 356 */ 357 357 public function embedForm($name, sfForm $form, $decorator = null) … … 383 383 * Embeds a sfForm into the current form n times. 384 384 * 385 * @param string $name The field name386 * @param sfForm $form A sfForm instance387 * @param integer $n The number of times to embed the form388 * @param string $decorator A HTML decorator for the main form around embedded forms389 * @param string $innerDecorator A HTML decorator for each embedded form390 * @param array $options Options for schema391 * @param array $attributes Attributes for schema392 * @param array $labels Labels for schema385 * @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 393 393 */ 394 394 public function embedFormForEach($name, sfForm $form, $n, $decorator = null, $innerDecorator = null, $options = array(), $attributes = array(), $labels = array()) … … 451 451 * sfForm object passed as parameter. Please note it also merge defaults. 452 452 * 453 * @param sfForm $formThe sfForm instance to merge with current form454 * 455 * @throws LogicException If one of the form has already been bound453 * @param sfForm $form The sfForm instance to merge with current form 454 * 455 * @throws LogicException If one of the form has already been bound 456 456 */ 457 457 public function mergeForm(sfForm $form) … … 562 562 * Gets a validator for the given field name. 563 563 * 564 * @param string $nameThe field name564 * @param string $name The field name 565 565 * 566 566 * @return sfValidator $validator The validator … … 624 624 * Gets a widget for the given field name. 625 625 * 626 * @param string $nameThe field name626 * @param string $name The field name 627 627 * 628 628 * @return sfWidgetForm $widget The widget … … 805 805 * can override this method. 806 806 * 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) 808 808 * 809 809 * @return string A token string … … 899 899 * for later processing. 900 900 * 901 * @param string $urlThe URL for the action902 * @param array $attributesAn array of HTML attributes901 * @param string $url The URL for the action 902 * @param array $attributes An array of HTML attributes 903 903 * 904 904 * @return string An HTML representation of the opening form tag … … 932 932 * Returns true if the bound field exists (implements the ArrayAccess interface). 933 933 * 934 * @param string $name The name of the bound field934 * @param string $name The name of the bound field 935 935 * 936 936 * @return Boolean true if the widget exists, false otherwise … … 944 944 * Returns the form field associated with the name (implements the ArrayAccess interface). 945 945 * 946 * @param string $nameThe offset of the value to get947 * 948 * @return sfFormField A form field instance946 * @param string $name The offset of the value to get 947 * 948 * @return sfFormField A form field instance 949 949 */ 950 950 public function offsetGet($name) … … 1094 1094 * It's safe to pass an already converted array, in which case this method just returns the original array unmodified. 1095 1095 * 1096 * @param array $taintedFiles An array representing uploaded file information1096 * @param array $taintedFiles An array representing uploaded file information 1097 1097 * 1098 1098 * @return array An array of re-ordered uploaded file information branches/1.2/lib/form/sfFormField.class.php
r15807 r17858 32 32 * Constructor. 33 33 * 34 * @param sfWidgetForm $widget A sfWidget instance35 * @param sfFormField $parent The sfFormField parent instance (null for the root widget)36 * @param string $name The field name37 * @param string $value The field value38 * @param sfValidatorError $error A sfValidatorError instance34 * @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 39 39 */ 40 40 public function __construct(sfWidgetForm $widget, sfFormField $parent = null, $name, $value, sfValidatorError $error = null) … … 109 109 * Renders the form field. 110 110 * 111 * @param array $attributesAn array of HTML attributes111 * @param array $attributes An array of HTML attributes 112 112 * 113 113 * @return string The rendered widget … … 125 125 * the help message. 126 126 * 127 * @param array $attributesAn array of HTML attributes to merge with the current attributes128 * @param string $labelThe label name (not null to override the current value)129 * @param string $helpThe 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) 130 130 * 131 131 * @return string The formatted row … … 184 184 * Returns the label tag. 185 185 * 186 * @param string $labelThe label name (not null to override the current value)187 * @param array $attributesOptional html attributes186 * @param string $label The label name (not null to override the current value) 187 * @param array $attributes Optional html attributes 188 188 * 189 189 * @return string The label tag branches/1.2/lib/form/sfFormFieldSchema.class.php
r17587 r17858 27 27 * Constructor. 28 28 * 29 * @param sfWidgetFormSchema $widget A sfWidget instance30 * @param sfFormField $parent The sfFormField parent instance (null for the root widget)31 * @param string $name The field name32 * @param string $value The field value33 * @param sfValidatorError $error A sfValidatorError instance29 * @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 34 34 */ 35 35 public function __construct(sfWidgetFormSchema $widget, sfFormField $parent = null, $name, $value, sfValidatorError $error = null) … … 43 43 * Returns true if the bound field exists (implements the ArrayAccess interface). 44 44 * 45 * @param string $nameThe name of the bound field45 * @param string $name The name of the bound field 46 46 * 47 47 * @return Boolean true if the widget exists, false otherwise … … 55 55 * Returns the form field associated with the name (implements the ArrayAccess interface). 56 56 * 57 * @param string $name The offset of the value to get57 * @param string $name The offset of the value to get 58 58 * 59 59 * @return sfFormField A form field instance branches/1.2/lib/generator/sfAdminGenerator.class.php
r13060 r17858 33 33 * Returns HTML code for a help icon. 34 34 * 35 * @param string $column The column name36 * @param string $type The field type (list, edit)35 * @param string $column The column name 36 * @param string $type The field type (list, edit) 37 37 * 38 38 * @return string HTML code … … 52 52 * Returns HTML code for a help text. 53 53 * 54 * @param string $column The column name55 * @param string $type The field type (list, edit)54 * @param string $column The column name 55 * @param string $type The field type (list, edit) 56 56 * 57 57 * @return string HTML code … … 71 71 * Returns HTML code for an action button. 72 72 * 73 * @param string $actionName The action name74 * @param array $params The parameters75 * @param boolean $pk_link Whether to add a primary key link or not73 * @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 76 76 * 77 77 * @return string HTML code … … 182 182 * Returns HTML code for an action link. 183 183 * 184 * @param string $actionName The action name185 * @param array $params The parameters186 * @param boolean $pk_link Whether to add a primary key link or not184 * @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 187 187 * 188 188 * @return string HTML code … … 229 229 * Returns HTML code for an action option in a select tag. 230 230 * 231 * @param string $actionName The action name232 * @param array $params The parameters231 * @param string $actionName The action name 232 * @param array $params The parameters 233 233 * 234 234 * @return string HTML code … … 259 259 * Returns HTML code for a column in edit mode. 260 260 * 261 * @param string $columnThe column name262 * @param array $paramsThe parameters261 * @param string $column The column name 262 * @param array $params The parameters 263 263 * 264 264 * @return string HTML code … … 338 338 * Wraps content with a credential condition. 339 339 * 340 * @param string $contentThe content341 * @param array $paramsThe parameters340 * @param string $content The content 341 * @param array $params The parameters 342 342 * 343 343 * @return string HTML code … … 515 515 * Wraps a content for I18N. 516 516 * 517 * @param string $key The key name518 * @param string $default The defaul value519 * @param bool $withEcho If true, string is wrapped in php echo517 * @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 520 520 * 521 521 * @return string HTML code … … 590 590 * Returns HTML code for a column in list mode. 591 591 * 592 * @param string $column The column name593 * @param array $params The parameters592 * @param string $column The column name 593 * @param array $params The parameters 594 594 * 595 595 * @return string HTML code … … 631 631 * Returns HTML code for a column in filter mode. 632 632 * 633 * @param string $column The column name634 * @param array $params The parameters633 * @param string $column The column name 634 * @param array $params The parameters 635 635 * 636 636 * @return string HTML code branches/1.2/lib/generator/sfCrudGenerator.class.php
r11471 r17858 314 314 * Returns HTML code for a column in list mode. 315 315 * 316 * @param string $columnThe column name317 * @param array $paramsThe parameters316 * @param string $column The column name 317 * @param array $params The parameters 318 318 * 319 319 * @return string HTML code … … 342 342 * Returns HTML code for a column in edit mode. 343 343 * 344 * @param string $columnThe column name345 * @param array $paramsThe parameters344 * @param string $column The column name 345 * @param array $params The parameters 346 346 * 347 347 * @return string HTML code … … 420 420 * This method is ORM dependant. 421 421 * 422 * @param string $helperName The helper name423 * @param string $column The column name424 * @param array $params An array of parameters425 * @param array $localParams An array of local parameters422 * @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 426 426 * 427 427 * @return string PHP code … … 434 434 * This method is ORM dependant. 435 435 * 436 * @param string $column The column name437 * @param boolean $developed true if you want developped method names, false otherwise438 * @param string $prefix The prefix value436 * @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 439 439 * 440 440 * @return string PHP code branches/1.2/lib/generator/sfGenerator.class.php
r9123 r17858 58 58 * Generates PHP files for a given module name. 59 59 * 60 * @param string $generatedModuleName The name of module name to generate61 * @param array $files A list of template files to generate60 * @param string $generatedModuleName The name of module name to generate 61 * @param array $files A list of template files to generate 62 62 */ 63 63 protected function generatePhpFiles($generatedModuleName, $files = array()) … … 72 72 * Evaluates a template file. 73 73 * 74 * @param string $templateFile The template file path74 * @param string $templateFile The template file path 75 75 * 76 76 * @return string The evaluated template branches/1.2/lib/generator/sfGeneratorManager.class.php
r12264 r17858 40 40 * Initializes the sfGeneratorManager instance. 41 41 * 42 * @param sfProjectConfiguration $configuration A sfProjectConfiguration instance42 * @param sfProjectConfiguration $configuration A sfProjectConfiguration instance 43 43 * @deprecated 44 44 */ … … 115 115 * Generates classes and templates for a given generator class. 116 116 * 117 * @param string $generatorClass The generator class name118 * @param array $param An array of parameters117 * @param string $generatorClass The generator class name 118 * @param array $param An array of parameters 119 119 * 120 120 * @return string The cache for the configuration file branches/1.2/lib/generator/sfModelGenerator.class.php
r17063 r17858 182 182 * This method is ORM dependant. 183 183 * 184 * @param string $column The column name185 * @param boolean $developed true if you want developped method names, false otherwise186 * @param string $prefix The prefix value184 * @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 187 187 * 188 188 * @return string PHP code … … 195 195 * Returns HTML code for an action link. 196 196 * 197 * @param string $actionName The action name198 * @param array $params The parameters199 * @param boolean $pk_link Whether to add a primary key link or not197 * @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 200 200 * 201 201 * @return string HTML code … … 213 213 * Wraps content with a credential condition. 214 214 * 215 * @param string $contentThe content216 * @param array $paramsThe parameters215 * @param string $content The content 216 * @param array $params The parameters 217 217 * 218 218 * @return string HTML code branches/1.2/lib/generator/sfModelGeneratorConfiguration.class.php
r17749 r17858 210 210 * Gets the configuration for a given field. 211 211 * 212 * @param string $key The configuration key (title.list.name for example)213 * @param mixed $default The default value if none has been defined214 * @param Boolean $escaped Whether to escape single quote (false by default)215 * 216 * @return mixed The configuration value212 * @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 217 217 */ 218 218 public function getValue($key, $default = null, $escaped = false) branches/1.2/lib/generator/sfModelGeneratorConfigurationField.class.php
r17749 r17858 48 48 * If the key is null, the method returns all the configuration array. 49 49 * 50 * @param string $key A key string51 * @param mixed $default The default value if the key does not exist52 * @param Boolean $escaped Whether to escape single quote (false by default)53 * 54 * @return mixed The configuration value associated with the key50 * @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 55 55 */ 56 56 public function getConfig($key = null, $default = null, $escaped = false) branches/1.2/lib/helper/AssetHelper.php
r17078 r17858 38 38 * </code> 39 39 * 40 * @param string $typefeed type ('rss', 'atom')41 * @param string $url'module/action' or '@rule' of the feed42 * @param array $tag_optionsadditional HTML compliant <link> tag parameters40 * @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 43 43 * 44 44 * @return string XHTML compliant <link> tag … … 68 68 * - file name without extension, like "myscript", that gets expanded to "/js/myscript.js" 69 69 * 70 * @param string $sourceasset name71 * @param bool $absolutereturn absolute path ?70 * @param string $source asset name 71 * @param bool $absolute return absolute path ? 72 72 * 73 73 * @return string file path to the JavaScript file … … 91 91 * </code> 92 92 * 93 * @param string asset names94 * @param array additional HTML compliant <link> tag parameters93 * @param string asset names 94 * @param array additional HTML compliant <link> tag parameters 95 95 * 96 96 * @return string XHTML compliant <script> tag(s) … … 156 156 * - file name without extension, like "style", that gets expanded to "/css/style.css" 157 157 * 158 * @param string $sourceasset name159 * @param bool $absolutereturn absolute path ?158 * @param string $source asset name 159 * @param bool $absolute return absolute path ? 160 160 * 161 161 * @return string file path to the stylesheet file … … 189 189 * </code> 190 190 * 191 * @param string asset names192 * @param arrayadditional HTML compliant <link> tag parameters191 * @param string asset names 192 * @param array additional HTML compliant <link> tag parameters 193 193 * 194 194 * @return string XHTML compliant <link> tag(s) … … 263 263 * Decorates the current template with a given layout. 264 264 * 265 * @param mixed $layout The layout name or path or false to disable the layout265 * @param mixed $layout The layout name or path or false to disable the layout 266 266 */ 267 267 function decorate_with($layout) … … 291 291 * - file name without extension, like "logo", that gets expanded to "/images/logo.png" 292 292 * 293 * @param string $sourceasset name294 * @param bool $absolutereturn absolute path ?293 * @param string $source asset name 294 * @param bool $absolute return absolute path ? 295 295 * 296 296 * @return string file path to the image file … … 318 318 * </code> 319 319 * 320 * @param string $sourceimage asset name321 * @param array $optionsadditional HTML compliant <img> tag parameters320 * @param string $source image asset name 321 * @param array $options additional HTML compliant <img> tag parameters 322 322 * 323 323 * @return string XHTML compliant <img> tag … … 561 561 * The helper automatically adds the sf_format to the internal URI, so you don't have to. 562 562 * 563 * @param string $uriThe internal URI for the dynamic javascript564 * @param bool $absoluteWhether to generate an absolute URL565 * @param array $optionsAn array of options566 * 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) 568 568 * @see javascript_include_tag 569 569 */ branches/1.2/lib/helper/DateFormHelper.php
r14264 r17858 38 38 * </code> 39 39 * 40 * @param string $namefield name41 * @param int $valueselected value (1 - 31)42 * @param array $optionsspecial options for the select tag43 * @param array $html_optionsadditional HTML compliant <select> tag parameters40 * @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 44 44 * 45 45 * @return string <select> tag populated with all the days of the month (1 - 31). … … 92 92 * </code> 93 93 * 94 * @param string $namefield name95 * @param int $valueselected value (1 - 12)96 * @param array $optionsspecial options for the select tag97 * @param array $html_optionsadditional HTML compliant <select> tag parameters94 * @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 98 98 * 99 99 * @return string <select> tag populated with all the months of the year (1 - 12). … … 172 172 * </code> 173 173 * 174 * @param string $namefield name175 * @param int $valueselected value within the range of years.176 * @param array $optionsspecial options for the select tag177 * @param array $html_optionsadditional HTML compliant <select> tag parameters174 * @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 178 178 * 179 179 * @return string <select> tag populated with a range of years. … … 259 259 * </code> 260 260 * 261 * @param string $namefield name (automatically becomes an array of parts: name[year], name[month], year[day])262 * @param mixed $valueaccepts a valid date string or properly formatted date array263 * @param array $optionsspecial options for the select tags264 * @param array $html_optionsadditional HTML compliant <select> tag parameters261 * @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 265 265 * 266 266 * @return string three <select> tags populated with a months, days and years … … 375 375 * </code> 376 376 * 377 * @param string $namefield name378 * @param int $valueselected value (0 - 59)379 * @param array $optionsspecial options for the select tag380 * @param array $html_optionsadditional HTML compliant <select> tag parameters377 * @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 381 381 * 382 382 * @return string <select> tag populated with 60 seconds (0 - 59). … … 428 428 * </code> 429 429 * 430 * @param string $namefield name431 * @param int $valueselected value (0 - 59)432 * @param array $optionsspecial options for the select tag433 * @param array $html_optionsadditional HTML compliant <select> tag parameters430 * @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 434 434 * 435 435 * @return string <select> tag populated with 60 minutes (0 - 59). … … 479 479 * </code> 480 480 * 481 * @param string $namefield name482 * @param int $valueselected value (0 - 23 or 1 - 12 if '12hour_time' = true)483 * @param array $optionsspecial options for the select tag484 * @param array $html_optionsadditional HTML compliant <select> tag parameters481 * @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 485 485 * 486 486 * @return string <select> tag populated with 24 hours (0 - 23), or optionally 12 hours (1 - 12). … … 534 534 * </code> 535 535 * 536 * @param string $namefield name537 * @param string $valueselected value (AM or PM)538 * @param array $optionsspecial options for the select tag539 * @param array $html_optionsadditional HTML compliant <select> tag parameters536 * @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 540 540 * @return string <select> tag populated with AM and PM options for use with 12-Hour time. 541 541 * @see select_time_tag, select datetime_tag … … 597 597 * </code> 598 598 * 599 * @param string $namefield name (automatically becomes an array of parts: name[hour], name[minute], year[second])600 * @param mixed $valueaccepts a valid time string or properly formatted time array601 * @param array $optionsspecial options for the select tag602 * @param array $html_optionsadditional HTML compliant <select> tag parameters599 * @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 603 603 * @return string three <select> tags populated with a hours, minutes and optionally seconds. 604 604 * @see select datetime_tag, select_hour_tag, select_minute_tag, select_second_tag … … 718 718 * </code> 719 719 * 720 * @param string $namefield name (automatically becomes an array of date and time parts)721 * @param mixed $valueaccepts a valid time string or properly formatted time array722 * @param array $optionsspecial options for the select tagss723 * @param array $html_optionsadditional HTML compliant <select> tag parameters720 * @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 724 724 * 725 725 * @return string a variable number of <select> tags populated with date and time related select boxes … … 768 768 * </code> 769 769 * 770 * @param string $namefield name771 * @param string $valuethe selected option772 * @param array $optionsspecial options for the select tagss773 * @param array $html_optionsadditional HTML compliant <select> tag parameters770 * @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 774 774 * 775 775 * @return string <select> tag populated with a range of numbers. … … 822 822 * </code> 823 823 * 824 * @param string $namefield name825 * @param string $selectedselected field value (timezone identifier)826 * @param array $optionsadditional HTML compliant <select> tag parameters824 * @param string $name field name 825 * @param string $selected selected field value (timezone identifier) 826 * @param array $options additional HTML compliant <select> tag parameters 827 827 * 828 828 * @return string <select> tag populated with all the timezones in the world. … … 877 877 * <b>Note:</b> If <i>$value</i> is empty, it will be populated with the current date and time. 878 878 * 879 * @param string $valuedate or date part880 * @param string $keycustom key for array values881 * @param string $format_chardate format879 * @param string $value date or date part 880 * @param string $key custom key for array values 881 * @param string $format_char date format 882 882 * 883 883 * @return string properly formatted date part value. … … 912 912 * <b>Note:</b> If no <i>$culture</i> is defined, the user's culture setting will be used in its place. 913 913 * 914 * @param string $culturetwo or three character culture setting variable914 * @param string $culture two or three character culture setting variable 915 915 * 916 916 * @return string formatted date/time format based on the specified date/time setting branches/1.2/lib/helper/EscapingHelper.php
r9101 r17858 35 35 * Runs the PHP function htmlentities on the value passed. 36 36 * 37 * @param string $valuethe value to escape37 * @param string $value the value to escape 38 38 * @return string the escaped value 39 39 */ … … 50 50 * Runs the PHP function htmlspecialchars on the value passed. 51 51 * 52 * @param string $valuethe value to escape52 * @param string $value the value to escape 53 53 * @return string the escaped value 54 54 */ … … 66 66 * being to be able to specify that the value is not to be escaped in any way. 67 67 * 68 * @param string $valuethe value to escape68 * @param string $value the value to escape 69 69 * @return string the escaped value 70 70 */ … … 85 85 * that is ultimately not going to end up as text in an HTML document. 86 86 * 87 * @param string $valuethe value to escape87 * @param string $value the value to escape 88 88 * @return string the escaped value 89 89 */ … … 99 99 * JavaScript string. 100 100 * 101 * @param string $valuethe value to escape101 * @param string $value the value to escape 102 102 * @return string the escaped value 103 103 */ branches/1.2/lib/helper/FormHelper.php
r14153 r17858 48 48 * </code> 49 49 * 50 * @param array $optionsdataset to create <option> tags and <optgroup> tags from51 * @param string $selectedselected option value52 * @param array $html_optionsadditional HTML compliant <option> tag parameters50 * @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 53 53 * 54 54 * @return string populated with <option> tags derived from the <i>$options</i> array variable … … 410 410 * </code> 411 411 * 412 * @param string $namefield name413 * @param array $optionsadditional HTML compliant <input> tag parameters412 * @param string $name field name 413 * @param array $options additional HTML compliant <input> tag parameters 414 414 * 415 415 * @return string XHTML compliant <input> tag with type="file" … … 440 440 * </code> 441 441 * 442 * @param string $namefield name443 * @param string $valuepopulated field value444 * @param array $optionsadditional HTML compliant <input> tag parameters442 * @param string $name field name 443 * @param string $value populated field value 444 * @param array $options additional HTML compliant <input> tag parameters 445 445 * 446 446 * @return string XHTML compliant <input> tag with type="password" … … 679 679 * </code> 680 680 * 681 * @param string $namefield name682 * @param string $valuedate683 * @param array $optionsadditional HTML compliant <input> tag parameters681 * @param string $name field name 682 * @param string $value date 683 * @param array $options additional HTML compliant <input> tag parameters 684 684 * 685 685 * @return string XHTML compliant <input> tag with optional JS calendar integration … … 732 732 // register our javascripts and stylesheets 733 733 $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')) && 735 735 (!is_readable(sfConfig::get('sf_symfony_lib_dir').'/../data/web/'.$langFile.'.js')) && 736 736 (!is_readable(sfConfig::get('sf_symfony_lib_dir').'/../data/symfony/web/'.$langFile.'.js'))) 737 737 { 738 738 $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')) && 740 740 (!is_readable(sfConfig::get('sf_symfony_lib_dir').'/../data/web/'.$langFile.'.js')) && 741 741 (!is_readable(sfConfig::get('sf_symfony_lib_dir').'/../data/symfony/web/'.$langFile.'.js'))) … … 855 855 * </code> 856 856 * 857 * @param string $namefield value (title of submit button)858 * @param array $optionsadditional HTML compliant <input> tag parameters857 * @param string $name field value (title of submit button) 858 * @param array $options additional HTML compliant <input> tag parameters 859 859 * 860 860 * @return string XHTML compliant <input> tag with type="submit" … … 881 881 * </code> 882 882 * 883 * @param string $namefield value (title of reset button)884 * @param array $optionsadditional HTML compliant <input> tag parameters883 * @param string $name field value (title of reset button) 884 * @param array $options additional HTML compliant <input> tag parameters 885 885 * 886 886 * @return string XHTML compliant <input> tag with type="reset" … … 910 910 * </code> 911 911 * 912 * @param string $sourcepath to image file913 * @param array $optionsadditional HTML compliant <input> tag parameters912 * @param string $source path to image file 913 * @param array $options additional HTML compliant <input> tag parameters 914 914 * 915 915 * @return string XHTML compliant <input> tag with type="image" … … 932 932 * Returns a <label> tag with <i>$label</i> for the specified <i>$id</i> parameter. 933 933 * 934 * @param string $idid935 * @param string $labellabel or title936 * @param array $optionsadditional HTML compliant <label> tag parameters934 * @param string $id id 935 * @param string $label label or title 936 * @param array $options additional HTML compliant <label> tag parameters 937 937 * 938 938 * @return string <label> tag with <i>$label</i> for the specified <i>$id</i> parameter.

