Skip to content

Commit e6e9f94

Browse files
connorhuthePanz
connorhu
authored and
thePanz
committed
fix(phpdoc) remove html code from throws phpdoc. phpstan don't like this
1 parent d90dc72 commit e6e9f94

30 files changed

+79
-79
lines changed

‎lib/cache/sfCache.class.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ public function __construct($options = array())
5050
*
5151
* * lifetime (optional): The default life time (default value: 86400)
5252
*
53-
* @throws <b>sfInitializationException</b> If an error occurs while initializing this sfCache instance
53+
* @throws sfInitializationException If an error occurs while initializing this sfCache instance
5454
*/
5555
public function initialize($options = array())
5656
{

‎lib/config/sfCacheConfigHandler.class.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ class sfCacheConfigHandler extends sfYamlConfigHandler
2626
*
2727
* @return string Data to be written to a cache file
2828
*
29-
* @throws <b>sfConfigurationException</b> If a requested configuration file does not exist or is not readable
30-
* @throws <b>sfParseException</b> If a requested configuration file is improperly formatted
31-
* @throws <b>sfInitializationException</b> If a cache.yml key check fails
29+
* @throws sfConfigurationException If a requested configuration file does not exist or is not readable
30+
* @throws sfParseException If a requested configuration file is improperly formatted
31+
* @throws sfInitializationException If a cache.yml key check fails
3232
*/
3333
public function execute($configFiles)
3434
{

‎lib/config/sfConfigCache.class.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public function __construct(sfApplicationConfiguration $configuration)
4949
*
5050
* @return string An absolute filesystem path to the cache filename associated with this specified configuration file
5151
*
52-
* @throws <b>sfConfigurationException</b> If a requested configuration file does not exist
52+
* @throws sfConfigurationException If a requested configuration file does not exist
5353
*
5454
* @see sfConfiguration::getConfigPaths()
5555
*/
@@ -175,7 +175,7 @@ public function registerConfigHandler($handler, $class, $params = array())
175175
* @param array $configs An array of absolute filesystem paths to configuration files
176176
* @param string $cache An absolute filesystem path to the cache file that will be written
177177
*
178-
* @throws <b>sfConfigurationException</b> If a requested configuration file does not have an associated configuration handler
178+
* @throws sfConfigurationException If a requested configuration file does not have an associated configuration handler
179179
*/
180180
protected function callHandler($handler, $configs, $cache)
181181
{
@@ -251,7 +251,7 @@ protected function getHandler($name)
251251
/**
252252
* Loads all configuration application and module level handlers.
253253
*
254-
* @throws <b>sfConfigurationException</b> If a configuration related error occurs
254+
* @throws sfConfigurationException If a configuration related error occurs
255255
*/
256256
protected function loadConfigHandlers()
257257
{

‎lib/config/sfConfigHandler.class.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public function __construct($parameters = null)
4141
*
4242
* @param array $parameters An associative array of initialization parameters
4343
*
44-
* @throws <b>sfInitializationException</b> If an error occurs while initializing this ConfigHandler
44+
* @throws sfInitializationException If an error occurs while initializing this ConfigHandler
4545
*/
4646
public function initialize($parameters = null)
4747
{
@@ -56,8 +56,8 @@ public function initialize($parameters = null)
5656
*
5757
* @return string Data to be written to a cache file
5858
*
59-
* @throws <b>sfConfigurationException</b> If a requested configuration file does not exist or is not readable
60-
* @throws <b>sfParseException</b> If a requested configuration file is improperly formatted
59+
* @throws sfConfigurationException If a requested configuration file does not exist or is not readable
60+
* @throws sfParseException If a requested configuration file is improperly formatted
6161
*/
6262
abstract public function execute($configFiles);
6363

‎lib/config/sfFactoryConfigHandler.class.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ class sfFactoryConfigHandler extends sfYamlConfigHandler
2727
*
2828
* @return string Data to be written to a cache file
2929
*
30-
* @throws <b>sfConfigurationException</b> If a requested configuration file does not exist or is not readable
31-
* @throws <b>sfParseException</b> If a requested configuration file is improperly formatted
30+
* @throws sfConfigurationException If a requested configuration file does not exist or is not readable
31+
* @throws sfParseException If a requested configuration file is improperly formatted
3232
*/
3333
public function execute($configFiles)
3434
{

‎lib/config/sfSecurityConfigHandler.class.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ class sfSecurityConfigHandler extends sfYamlConfigHandler
2424
*
2525
* @return string Data to be written to a cache file
2626
*
27-
* @throws <b>sfConfigurationException</b> If a requested configuration file does not exist or is not readable
28-
* @throws <b>sfParseException</b> If a requested configuration file is improperly formatted
29-
* @throws <b>sfInitializationException</b> If a view.yml key check fails
27+
* @throws sfConfigurationException If a requested configuration file does not exist or is not readable
28+
* @throws sfParseException If a requested configuration file is improperly formatted
29+
* @throws sfInitializationException If a view.yml key check fails
3030
*/
3131
public function execute($configFiles)
3232
{

‎lib/config/sfViewConfigHandler.class.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ class sfViewConfigHandler extends sfYamlConfigHandler
2424
*
2525
* @return string Data to be written to a cache file
2626
*
27-
* @throws <b>sfConfigurationException</b> If a requested configuration file does not exist or is not readable
28-
* @throws <b>sfParseException</b> If a requested configuration file is improperly formatted
29-
* @throws <b>sfInitializationException</b> If a view.yml key check fails
27+
* @throws sfConfigurationException If a requested configuration file does not exist or is not readable
28+
* @throws sfParseException If a requested configuration file is improperly formatted
29+
* @throws sfInitializationException If a view.yml key check fails
3030
*/
3131
public function execute($configFiles)
3232
{

‎lib/database/sfDatabase.class.php

+5-5
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public function __construct($parameters = array())
4646
*
4747
* @param array $parameters An associative array of initialization parameters
4848
*
49-
* @throws <b>sfInitializationException</b> If an error occurs while initializing this sfDatabase object
49+
* @throws sfInitializationException If an error occurs while initializing this sfDatabase object
5050
*/
5151
public function initialize($parameters = array())
5252
{
@@ -57,7 +57,7 @@ public function initialize($parameters = array())
5757
/**
5858
* Connects to the database.
5959
*
60-
* @throws <b>sfDatabaseException</b> If a connection could not be created
60+
* @throws sfDatabaseException If a connection could not be created
6161
*/
6262
abstract public function connect();
6363

@@ -69,7 +69,7 @@ abstract public function connect();
6969
*
7070
* @return mixed A database connection
7171
*
72-
* @throws <b>sfDatabaseException</b> If a connection could not be retrieved
72+
* @throws sfDatabaseException If a connection could not be retrieved
7373
*/
7474
public function getConnection()
7575
{
@@ -85,7 +85,7 @@ public function getConnection()
8585
*
8686
* @return mixed A database resource
8787
*
88-
* @throws <b>sfDatabaseException</b> If a resource could not be retrieved
88+
* @throws sfDatabaseException If a resource could not be retrieved
8989
*/
9090
public function getResource()
9191
{
@@ -163,7 +163,7 @@ public function setParameter($name, $value)
163163
/**
164164
* Executes the shutdown procedure.
165165
*
166-
* @throws <b>sfDatabaseException</b> If an error occurs while shutting down this database
166+
* @throws sfDatabaseException If an error occurs while shutting down this database
167167
*/
168168
abstract public function shutdown();
169169
}

‎lib/database/sfDatabaseManager.class.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public function __construct(sfProjectConfiguration $configuration, $options = ar
4646
*
4747
* @param sfProjectConfiguration $configuration A sfProjectConfiguration instance
4848
*
49-
* @throws <b>sfInitializationException</b> If an error occurs while initializing this sfDatabaseManager object
49+
* @throws sfInitializationException If an error occurs while initializing this sfDatabaseManager object
5050
*/
5151
public function initialize(sfProjectConfiguration $configuration)
5252
{
@@ -90,7 +90,7 @@ public function setDatabase($name, sfDatabase $database)
9090
*
9191
* @return mixed A Database instance
9292
*
93-
* @throws <b>sfDatabaseException</b> If the requested database name does not exist
93+
* @throws sfDatabaseException If the requested database name does not exist
9494
*/
9595
public function getDatabase($name = 'default')
9696
{
@@ -115,7 +115,7 @@ public function getNames()
115115
/**
116116
* Executes the shutdown procedure.
117117
*
118-
* @throws <b>sfDatabaseException</b> If an error occurs while shutting down this DatabaseManager
118+
* @throws sfDatabaseException If an error occurs while shutting down this DatabaseManager
119119
*/
120120
public function shutdown()
121121
{

‎lib/database/sfMySQLDatabase.class.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ class sfMySQLDatabase extends sfDatabase
3030
/**
3131
* Connects to the database.
3232
*
33-
* @throws <b>sfDatabaseException</b> If a connection could not be created
33+
* @throws sfDatabaseException If a connection could not be created
3434
*/
3535
public function connect()
3636
{
@@ -77,7 +77,7 @@ public function connect()
7777
/**
7878
* Execute the shutdown procedure.
7979
*
80-
* @throws <b>sfDatabaseException</b> If an error occurs while shutting down this database
80+
* @throws sfDatabaseException If an error occurs while shutting down this database
8181
*/
8282
public function shutdown()
8383
{

‎lib/database/sfMySQLiDatabase.class.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public function connect()
3232
/**
3333
* Execute the shutdown procedure.
3434
*
35-
* @throws <b>sfDatabaseException</b> If an error occurs while shutting down this database
35+
* @throws sfDatabaseException If an error occurs while shutting down this database
3636
*/
3737
public function shutdown()
3838
{

‎lib/database/sfPDODatabase.class.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public function __call($method, $arguments)
3535
/**
3636
* Connects to the database.
3737
*
38-
* @throws <b>sfDatabaseException</b> If a connection could not be created
38+
* @throws sfDatabaseException If a connection could not be created
3939
*/
4040
public function connect()
4141
{

‎lib/database/sfPostgreSQLDatabase.class.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class sfPostgreSQLDatabase extends sfDatabase
3131
/**
3232
* Connects to the database.
3333
*
34-
* @throws <b>sfDatabaseException</b> If a connection could not be created
34+
* @throws sfDatabaseException If a connection could not be created
3535
*/
3636
public function connect()
3737
{
@@ -68,7 +68,7 @@ public function connect()
6868
/**
6969
* Executes the shutdown procedure.
7070
*
71-
* @throws <b>sfDatabaseException</b> If an error occurs while shutting down this database
71+
* @throws sfDatabaseException If an error occurs while shutting down this database
7272
*/
7373
public function shutdown()
7474
{

‎lib/filter/sfCacheFilter.class.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ class sfCacheFilter extends sfFilter
2929
* @param sfContext $context The current application context
3030
* @param array $parameters An associative array of initialization parameters
3131
*
32-
* @throws <b>sfInitializationException</b> If an error occurs while initializing this Filter
32+
* @throws sfInitializationException If an error occurs while initializing this Filter
3333
*/
3434
public function initialize($context, $parameters = array())
3535
{

‎lib/filter/sfExecutionFilter.class.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ class sfExecutionFilter extends sfFilter
2525
*
2626
* @param sfFilterChain $filterChain The filter chain
2727
*
28-
* @throws <b>sfInitializeException</b> If an error occurs during view initialization
29-
* @throws <b>sfViewException</b> If an error occurs while executing the view
28+
* @throws sfInitializeException If an error occurs during view initialization
29+
* @throws sfViewException If an error occurs while executing the view
3030
*/
3131
public function execute($filterChain)
3232
{

‎lib/filter/sfRenderingFilter.class.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ class sfRenderingFilter extends sfFilter
2323
*
2424
* @param sfFilterChain $filterChain the filter chain
2525
*
26-
* @throws <b>sfInitializeException</b> If an error occurs during view initialization
27-
* @throws <b>sfViewException</b> If an error occurs while executing the view
26+
* @throws sfInitializeException If an error occurs during view initialization
27+
* @throws sfViewException If an error occurs while executing the view
2828
*/
2929
public function execute($filterChain)
3030
{

‎lib/form/sfForm.class.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -1060,7 +1060,7 @@ public function offsetGet($name)
10601060
* @param string $offset (ignored)
10611061
* @param string $value (ignored)
10621062
*
1063-
* @throws <b>LogicException</b>
1063+
* @throws LogicException
10641064
*/
10651065
#[\ReturnTypeWillChange]
10661066
public function offsetSet($offset, $value)

‎lib/log/sfLogger.class.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public function __construct(sfEventDispatcher $dispatcher, $options = array())
7272
* @param sfEventDispatcher $dispatcher A sfEventDispatcher instance
7373
* @param array $options an array of options
7474
*
75-
* @throws <b>sfInitializationException</b> If an error occurs while initializing this sfLogger
75+
* @throws sfInitializationException If an error occurs while initializing this sfLogger
7676
*/
7777
public function initialize(sfEventDispatcher $dispatcher, $options = array())
7878
{

‎lib/request/sfRequest.class.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public function __construct(sfEventDispatcher $dispatcher, $parameters = array()
6767
*
6868
* @return mixed The returned value of the called method
6969
*
70-
* @throws <b>sfException</b> if call fails
70+
* @throws sfException if call fails
7171
*/
7272
public function __call($method, $arguments)
7373
{
@@ -97,7 +97,7 @@ public function __clone()
9797
* @param array $attributes An associative array of initialization attributes
9898
* @param array $options An associative array of options
9999
*
100-
* @throws <b>sfInitializationException</b> If an error occurs while initializing this sfRequest
100+
* @throws sfInitializationException If an error occurs while initializing this sfRequest
101101
*/
102102
public function initialize(sfEventDispatcher $dispatcher, $parameters = array(), $attributes = array(), $options = array())
103103
{
@@ -177,7 +177,7 @@ public function getMethod()
177177
*
178178
* @param string $method The request method
179179
*
180-
* @throws <b>sfException</b> - If the specified request method is invalid
180+
* @throws sfException - If the specified request method is invalid
181181
*/
182182
public function setMethod($method)
183183
{

‎lib/request/sfWebRequest.class.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class sfWebRequest extends sfRequest
5353
* @param array $attributes An associative array of initialization attributes
5454
* @param array $options An associative array of options
5555
*
56-
* @throws <b>sfInitializationException</b> If an error occurs while initializing this sfRequest
56+
* @throws sfInitializationException If an error occurs while initializing this sfRequest
5757
*
5858
* @see sfRequest
5959
*/
@@ -886,7 +886,7 @@ public function getClientIp($proxy = true)
886886
/**
887887
* Check CSRF protection.
888888
*
889-
* @throws <b>sfValidatorErrorSchema</b> If an error occurs while validating the CRF protection for this sfRequest
889+
* @throws sfValidatorErrorSchema If an error occurs while validating the CRF protection for this sfRequest
890890
*/
891891
public function checkCSRFProtection()
892892
{

‎lib/response/sfResponse.class.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public function __construct(sfEventDispatcher $dispatcher, $options = array())
4747
*
4848
* @return mixed The returned value of the called method
4949
*
50-
* @throws <b>sfException</b> If the calls fails
50+
* @throws sfException If the calls fails
5151
*/
5252
public function __call($method, $arguments)
5353
{
@@ -89,7 +89,7 @@ public function __unserialize($data)
8989
* @param sfEventDispatcher $dispatcher An sfEventDispatcher instance
9090
* @param array $options An array of options
9191
*
92-
* @throws <b>sfInitializationException</b> If an error occurs while initializing this sfResponse
92+
* @throws sfInitializationException If an error occurs while initializing this sfResponse
9393
*/
9494
public function initialize(sfEventDispatcher $dispatcher, $options = array())
9595
{

‎lib/response/sfWebResponse.class.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ public function __unserialize($data)
114114
* @param sfEventDispatcher $dispatcher An sfEventDispatcher instance
115115
* @param array $options An array of options
116116
*
117-
* @throws <b>sfInitializationException</b> If an error occurs while initializing this sfResponse
117+
* @throws sfInitializationException If an error occurs while initializing this sfResponse
118118
*
119119
* @see sfResponse
120120
*/
@@ -171,7 +171,7 @@ public function isHeaderOnly()
171171
* @param bool $secure If secure
172172
* @param bool $httpOnly If uses only HTTP
173173
*
174-
* @throws <b>sfException</b> If fails to set the cookie
174+
* @throws sfException If fails to set the cookie
175175
*/
176176
public function setCookie($name, $value, $expire = null, $path = '/', $domain = '', $secure = false, $httpOnly = false)
177177
{

‎lib/storage/sfCacheSessionStorage.class.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ class sfCacheSessionStorage extends sfStorage
4747
*
4848
* @return bool true, when initialization completes successfully
4949
*
50-
* @throws <b>sfInitializationException</b> If an error occurs while initializing this Storage
50+
* @throws sfInitializationException If an error occurs while initializing this Storage
5151
*/
5252
public function initialize($options = array())
5353
{
@@ -215,7 +215,7 @@ public function remove($key)
215215
*
216216
* @return bool True if session regenerated, false if error
217217
*
218-
* @throws <b>sfStorageException</b> If an error occurs while regenerating this storage
218+
* @throws sfStorageException If an error occurs while regenerating this storage
219219
*/
220220
public function regenerate($destroy = false)
221221
{
@@ -263,7 +263,7 @@ public function expire()
263263
/**
264264
* Executes the shutdown procedure.
265265
*
266-
* @throws <b>sfStorageException</b> If an error occurs while shutting down this storage
266+
* @throws sfStorageException If an error occurs while shutting down this storage
267267
*/
268268
public function shutdown()
269269
{

0 commit comments

Comments
 (0)