From e6e9f946895834d00e50ac9343984a929d5d65d8 Mon Sep 17 00:00:00 2001 From: Karoly Gossler Date: Sun, 14 Jan 2024 14:50:03 +0100 Subject: [PATCH] fix(phpdoc) remove html code from throws phpdoc. phpstan don't like this --- lib/cache/sfCache.class.php | 2 +- lib/config/sfCacheConfigHandler.class.php | 6 +++--- lib/config/sfConfigCache.class.php | 6 +++--- lib/config/sfConfigHandler.class.php | 6 +++--- lib/config/sfFactoryConfigHandler.class.php | 4 ++-- lib/config/sfSecurityConfigHandler.class.php | 6 +++--- lib/config/sfViewConfigHandler.class.php | 6 +++--- lib/database/sfDatabase.class.php | 10 +++++----- lib/database/sfDatabaseManager.class.php | 6 +++--- lib/database/sfMySQLDatabase.class.php | 4 ++-- lib/database/sfMySQLiDatabase.class.php | 2 +- lib/database/sfPDODatabase.class.php | 2 +- lib/database/sfPostgreSQLDatabase.class.php | 4 ++-- lib/filter/sfCacheFilter.class.php | 2 +- lib/filter/sfExecutionFilter.class.php | 4 ++-- lib/filter/sfRenderingFilter.class.php | 4 ++-- lib/form/sfForm.class.php | 2 +- lib/log/sfLogger.class.php | 2 +- lib/request/sfRequest.class.php | 6 +++--- lib/request/sfWebRequest.class.php | 4 ++-- lib/response/sfResponse.class.php | 4 ++-- lib/response/sfWebResponse.class.php | 4 ++-- lib/storage/sfCacheSessionStorage.class.php | 6 +++--- lib/storage/sfDatabaseSessionStorage.class.php | 10 +++++----- lib/storage/sfMySQLSessionStorage.class.php | 8 ++++---- lib/storage/sfNoStorage.class.php | 8 ++++---- lib/storage/sfPDOSessionStorage.class.php | 8 ++++---- lib/storage/sfPostgreSQLSessionStorage.class.php | 8 ++++---- lib/storage/sfStorage.class.php | 12 ++++++------ lib/util/sfContext.class.php | 2 +- 30 files changed, 79 insertions(+), 79 deletions(-) diff --git a/lib/cache/sfCache.class.php b/lib/cache/sfCache.class.php index 656e3fc71..99832f2e5 100644 --- a/lib/cache/sfCache.class.php +++ b/lib/cache/sfCache.class.php @@ -50,7 +50,7 @@ public function __construct($options = array()) * * * lifetime (optional): The default life time (default value: 86400) * - * @throws sfInitializationException If an error occurs while initializing this sfCache instance + * @throws sfInitializationException If an error occurs while initializing this sfCache instance */ public function initialize($options = array()) { diff --git a/lib/config/sfCacheConfigHandler.class.php b/lib/config/sfCacheConfigHandler.class.php index 0a9d10bf7..bc4095df0 100644 --- a/lib/config/sfCacheConfigHandler.class.php +++ b/lib/config/sfCacheConfigHandler.class.php @@ -26,9 +26,9 @@ class sfCacheConfigHandler extends sfYamlConfigHandler * * @return string Data to be written to a cache file * - * @throws sfConfigurationException If a requested configuration file does not exist or is not readable - * @throws sfParseException If a requested configuration file is improperly formatted - * @throws sfInitializationException If a cache.yml key check fails + * @throws sfConfigurationException If a requested configuration file does not exist or is not readable + * @throws sfParseException If a requested configuration file is improperly formatted + * @throws sfInitializationException If a cache.yml key check fails */ public function execute($configFiles) { diff --git a/lib/config/sfConfigCache.class.php b/lib/config/sfConfigCache.class.php index 975eae7e2..bf33328a4 100644 --- a/lib/config/sfConfigCache.class.php +++ b/lib/config/sfConfigCache.class.php @@ -49,7 +49,7 @@ public function __construct(sfApplicationConfiguration $configuration) * * @return string An absolute filesystem path to the cache filename associated with this specified configuration file * - * @throws sfConfigurationException If a requested configuration file does not exist + * @throws sfConfigurationException If a requested configuration file does not exist * * @see sfConfiguration::getConfigPaths() */ @@ -175,7 +175,7 @@ public function registerConfigHandler($handler, $class, $params = array()) * @param array $configs An array of absolute filesystem paths to configuration files * @param string $cache An absolute filesystem path to the cache file that will be written * - * @throws sfConfigurationException If a requested configuration file does not have an associated configuration handler + * @throws sfConfigurationException If a requested configuration file does not have an associated configuration handler */ protected function callHandler($handler, $configs, $cache) { @@ -251,7 +251,7 @@ protected function getHandler($name) /** * Loads all configuration application and module level handlers. * - * @throws sfConfigurationException If a configuration related error occurs + * @throws sfConfigurationException If a configuration related error occurs */ protected function loadConfigHandlers() { diff --git a/lib/config/sfConfigHandler.class.php b/lib/config/sfConfigHandler.class.php index 728033f8f..8904862af 100644 --- a/lib/config/sfConfigHandler.class.php +++ b/lib/config/sfConfigHandler.class.php @@ -41,7 +41,7 @@ public function __construct($parameters = null) * * @param array $parameters An associative array of initialization parameters * - * @throws sfInitializationException If an error occurs while initializing this ConfigHandler + * @throws sfInitializationException If an error occurs while initializing this ConfigHandler */ public function initialize($parameters = null) { @@ -56,8 +56,8 @@ public function initialize($parameters = null) * * @return string Data to be written to a cache file * - * @throws sfConfigurationException If a requested configuration file does not exist or is not readable - * @throws sfParseException If a requested configuration file is improperly formatted + * @throws sfConfigurationException If a requested configuration file does not exist or is not readable + * @throws sfParseException If a requested configuration file is improperly formatted */ abstract public function execute($configFiles); diff --git a/lib/config/sfFactoryConfigHandler.class.php b/lib/config/sfFactoryConfigHandler.class.php index eb61473ca..e190d73de 100644 --- a/lib/config/sfFactoryConfigHandler.class.php +++ b/lib/config/sfFactoryConfigHandler.class.php @@ -27,8 +27,8 @@ class sfFactoryConfigHandler extends sfYamlConfigHandler * * @return string Data to be written to a cache file * - * @throws sfConfigurationException If a requested configuration file does not exist or is not readable - * @throws sfParseException If a requested configuration file is improperly formatted + * @throws sfConfigurationException If a requested configuration file does not exist or is not readable + * @throws sfParseException If a requested configuration file is improperly formatted */ public function execute($configFiles) { diff --git a/lib/config/sfSecurityConfigHandler.class.php b/lib/config/sfSecurityConfigHandler.class.php index 092f8e267..dd0b8aa64 100644 --- a/lib/config/sfSecurityConfigHandler.class.php +++ b/lib/config/sfSecurityConfigHandler.class.php @@ -24,9 +24,9 @@ class sfSecurityConfigHandler extends sfYamlConfigHandler * * @return string Data to be written to a cache file * - * @throws sfConfigurationException If a requested configuration file does not exist or is not readable - * @throws sfParseException If a requested configuration file is improperly formatted - * @throws sfInitializationException If a view.yml key check fails + * @throws sfConfigurationException If a requested configuration file does not exist or is not readable + * @throws sfParseException If a requested configuration file is improperly formatted + * @throws sfInitializationException If a view.yml key check fails */ public function execute($configFiles) { diff --git a/lib/config/sfViewConfigHandler.class.php b/lib/config/sfViewConfigHandler.class.php index c34d6d539..56230c775 100644 --- a/lib/config/sfViewConfigHandler.class.php +++ b/lib/config/sfViewConfigHandler.class.php @@ -24,9 +24,9 @@ class sfViewConfigHandler extends sfYamlConfigHandler * * @return string Data to be written to a cache file * - * @throws sfConfigurationException If a requested configuration file does not exist or is not readable - * @throws sfParseException If a requested configuration file is improperly formatted - * @throws sfInitializationException If a view.yml key check fails + * @throws sfConfigurationException If a requested configuration file does not exist or is not readable + * @throws sfParseException If a requested configuration file is improperly formatted + * @throws sfInitializationException If a view.yml key check fails */ public function execute($configFiles) { diff --git a/lib/database/sfDatabase.class.php b/lib/database/sfDatabase.class.php index 9034b2e27..3ff9862b8 100644 --- a/lib/database/sfDatabase.class.php +++ b/lib/database/sfDatabase.class.php @@ -46,7 +46,7 @@ public function __construct($parameters = array()) * * @param array $parameters An associative array of initialization parameters * - * @throws sfInitializationException If an error occurs while initializing this sfDatabase object + * @throws sfInitializationException If an error occurs while initializing this sfDatabase object */ public function initialize($parameters = array()) { @@ -57,7 +57,7 @@ public function initialize($parameters = array()) /** * Connects to the database. * - * @throws sfDatabaseException If a connection could not be created + * @throws sfDatabaseException If a connection could not be created */ abstract public function connect(); @@ -69,7 +69,7 @@ abstract public function connect(); * * @return mixed A database connection * - * @throws sfDatabaseException If a connection could not be retrieved + * @throws sfDatabaseException If a connection could not be retrieved */ public function getConnection() { @@ -85,7 +85,7 @@ public function getConnection() * * @return mixed A database resource * - * @throws sfDatabaseException If a resource could not be retrieved + * @throws sfDatabaseException If a resource could not be retrieved */ public function getResource() { @@ -163,7 +163,7 @@ public function setParameter($name, $value) /** * Executes the shutdown procedure. * - * @throws sfDatabaseException If an error occurs while shutting down this database + * @throws sfDatabaseException If an error occurs while shutting down this database */ abstract public function shutdown(); } diff --git a/lib/database/sfDatabaseManager.class.php b/lib/database/sfDatabaseManager.class.php index d1313aeae..ae0a6927e 100644 --- a/lib/database/sfDatabaseManager.class.php +++ b/lib/database/sfDatabaseManager.class.php @@ -46,7 +46,7 @@ public function __construct(sfProjectConfiguration $configuration, $options = ar * * @param sfProjectConfiguration $configuration A sfProjectConfiguration instance * - * @throws sfInitializationException If an error occurs while initializing this sfDatabaseManager object + * @throws sfInitializationException If an error occurs while initializing this sfDatabaseManager object */ public function initialize(sfProjectConfiguration $configuration) { @@ -90,7 +90,7 @@ public function setDatabase($name, sfDatabase $database) * * @return mixed A Database instance * - * @throws sfDatabaseException If the requested database name does not exist + * @throws sfDatabaseException If the requested database name does not exist */ public function getDatabase($name = 'default') { @@ -115,7 +115,7 @@ public function getNames() /** * Executes the shutdown procedure. * - * @throws sfDatabaseException If an error occurs while shutting down this DatabaseManager + * @throws sfDatabaseException If an error occurs while shutting down this DatabaseManager */ public function shutdown() { diff --git a/lib/database/sfMySQLDatabase.class.php b/lib/database/sfMySQLDatabase.class.php index fac1ccd9f..82e5d8248 100644 --- a/lib/database/sfMySQLDatabase.class.php +++ b/lib/database/sfMySQLDatabase.class.php @@ -30,7 +30,7 @@ class sfMySQLDatabase extends sfDatabase /** * Connects to the database. * - * @throws sfDatabaseException If a connection could not be created + * @throws sfDatabaseException If a connection could not be created */ public function connect() { @@ -77,7 +77,7 @@ public function connect() /** * Execute the shutdown procedure. * - * @throws sfDatabaseException If an error occurs while shutting down this database + * @throws sfDatabaseException If an error occurs while shutting down this database */ public function shutdown() { diff --git a/lib/database/sfMySQLiDatabase.class.php b/lib/database/sfMySQLiDatabase.class.php index 3fb6554e8..a7c485c39 100644 --- a/lib/database/sfMySQLiDatabase.class.php +++ b/lib/database/sfMySQLiDatabase.class.php @@ -32,7 +32,7 @@ public function connect() /** * Execute the shutdown procedure. * - * @throws sfDatabaseException If an error occurs while shutting down this database + * @throws sfDatabaseException If an error occurs while shutting down this database */ public function shutdown() { diff --git a/lib/database/sfPDODatabase.class.php b/lib/database/sfPDODatabase.class.php index 591f09119..d81999960 100644 --- a/lib/database/sfPDODatabase.class.php +++ b/lib/database/sfPDODatabase.class.php @@ -35,7 +35,7 @@ public function __call($method, $arguments) /** * Connects to the database. * - * @throws sfDatabaseException If a connection could not be created + * @throws sfDatabaseException If a connection could not be created */ public function connect() { diff --git a/lib/database/sfPostgreSQLDatabase.class.php b/lib/database/sfPostgreSQLDatabase.class.php index 3ebe5e30c..d5ed1dcbc 100644 --- a/lib/database/sfPostgreSQLDatabase.class.php +++ b/lib/database/sfPostgreSQLDatabase.class.php @@ -31,7 +31,7 @@ class sfPostgreSQLDatabase extends sfDatabase /** * Connects to the database. * - * @throws sfDatabaseException If a connection could not be created + * @throws sfDatabaseException If a connection could not be created */ public function connect() { @@ -68,7 +68,7 @@ public function connect() /** * Executes the shutdown procedure. * - * @throws sfDatabaseException If an error occurs while shutting down this database + * @throws sfDatabaseException If an error occurs while shutting down this database */ public function shutdown() { diff --git a/lib/filter/sfCacheFilter.class.php b/lib/filter/sfCacheFilter.class.php index 6a6352737..fab675605 100644 --- a/lib/filter/sfCacheFilter.class.php +++ b/lib/filter/sfCacheFilter.class.php @@ -29,7 +29,7 @@ class sfCacheFilter extends sfFilter * @param sfContext $context The current application context * @param array $parameters An associative array of initialization parameters * - * @throws sfInitializationException If an error occurs while initializing this Filter + * @throws sfInitializationException If an error occurs while initializing this Filter */ public function initialize($context, $parameters = array()) { diff --git a/lib/filter/sfExecutionFilter.class.php b/lib/filter/sfExecutionFilter.class.php index 96f58bec0..0d79771e5 100644 --- a/lib/filter/sfExecutionFilter.class.php +++ b/lib/filter/sfExecutionFilter.class.php @@ -25,8 +25,8 @@ class sfExecutionFilter extends sfFilter * * @param sfFilterChain $filterChain The filter chain * - * @throws sfInitializeException If an error occurs during view initialization - * @throws sfViewException If an error occurs while executing the view + * @throws sfInitializeException If an error occurs during view initialization + * @throws sfViewException If an error occurs while executing the view */ public function execute($filterChain) { diff --git a/lib/filter/sfRenderingFilter.class.php b/lib/filter/sfRenderingFilter.class.php index 84559ec96..e4175fe61 100644 --- a/lib/filter/sfRenderingFilter.class.php +++ b/lib/filter/sfRenderingFilter.class.php @@ -23,8 +23,8 @@ class sfRenderingFilter extends sfFilter * * @param sfFilterChain $filterChain the filter chain * - * @throws sfInitializeException If an error occurs during view initialization - * @throws sfViewException If an error occurs while executing the view + * @throws sfInitializeException If an error occurs during view initialization + * @throws sfViewException If an error occurs while executing the view */ public function execute($filterChain) { diff --git a/lib/form/sfForm.class.php b/lib/form/sfForm.class.php index 4219541af..5da563636 100644 --- a/lib/form/sfForm.class.php +++ b/lib/form/sfForm.class.php @@ -1060,7 +1060,7 @@ public function offsetGet($name) * @param string $offset (ignored) * @param string $value (ignored) * - * @throws LogicException + * @throws LogicException */ #[\ReturnTypeWillChange] public function offsetSet($offset, $value) diff --git a/lib/log/sfLogger.class.php b/lib/log/sfLogger.class.php index 4bf9cf221..e6fea4c25 100644 --- a/lib/log/sfLogger.class.php +++ b/lib/log/sfLogger.class.php @@ -72,7 +72,7 @@ public function __construct(sfEventDispatcher $dispatcher, $options = array()) * @param sfEventDispatcher $dispatcher A sfEventDispatcher instance * @param array $options an array of options * - * @throws sfInitializationException If an error occurs while initializing this sfLogger + * @throws sfInitializationException If an error occurs while initializing this sfLogger */ public function initialize(sfEventDispatcher $dispatcher, $options = array()) { diff --git a/lib/request/sfRequest.class.php b/lib/request/sfRequest.class.php index 354c3f430..6dffbc1ba 100644 --- a/lib/request/sfRequest.class.php +++ b/lib/request/sfRequest.class.php @@ -67,7 +67,7 @@ public function __construct(sfEventDispatcher $dispatcher, $parameters = array() * * @return mixed The returned value of the called method * - * @throws sfException if call fails + * @throws sfException if call fails */ public function __call($method, $arguments) { @@ -97,7 +97,7 @@ public function __clone() * @param array $attributes An associative array of initialization attributes * @param array $options An associative array of options * - * @throws sfInitializationException If an error occurs while initializing this sfRequest + * @throws sfInitializationException If an error occurs while initializing this sfRequest */ public function initialize(sfEventDispatcher $dispatcher, $parameters = array(), $attributes = array(), $options = array()) { @@ -177,7 +177,7 @@ public function getMethod() * * @param string $method The request method * - * @throws sfException - If the specified request method is invalid + * @throws sfException - If the specified request method is invalid */ public function setMethod($method) { diff --git a/lib/request/sfWebRequest.class.php b/lib/request/sfWebRequest.class.php index 554c04c54..d188d6a5c 100644 --- a/lib/request/sfWebRequest.class.php +++ b/lib/request/sfWebRequest.class.php @@ -53,7 +53,7 @@ class sfWebRequest extends sfRequest * @param array $attributes An associative array of initialization attributes * @param array $options An associative array of options * - * @throws sfInitializationException If an error occurs while initializing this sfRequest + * @throws sfInitializationException If an error occurs while initializing this sfRequest * * @see sfRequest */ @@ -886,7 +886,7 @@ public function getClientIp($proxy = true) /** * Check CSRF protection. * - * @throws sfValidatorErrorSchema If an error occurs while validating the CRF protection for this sfRequest + * @throws sfValidatorErrorSchema If an error occurs while validating the CRF protection for this sfRequest */ public function checkCSRFProtection() { diff --git a/lib/response/sfResponse.class.php b/lib/response/sfResponse.class.php index 3735789b0..776b440cd 100644 --- a/lib/response/sfResponse.class.php +++ b/lib/response/sfResponse.class.php @@ -47,7 +47,7 @@ public function __construct(sfEventDispatcher $dispatcher, $options = array()) * * @return mixed The returned value of the called method * - * @throws sfException If the calls fails + * @throws sfException If the calls fails */ public function __call($method, $arguments) { @@ -89,7 +89,7 @@ public function __unserialize($data) * @param sfEventDispatcher $dispatcher An sfEventDispatcher instance * @param array $options An array of options * - * @throws sfInitializationException If an error occurs while initializing this sfResponse + * @throws sfInitializationException If an error occurs while initializing this sfResponse */ public function initialize(sfEventDispatcher $dispatcher, $options = array()) { diff --git a/lib/response/sfWebResponse.class.php b/lib/response/sfWebResponse.class.php index 675b02993..85cdf2305 100644 --- a/lib/response/sfWebResponse.class.php +++ b/lib/response/sfWebResponse.class.php @@ -114,7 +114,7 @@ public function __unserialize($data) * @param sfEventDispatcher $dispatcher An sfEventDispatcher instance * @param array $options An array of options * - * @throws sfInitializationException If an error occurs while initializing this sfResponse + * @throws sfInitializationException If an error occurs while initializing this sfResponse * * @see sfResponse */ @@ -171,7 +171,7 @@ public function isHeaderOnly() * @param bool $secure If secure * @param bool $httpOnly If uses only HTTP * - * @throws sfException If fails to set the cookie + * @throws sfException If fails to set the cookie */ public function setCookie($name, $value, $expire = null, $path = '/', $domain = '', $secure = false, $httpOnly = false) { diff --git a/lib/storage/sfCacheSessionStorage.class.php b/lib/storage/sfCacheSessionStorage.class.php index eaf08af9b..6dd0442c3 100644 --- a/lib/storage/sfCacheSessionStorage.class.php +++ b/lib/storage/sfCacheSessionStorage.class.php @@ -47,7 +47,7 @@ class sfCacheSessionStorage extends sfStorage * * @return bool true, when initialization completes successfully * - * @throws sfInitializationException If an error occurs while initializing this Storage + * @throws sfInitializationException If an error occurs while initializing this Storage */ public function initialize($options = array()) { @@ -215,7 +215,7 @@ public function remove($key) * * @return bool True if session regenerated, false if error * - * @throws sfStorageException If an error occurs while regenerating this storage + * @throws sfStorageException If an error occurs while regenerating this storage */ public function regenerate($destroy = false) { @@ -263,7 +263,7 @@ public function expire() /** * Executes the shutdown procedure. * - * @throws sfStorageException If an error occurs while shutting down this storage + * @throws sfStorageException If an error occurs while shutting down this storage */ public function shutdown() { diff --git a/lib/storage/sfDatabaseSessionStorage.class.php b/lib/storage/sfDatabaseSessionStorage.class.php index c9ac23065..580d4b209 100644 --- a/lib/storage/sfDatabaseSessionStorage.class.php +++ b/lib/storage/sfDatabaseSessionStorage.class.php @@ -97,7 +97,7 @@ public function sessionClose() * * @return bool true, if the session was opened, otherwise an exception is thrown * - * @throws DatabaseException If a connection with the database does not exist or cannot be created + * @throws DatabaseException If a connection with the database does not exist or cannot be created */ public function sessionOpen($path = null, $name = null) { @@ -131,7 +131,7 @@ public function sessionOpen($path = null, $name = null) * * @return bool true, if the session was destroyed, otherwise an exception is thrown * - * @throws DatabaseException If the session cannot be destroyed + * @throws DatabaseException If the session cannot be destroyed */ abstract public function sessionDestroy($id); @@ -142,7 +142,7 @@ abstract public function sessionDestroy($id); * * @return bool true, if old sessions have been cleaned, otherwise an exception is thrown * - * @throws DatabaseException If any old sessions cannot be cleaned + * @throws DatabaseException If any old sessions cannot be cleaned */ abstract public function sessionGC($lifetime); @@ -153,7 +153,7 @@ abstract public function sessionGC($lifetime); * * @return bool true, if the session was read, otherwise an exception is thrown * - * @throws DatabaseException If the session cannot be read + * @throws DatabaseException If the session cannot be read */ abstract public function sessionRead($id); @@ -165,7 +165,7 @@ abstract public function sessionRead($id); * * @return bool true, if the session was written, otherwise an exception is thrown * - * @throws DatabaseException If the session data cannot be written + * @throws DatabaseException If the session data cannot be written */ abstract public function sessionWrite($id, $data); diff --git a/lib/storage/sfMySQLSessionStorage.class.php b/lib/storage/sfMySQLSessionStorage.class.php index 9ce5c1cf8..d1ac7e0ae 100644 --- a/lib/storage/sfMySQLSessionStorage.class.php +++ b/lib/storage/sfMySQLSessionStorage.class.php @@ -29,7 +29,7 @@ class sfMySQLSessionStorage extends sfDatabaseSessionStorage * * @return bool true, if the session was destroyed, otherwise an exception is thrown * - * @throws sfDatabaseException If the session cannot be destroyed + * @throws sfDatabaseException If the session cannot be destroyed */ public function sessionDestroy($id) { @@ -58,7 +58,7 @@ public function sessionDestroy($id) * * @return bool true, if old sessions have been cleaned, otherwise an exception is thrown * - * @throws sfDatabaseException If any old sessions cannot be cleaned + * @throws sfDatabaseException If any old sessions cannot be cleaned */ public function sessionGC($lifetime) { @@ -84,7 +84,7 @@ public function sessionGC($lifetime) * * @return string The session data if the session was read or created, otherwise an exception is thrown * - * @throws sfDatabaseException If the session cannot be read + * @throws sfDatabaseException If the session cannot be read */ public function sessionRead($id) { @@ -127,7 +127,7 @@ public function sessionRead($id) * * @return bool true, if the session was written, otherwise an exception is thrown * - * @throws sfDatabaseException If the session data cannot be written + * @throws sfDatabaseException If the session data cannot be written */ public function sessionWrite($id, $data) { diff --git a/lib/storage/sfNoStorage.class.php b/lib/storage/sfNoStorage.class.php index 81906e3bb..0b65a6626 100644 --- a/lib/storage/sfNoStorage.class.php +++ b/lib/storage/sfNoStorage.class.php @@ -31,7 +31,7 @@ class sfNoStorage extends sfStorage * * @return mixed Data associated with the key * - * @throws sfStorageException If an error occurs while reading data from this storage + * @throws sfStorageException If an error occurs while reading data from this storage */ public function read($key) { @@ -47,7 +47,7 @@ public function read($key) * * @return mixed Data associated with the key * - * @throws sfStorageException If an error occurs while removing data from this storage + * @throws sfStorageException If an error occurs while removing data from this storage */ public function remove($key) { @@ -62,7 +62,7 @@ public function remove($key) * @param string $key A unique key identifying your data * @param mixed $data Data associated with your key * - * @throws sfStorageException If an error occurs while writing to this storage + * @throws sfStorageException If an error occurs while writing to this storage */ public function write($key, $data) { @@ -83,7 +83,7 @@ public function regenerate($destroy = false) /** * Executes the shutdown procedure. * - * @throws sfStorageException If an error occurs while shutting down this storage + * @throws sfStorageException If an error occurs while shutting down this storage */ public function shutdown() { diff --git a/lib/storage/sfPDOSessionStorage.class.php b/lib/storage/sfPDOSessionStorage.class.php index dd84e9289..fd69b1b08 100644 --- a/lib/storage/sfPDOSessionStorage.class.php +++ b/lib/storage/sfPDOSessionStorage.class.php @@ -29,7 +29,7 @@ class sfPDOSessionStorage extends sfDatabaseSessionStorage * * @return bool true, if the session was destroyed, otherwise an exception is thrown * - * @throws DatabaseException If the session cannot be destroyed + * @throws DatabaseException If the session cannot be destroyed */ public function sessionDestroy($id) { @@ -58,7 +58,7 @@ public function sessionDestroy($id) * * @return bool true, if old sessions have been cleaned, otherwise an exception is thrown * - * @throws DatabaseException If any old sessions cannot be cleaned + * @throws DatabaseException If any old sessions cannot be cleaned */ public function sessionGC($lifetime) { @@ -85,7 +85,7 @@ public function sessionGC($lifetime) * * @return string The session data if the session was read or created, otherwise an exception is thrown * - * @throws DatabaseException If the session cannot be read + * @throws DatabaseException If the session cannot be read */ public function sessionRead($id) { @@ -132,7 +132,7 @@ public function sessionRead($id) * * @return bool true, if the session was written, otherwise an exception is thrown * - * @throws DatabaseException If the session data cannot be written + * @throws DatabaseException If the session data cannot be written */ public function sessionWrite($id, $data) { diff --git a/lib/storage/sfPostgreSQLSessionStorage.class.php b/lib/storage/sfPostgreSQLSessionStorage.class.php index adc576bb3..e387222c9 100644 --- a/lib/storage/sfPostgreSQLSessionStorage.class.php +++ b/lib/storage/sfPostgreSQLSessionStorage.class.php @@ -28,7 +28,7 @@ class sfPostgreSQLSessionStorage extends sfDatabaseSessionStorage * * @return bool true, if the session was destroyed, otherwise an exception is thrown * - * @throws sfDatabaseException If the session cannot be destroyed + * @throws sfDatabaseException If the session cannot be destroyed */ public function sessionDestroy($id) { @@ -57,7 +57,7 @@ public function sessionDestroy($id) * * @return bool true, if old sessions have been cleaned, otherwise an exception is thrown * - * @throws sfDatabaseException If any old sessions cannot be cleaned + * @throws sfDatabaseException If any old sessions cannot be cleaned */ public function sessionGC($lifetime) { @@ -82,7 +82,7 @@ public function sessionGC($lifetime) * * @return string The session data if the session was read or created, otherwise an exception is thrown * - * @throws sfDatabaseException If the session cannot be read + * @throws sfDatabaseException If the session cannot be read */ public function sessionRead($id) { @@ -126,7 +126,7 @@ public function sessionRead($id) * * @return bool true, if the session was written, otherwise an exception is thrown * - * @throws sfDatabaseException If the session data cannot be written + * @throws sfDatabaseException If the session data cannot be written */ public function sessionWrite($id, $data) { diff --git a/lib/storage/sfStorage.class.php b/lib/storage/sfStorage.class.php index 552aba56d..553b051b5 100644 --- a/lib/storage/sfStorage.class.php +++ b/lib/storage/sfStorage.class.php @@ -46,7 +46,7 @@ public function __construct($options = array()) * * @param array $options An associative array of options * - * @throws sfInitializationException If an error occurs while initializing this sfStorage + * @throws sfInitializationException If an error occurs while initializing this sfStorage */ public function initialize($options = array()) { @@ -74,7 +74,7 @@ public function getOptions() * * @return mixed Data associated with the key * - * @throws sfStorageException If an error occurs while reading data from this storage + * @throws sfStorageException If an error occurs while reading data from this storage */ abstract public function read($key); @@ -85,7 +85,7 @@ abstract public function read($key); * * @return bool True if session regenerated, false if error * - * @throws sfStorageException If an error occurs while regenerating this storage + * @throws sfStorageException If an error occurs while regenerating this storage */ abstract public function regenerate($destroy = false); @@ -98,14 +98,14 @@ abstract public function regenerate($destroy = false); * * @return mixed Data associated with the key * - * @throws sfStorageException If an error occurs while removing data from this storage + * @throws sfStorageException If an error occurs while removing data from this storage */ abstract public function remove($key); /** * Executes the shutdown procedure. * - * @throws sfStorageException If an error occurs while shutting down this storage + * @throws sfStorageException If an error occurs while shutting down this storage */ abstract public function shutdown(); @@ -117,7 +117,7 @@ abstract public function shutdown(); * @param string $key A unique key identifying your data * @param mixed $data Data associated with your key * - * @throws sfStorageException If an error occurs while writing to this storage + * @throws sfStorageException If an error occurs while writing to this storage */ abstract public function write($key, $data); } diff --git a/lib/util/sfContext.class.php b/lib/util/sfContext.class.php index 5000c0e50..ebb6bdce8 100644 --- a/lib/util/sfContext.class.php +++ b/lib/util/sfContext.class.php @@ -45,7 +45,7 @@ class sfContext implements ArrayAccess * * @return mixed The returned value of the called method * - * @throws sfException if call fails + * @throws sfException if call fails */ public function __call($method, $arguments) {