8000 removed dots at the end of @param and @return · symfony/http-foundation@10f89ef · GitHub
[go: up one dir, main page]

Skip to content

Commit 10f89ef

Browse files
committed
removed dots at the end of @param and @return
1 parent 1ff8149 commit 10f89ef

23 files changed

+49
-49
lines changed

File/UploadedFile.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ public function getError()
194194
/**
195195
* Returns whether the file was uploaded successfully.
196196
*
197-
* @return bool True if the file has been uploaded with HTTP and no error occurred.
197+
* @return bool True if the file has been uploaded with HTTP and no error occurred
198198
*/
199199
public function isValid()
200200
{

IpUtils.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public static function checkIp($requestIp, $ips)
5757
* @param string $requestIp IPv4 address to check
5858
* @param string $ip IPv4 address or subnet in CIDR notation
5959
*
60-
* @return bool Whether the request IP matches the IP, or whether the request IP is within the CIDR subnet.
60+
* @return bool Whether the request IP matches the IP, or whether the request IP is within the CIDR subnet
61 67F4 61
*/
6262
public static function checkIp4($requestIp, $ip)
6363
{

ParameterBag.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -242,11 +242,11 @@ public function getBoolean($key, $default = false, $deep = false)
242242
/**
243243
* Filter key.
244244
*
245-
* @param string $key Key.
246-
* @param mixed $default Default = null.
247-
* @param bool $deep Default = false.
248-
* @param int $filter FILTER_* constant.
249-
* @param mixed $options Filter options.
245+
* @param string $key Key
246+
* @param mixed $default Default = null
247+
* @param bool $deep Default = false
248+
* @param int $filter FILTER_* constant
249+
* @param mixed $options Filter options
250250
*
251251
* @see http://php.net/manual/en/function.filter-var.php
252252
*

RedirectResponse.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public function getTargetUrl()
6666
*
6767
* @param string $url The URL to redirect to
6868
*
69-
* @return RedirectResponse The current response.
69+
* @return RedirectResponse The current response
7070
*
7171
* @throws \InvalidArgumentException
7272
*/

Request.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -553,7 +553,7 @@ public static function setTrustedProxies(array $proxies)
553553
/**
554554
* Gets the list of trusted proxies.
555555
*
556-
* @return array An array of trusted proxies.
556+
* @return array An array of trusted proxies
557557
*/
558558
public static function getTrustedProxies()
559559
{
@@ -579,7 +579,7 @@ public static function setTrustedHosts(array $hostPatterns)
579579
/**
580580
* Gets the list of trusted host patterns.
581581
*
582-
* @return array An array of trusted host patterns.
582+
* @return array An array of trusted host patterns
583583
*/
584584
public static function getTrustedHosts()
585585
{
@@ -1396,7 +1396,7 @@ public function getRequestFormat($default = 'html')
13961396
/**
13971397
* Sets the request format.
13981398
*
1399-
* @param string $format The request format.
1399+
* @param string $format The request format
14001400
*/
14011401
public function setRequestFormat($format)
14021402
{
@@ -1460,7 +1460,7 @@ public function getLocale()
14601460
/**
14611461
* Checks if the request method is of specified type.
14621462
*
1463-
* @param string $method Uppercase request method (GET, POST etc).
1463+
* @param string $method Uppercase request method (GET, POST etc)
14641464
*
14651465
* @return bool
14661466
*/
@@ -1484,7 +1484,7 @@ public function isMethodSafe()
14841484
*
14851485
* @param bool $asResource If true, a resource will be returned
14861486
*
1487-
* @return string|resource The request body content or a resource to read the body stream.
1487+
* @return string|resource The request body content or a resource to read the body stream
14881488
*
14891489
* @throws \LogicException
14901490
*/

Response.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ public function __clone()
262262
*
263263
* @param Request $request A Request instance
264264
*
265-
* @return Response The current response.
265+
* @return Response The current response
266266
*/
267267
public function prepare(Request $request)
268268
{

ResponseHeaderBag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ public function clearCookie($name, $path = '/', $domain = null, $secure = false,
230230
* is semantically equivalent to $filename. If the filename is already ASCII,
231231
* it can be omitted, or just copied from $filename
232232
*
233-
* @return string A string suitable for use as a Content-Disposition field-value.
233+
* @return string A string suitable for use as a Content-Disposition field-value
234234
*
235235
* @throws \InvalidArgumentException
236236
*

Session/Attribute/NamespacedAttributeBag.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ class NamespacedAttributeBag extends AttributeBag
2929
/**
3030
* Constructor.
3131
*
32-
* @param string $storageKey Session storage key.
33-
* @param string $namespaceCharacter Namespace character to use in keys.
32+
* @param string $storageKey Session storage key
33+
* @param string $namespaceCharacter Namespace character to use in keys
3434
*/
3535
public function __construct($storageKey = '_sf2_attributes', $namespaceCharacter = '/')
3636
{

Session/Flash/AutoExpireFlashBag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class AutoExpireFlashBag implements FlashBagInterface
3737
/**
3838
* Constructor.
3939
*
40-
* @param string $storageKey The key used to store flashes in the session.
40+
* @param string $storageKey The key used to store flashes in the session
4141
*/
4242
public function __construct($storageKey = '_sf2_flashes')
4343
{

Session/Flash/FlashBag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ class FlashBag implements FlashBagInterface, \IteratorAggregate
3939
/**
4040
* Constructor.
4141
*
42-
* @param string $storageKey The key used to store flashes in the session.
42+
* @param string $storageKey The key used to store flashes in the session
4343
*/
4444
public function __construct($storageKey = '_sf2_flashes')
4545
{

Session/Flash/FlashBagInterface.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ public function set($type, $message);
3939
/**
4040
* Gets flash messages for a given type.
4141
*
42-
* @param string $type Message category type.
43-
* @param array $default Default value if $type does not exist.
42+
* @param string $type Message category type
43+
* @param array $default Default value if $type does not exist
4444
*
4545
* @return array
4646
*/
@@ -57,7 +57,7 @@ public function peekAll();
5757
* Gets and clears flash from the stack.
5858
*
5959
* @param string $type
60-
* @param array $default Default value if $type does not exist.
60+
* @param array $default Default value if $type does not exist
6161
*
6262
* @return array
6363
*/

Session/Session.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ class Session implements SessionInterface, \IteratorAggregate, \Countable
4646
/**
4747
* Constructor.
4848
*
49-
* @param SessionStorageInterface $storage A SessionStorageInterface instance.
49+
* @param SessionStorageInterface $storage A SessionStorageInterface instance
5050
* @param AttributeBagInterface $attributes An AttributeBagInterface instance, (defaults null for default AttributeBag)
5151
* @param FlashBagInterface $flashes A FlashBagInterface instance (defaults null for default FlashBag)
5252
*/

Session/SessionBagInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public function getStorageKey();
4242
/**
4343
* Clears out data from bag.
4444
*
45-
* @return mixed Whatever data was contained.
45+
* @return mixed Whatever data was contained
4646
*/
4747
public function clear();
4848
}

Session/SessionInterface.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ interface SessionInterface
2323
/**
2424
* Starts the session storage.
2525
*
26-
* @return bool True if session started.
26+
* @return bool True if session started
2727
*
2828
* @throws \RuntimeException If session fails to start.
2929
*/
@@ -32,7 +32,7 @@ public function start();
3232
/**
3333
* Returns the session ID.
3434
*
35-
* @return string The session ID.
35+
* @return string The session ID
3636
*/
3737
public function getId();
3838

@@ -46,7 +46,7 @@ public function setId($id);
4646
/**
4747
* Returns the session name.
4848
*
49-
* @return mixed The session name.
49+
* @return mixed The session name
5050
*/
5151
public function getName();
5252

@@ -68,21 +68,21 @@ public function setName($name);
6868
* to expire with browser session. Time is in seconds, and is
6969
* not a Unix timestamp.
7070
*
71-
* @return bool True if session invalidated, false if error.
71+
* @return bool True if session invalidated, false if error
7272
*/
7373
public function invalidate($lifetime = null);
7474

7575
/**
7676
* Migrates the current session to a new session id while maintaining all
7777
* session attributes.
7878
*
79-
* @param bool $destroy Whether to delete the old session or leave it to garbage collection.
79+
* @param bool $destroy Whether to delete the old session or leave it to garbage collection
8080
* @param int $lifetime Sets the cookie lifetime for the session cookie. A null value
8181
* will leave the system settings unchanged, 0 sets the cookie
8282
* to expire with browser session. Time is in seconds, and is
8383
* not a Unix timestamp.
8484
*
85-
* @return bool True if session migrated, false if error.
85+
* @return bool True if session migrated, false if error
8686
*/
8787
public function migrate($destroy = false, $lifetime = null);
8888

@@ -108,7 +108,7 @@ public function has($name);
108108
* Returns an attribute.
109109
*
110110
* @param string $name The attribute name
111-
* @param mixed $default The default value if not found.
111+
* @param mixed $default The default value if not found
112112
*
113113
* @return mixed
114114
*/

Session/Storage/Handler/MemcacheSessionHandler.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
class MemcacheSessionHandler implements \SessionHandlerInterface
2020
{
2121
/**
22-
* @var \Memcache Memcache driver.
22+
* @var \Memcache Memcache driver
2323
*/
2424
private $memcache;
2525

@@ -29,7 +29,7 @@ class MemcacheSessionHandler implements \SessionHandlerInterface
2929
private $ttl;
3030

3131
/**
32-
* @var string Key prefix for shared environments.
32+
* @var string Key prefix for shared environments
3333
*/
3434
private $prefix;
3535

Session/Storage/Handler/MemcachedSessionHandler.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
class MemcachedSessionHandler implements \SessionHandlerInterface
2525
{
2626
/**
27-
* @var \Memcached Memcached driver.
27+
* @var \Memcached Memcached driver
2828
*/
2929
private $memcached;
3030

@@ -34,7 +34,7 @@ class MemcachedSessionHandler implements \SessionHandlerInterface
3434
private $ttl;
3535

3636
/**
37-
* @var string Key prefix for shared environments.
37+
* @var string Key prefix for shared environments
3838
*/
3939
private $prefix;
4040

Session/Storage/Handler/NativeFileSessionHandler.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class NativeFileSessionHandler extends NativeSessionHandler
2323
/**
2424
* Constructor.
2525
*
26-
* @param string $savePath Path of directory to save session files.
26+
* @param string $savePath Path of directory to save session files
2727
* Default null will leave setting as defined by PHP.
2828
* '/path', 'N;/path', or 'N;octal-mode;/path
2929
*

Session/Storage/MetadataBag.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ class MetadataBag implements SessionBagInterface
5656
/**
5757
* Constructor.
5858
*
59-
* @param string $storageKey The key used to store bag in the session.
59+
* @param string $storageKey The key used to store bag in the session
6060
* @param int $updateThreshold The time to wait between two UPDATED updates
6161
*/
6262
public function __construct($storageKey = '_sf2_meta', $updateThreshold = 0)

Session/Storage/MockArraySessionStorage.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ class MockArraySessionStorage implements SessionStorageInterface
6666
* Constructor.
6767
*
6868
* @param string $name Session name
69-
* @param MetadataBag $metaBag MetadataBag instance.
69+
* @param MetadataBag $metaBag MetadataBag instance
7070
*/
7171
public function __construct($name = 'MOCKSESSID', MetadataBag $metaBag = null)
7272
{

Session/Storage/MockFileSessionStorage.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ D7AE -32,9 +32,9 @@ class MockFileSessionStorage extends MockArraySessionStorage
3232
/**
3333
* Constructor.
3434
*
35-
* @param string $savePath Path of directory to save session files.
36-
* @param string $name Session name.
37-
* @param MetadataBag $metaBag MetadataBag instance.
35+
* @param string $savePath Path of directory to save session files
36+
* @param string $name Session name
37+
* @param MetadataBag $metaBag MetadataBag instance
3838
*/
3939
public function __construct($savePath = null, $name = 'MOCKSESSID', MetadataBag $metaBag = null)
4040
{

Session/Storage/NativeSessionStorage.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,9 @@ class NativeSessionStorage implements SessionStorageInterface
9292
* upload_progress.min-freq, "1"
9393
* url_rewriter.tags, "a=href,area=href,frame=src,form=,fieldset="
9494
*
95-
* @param array $options Session configuration options.
95+
* @param array $options Session configuration options
9696
* @param AbstractProxy|NativeSessionHandler|\SessionHandlerInterface|null $handler
97-
* @param MetadataBag $metaBag MetadataBag.
97+
* @param MetadataBag $metaBag MetadataBag
9898
*/
9999
public function __construct(array $options = array(), $handler = null, MetadataBag $metaBag = null)
100100
{
@@ -323,7 +323,7 @@ public function isStarted()
323323
* For convenience we omit 'session.' from the beginning of the keys.
324324
* Explicitly ignores other ini keys.
325325
*
326-
* @param array $options Session ini directives array(key => value).
326+
* @param array $options Session ini directives array(key => value)
327327
*
328328
* @see http://php.net/session.configuration
329329
*/

Session/Storage/Proxy/NativeProxy.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public function __construct()
3232
/**
3333
* Returns true if this handler wraps an internal PHP session save handler using \SessionHandler.
3434
*
35-
* @return bool False.
35+
* @return bool False
3636
*/
3737
public function isWrapper()
3838
{

Session/Storage/SessionStorageInterface.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ interface SessionStorageInterface
2424
/**
2525
* Starts the session.
2626
*
27-
* @return bool True if started.
27+
* @return bool True if started
2828
*
2929
* @throws \RuntimeException If something goes wrong starting the session.
3030
*/
@@ -33,14 +33,14 @@ public function start();
3333
/**
3434
* Checks if the session is started.
3535
*
36-
* @return bool True if started, false otherwise.
36+
* @return bool True if started, false otherwise
3737
*/
3838
public function isStarted();
3939

4040
/**
4141
* Returns the session ID.
4242
*
43-
* @return string The session ID or empty.
43+
* @return string The session ID or empty
4444
*/
4545
public function getId();
4646

@@ -54,7 +54,7 @@ public function setId($id);
5454
/**
5555
* Returns the session name.
5656
*
57-
* @return mixed The session name.
57+
* @return mixed The session name
5858
*/
5959
public function getName();
6060

0 commit comments

Comments
 (0)
0