Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

fix(phpdoc) remove html code from throws phpdoc. phpstan don't like this #309

Merged
merged 1 commit into from
Jan 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/cache/sfCache.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public function __construct($options = array())
*
* * lifetime (optional): The default life time (default value: 86400)
*
* @throws <b>sfInitializationException</b> 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())
{
Expand Down
6 changes: 3 additions & 3 deletions lib/config/sfCacheConfigHandler.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ class sfCacheConfigHandler extends sfYamlConfigHandler
*
* @return string Data to be written to a cache file
*
* @throws <b>sfConfigurationException</b> If a requested configuration file does not exist or is not readable
* @throws <b>sfParseException</b> If a requested configuration file is improperly formatted
* @throws <b>sfInitializationException</b> 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)
{
Expand Down
6 changes: 3 additions & 3 deletions lib/config/sfConfigCache.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 <b>sfConfigurationException</b> If a requested configuration file does not exist
* @throws sfConfigurationException If a requested configuration file does not exist
*
* @see sfConfiguration::getConfigPaths()
*/
Expand Down Expand Up @@ -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 <b>sfConfigurationException</b> 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)
{
Expand Down Expand Up @@ -251,7 +251,7 @@ protected function getHandler($name)
/**
* Loads all configuration application and module level handlers.
*
* @throws <b>sfConfigurationException</b> If a configuration related error occurs
* @throws sfConfigurationException If a configuration related error occurs
*/
protected function loadConfigHandlers()
{
Expand Down
6 changes: 3 additions & 3 deletions lib/config/sfConfigHandler.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public function __construct($parameters = null)
*
* @param array $parameters An associative array of initialization parameters
*
* @throws <b>sfInitializationException</b> If an error occurs while initializing this ConfigHandler
* @throws sfInitializationException If an error occurs while initializing this ConfigHandler
*/
public function initialize($parameters = null)
{
Expand All @@ -56,8 +56,8 @@ public function initialize($parameters = null)
*
* @return string Data to be written to a cache file
*
* @throws <b>sfConfigurationException</b> If a requested configuration file does not exist or is not readable
* @throws <b>sfParseException</b> 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);

Expand Down
4 changes: 2 additions & 2 deletions lib/config/sfFactoryConfigHandler.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ class sfFactoryConfigHandler extends sfYamlConfigHandler
*
* @return string Data to be written to a cache file
*
* @throws <b>sfConfigurationException</b> If a requested configuration file does not exist or is not readable
* @throws <b>sfParseException</b> 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)
{
Expand Down
6 changes: 3 additions & 3 deletions lib/config/sfSecurityConfigHandler.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ class sfSecurityConfigHandler extends sfYamlConfigHandler
*
* @return string Data to be written to a cache file
*
* @throws <b>sfConfigurationException</b> If a requested configuration file does not exist or is not readable
* @throws <b>sfParseException</b> If a requested configuration file is improperly formatted
* @throws <b>sfInitializationException</b> 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)
{
Expand Down
6 changes: 3 additions & 3 deletions lib/config/sfViewConfigHandler.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ class sfViewConfigHandler extends sfYamlConfigHandler
*
* @return string Data to be written to a cache file
*
* @throws <b>sfConfigurationException</b> If a requested configuration file does not exist or is not readable
* @throws <b>sfParseException</b> If a requested configuration file is improperly formatted
* @throws <b>sfInitializationException</b> 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)
{
Expand Down
10 changes: 5 additions & 5 deletions lib/database/sfDatabase.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public function __construct($parameters = array())
*
* @param array $parameters An associative array of initialization parameters
*
* @throws <b>sfInitializationException</b> 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())
{
Expand All @@ -57,7 +57,7 @@ public function initialize($parameters = array())
/**
* Connects to the database.
*
* @throws <b>sfDatabaseException</b> If a connection could not be created
* @throws sfDatabaseException If a connection could not be created
*/
abstract public function connect();

Expand All @@ -69,7 +69,7 @@ abstract public function connect();
*
* @return mixed A database connection
*
* @throws <b>sfDatabaseException</b> If a connection could not be retrieved
* @throws sfDatabaseException If a connection could not be retrieved
*/
public function getConnection()
{
Expand All @@ -85,7 +85,7 @@ public function getConnection()
*
* @return mixed A database resource
*
* @throws <b>sfDatabaseException</b> If a resource could not be retrieved
* @throws sfDatabaseException If a resource could not be retrieved
*/
public function getResource()
{
Expand Down Expand Up @@ -163,7 +163,7 @@ public function setParameter($name, $value)
/**
* Executes the shutdown procedure.
*
* @throws <b>sfDatabaseException</b> If an error occurs while shutting down this database
* @throws sfDatabaseException If an error occurs while shutting down this database
*/
abstract public function shutdown();
}
6 changes: 3 additions & 3 deletions lib/database/sfDatabaseManager.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public function __construct(sfProjectConfiguration $configuration, $options = ar
*
* @param sfProjectConfiguration $configuration A sfProjectConfiguration instance
*
* @throws <b>sfInitializationException</b> 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)
{
Expand Down Expand Up @@ -90,7 +90,7 @@ public function setDatabase($name, sfDatabase $database)
*
* @return mixed A Database instance
*
* @throws <b>sfDatabaseException</b> If the requested database name does not exist
* @throws sfDatabaseException If the requested database name does not exist
*/
public function getDatabase($name = 'default')
{
Expand All @@ -115,7 +115,7 @@ public function getNames()
/**
* Executes the shutdown procedure.
*
* @throws <b>sfDatabaseException</b> If an error occurs while shutting down this DatabaseManager
* @throws sfDatabaseException If an error occurs while shutting down this DatabaseManager
*/
public function shutdown()
{
Expand Down
4 changes: 2 additions & 2 deletions lib/database/sfMySQLDatabase.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class sfMySQLDatabase extends sfDatabase
/**
* Connects to the database.
*
* @throws <b>sfDatabaseException</b> If a connection could not be created
* @throws sfDatabaseException If a connection could not be created
*/
public function connect()
{
Expand Down Expand Up @@ -77,7 +77,7 @@ public function connect()
/**
* Execute the shutdown procedure.
*
* @throws <b>sfDatabaseException</b> If an error occurs while shutting down this database
* @throws sfDatabaseException If an error occurs while shutting down this database
*/
public function shutdown()
{
Expand Down
2 changes: 1 addition & 1 deletion lib/database/sfMySQLiDatabase.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public function connect()
/**
* Execute the shutdown procedure.
*
* @throws <b>sfDatabaseException</b> If an error occurs while shutting down this database
* @throws sfDatabaseException If an error occurs while shutting down this database
*/
public function shutdown()
{
Expand Down
2 changes: 1 addition & 1 deletion lib/database/sfPDODatabase.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public function __call($method, $arguments)
/**
* Connects to the database.
*
* @throws <b>sfDatabaseException</b> If a connection could not be created
* @throws sfDatabaseException If a connection could not be created
*/
public function connect()
{
Expand Down
4 changes: 2 additions & 2 deletions lib/database/sfPostgreSQLDatabase.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class sfPostgreSQLDatabase extends sfDatabase
/**
* Connects to the database.
*
* @throws <b>sfDatabaseException</b> If a connection could not be created
* @throws sfDatabaseException If a connection could not be created
*/
public function connect()
{
Expand Down Expand Up @@ -68,7 +68,7 @@ public function connect()
/**
* Executes the shutdown procedure.
*
* @throws <b>sfDatabaseException</b> If an error occurs while shutting down this database
* @throws sfDatabaseException If an error occurs while shutting down this database
*/
public function shutdown()
{
Expand Down
2 changes: 1 addition & 1 deletion lib/filter/sfCacheFilter.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 <b>sfInitializationException</b> If an error occurs while initializing this Filter
* @throws sfInitializationException If an error occurs while initializing this Filter
*/
public function initialize($context, $parameters = array())
{
Expand Down
4 changes: 2 additions & 2 deletions lib/filter/sfExecutionFilter.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ class sfExecutionFilter extends sfFilter
*
* @param sfFilterChain $filterChain The filter chain
*
* @throws <b>sfInitializeException</b> If an error occurs during view initialization
* @throws <b>sfViewException</b> 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)
{
Expand Down
4 changes: 2 additions & 2 deletions lib/filter/sfRenderingFilter.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ class sfRenderingFilter extends sfFilter
*
* @param sfFilterChain $filterChain the filter chain
*
* @throws <b>sfInitializeException</b> If an error occurs during view initialization
* @throws <b>sfViewException</b> 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)
{
Expand Down
2 changes: 1 addition & 1 deletion lib/form/sfForm.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -1060,7 +1060,7 @@ public function offsetGet($name)
* @param string $offset (ignored)
* @param string $value (ignored)
*
* @throws <b>LogicException</b>
* @throws LogicException
*/
#[\ReturnTypeWillChange]
public function offsetSet($offset, $value)
Expand Down
2 changes: 1 addition & 1 deletion lib/log/sfLogger.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 <b>sfInitializationException</b> 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())
{
Expand Down
6 changes: 3 additions & 3 deletions lib/request/sfRequest.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public function __construct(sfEventDispatcher $dispatcher, $parameters = array()
*
* @return mixed The returned value of the called method
*
* @throws <b>sfException</b> if call fails
* @throws sfException if call fails
*/
public function __call($method, $arguments)
{
Expand Down Expand Up @@ -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 <b>sfInitializationException</b> 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())
{
Expand Down Expand Up @@ -177,7 +177,7 @@ public function getMethod()
*
* @param string $method The request method
*
* @throws <b>sfException</b> - If the specified request method is invalid
* @throws sfException - If the specified request method is invalid
*/
public function setMethod($method)
{
Expand Down
4 changes: 2 additions & 2 deletions lib/request/sfWebRequest.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 <b>sfInitializationException</b> If an error occurs while initializing this sfRequest
* @throws sfInitializationException If an error occurs while initializing this sfRequest
*
* @see sfRequest
*/
Expand Down Expand Up @@ -886,7 +886,7 @@ public function getClientIp($proxy = true)
/**
* Check CSRF protection.
*
* @throws <b>sfValidatorErrorSchema</b> 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()
{
Expand Down
4 changes: 2 additions & 2 deletions lib/response/sfResponse.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public function __construct(sfEventDispatcher $dispatcher, $options = array())
*
* @return mixed The returned value of the called method
*
* @throws <b>sfException</b> If the calls fails
* @throws sfException If the calls fails
*/
public function __call($method, $arguments)
{
Expand Down Expand Up @@ -89,7 +89,7 @@ public function __unserialize($data)
* @param sfEventDispatcher $dispatcher An sfEventDispatcher instance
* @param array $options An array of options
*
* @throws <b>sfInitializationException</b> 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())
{
Expand Down
4 changes: 2 additions & 2 deletions lib/response/sfWebResponse.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ public function __unserialize($data)
* @param sfEventDispatcher $dispatcher An sfEventDispatcher instance
* @param array $options An array of options
*
* @throws <b>sfInitializationException</b> If an error occurs while initializing this sfResponse
* @throws sfInitializationException If an error occurs while initializing this sfResponse
*
* @see sfResponse
*/
Expand Down Expand Up @@ -171,7 +171,7 @@ public function isHeaderOnly()
* @param bool $secure If secure
* @param bool $httpOnly If uses only HTTP
*
* @throws <b>sfException</b> 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)
{
Expand Down
6 changes: 3 additions & 3 deletions lib/storage/sfCacheSessionStorage.class.php
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ class sfCacheSessionStorage extends sfStorage
*
* @return bool true, when initialization completes successfully
*
* @throws <b>sfInitializationException</b> If an error occurs while initializing this Storage
* @throws sfInitializationException If an error occurs while initializing this Storage
*/
public function initialize($options = array())
{
Expand Down Expand Up @@ -215,7 +215,7 @@ public function remove($key)
*
* @return bool True if session regenerated, false if error
*
* @throws <b>sfStorageException</b> If an error occurs while regenerating this storage
* @throws sfStorageException If an error occurs while regenerating this storage
*/
public function regenerate($destroy = false)
{
Expand Down Expand Up @@ -263,7 +263,7 @@ public function expire()
/**
* Executes the shutdown procedure.
*
* @throws <b>sfStorageException</b> If an error occurs while shutting down this storage
* @throws sfStorageException If an error occurs while shutting down this storage
*/
public function shutdown()
{
Expand Down
Loading