Skip to content

Commit

Permalink
[2.3] CS And DocBlock Fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
GrahamCampbell authored and fabpot committed Dec 22, 2014
1 parent 46fb9bd commit c7364dc
Show file tree
Hide file tree
Showing 33 changed files with 66 additions and 62 deletions.
2 changes: 1 addition & 1 deletion AcceptHeader.php
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ public function first()
}

/**
* Sorts items by descending quality
* Sorts items by descending quality.
*/
private function sort()
{
Expand Down
4 changes: 2 additions & 2 deletions Cookie.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
namespace Symfony\Component\HttpFoundation;

/**
* Represents a cookie
* Represents a cookie.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*
Expand Down Expand Up @@ -197,7 +197,7 @@ public function isHttpOnly()
}

/**
* Whether this cookie is about to be cleared
* Whether this cookie is about to be cleared.
*
* @return bool
*
Expand Down
2 changes: 1 addition & 1 deletion File/Exception/FileException.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
namespace Symfony\Component\HttpFoundation\File\Exception;

/**
* Thrown when an error occurred in the component File
* Thrown when an error occurred in the component File.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
Expand Down
2 changes: 1 addition & 1 deletion File/Exception/FileNotFoundException.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
namespace Symfony\Component\HttpFoundation\File\Exception;

/**
* Thrown when a file was not found
* Thrown when a file was not found.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
Expand Down
2 changes: 1 addition & 1 deletion File/Exception/UploadException.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
namespace Symfony\Component\HttpFoundation\File\Exception;

/**
* Thrown when an error occurred during file upload
* Thrown when an error occurred during file upload.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
Expand Down
12 changes: 6 additions & 6 deletions File/MimeType/ExtensionGuesser.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,21 +26,21 @@
class ExtensionGuesser implements ExtensionGuesserInterface
{
/**
* The singleton instance
* The singleton instance.
*
* @var ExtensionGuesser
*/
private static $instance = null;

/**
* All registered ExtensionGuesserInterface instances
* All registered ExtensionGuesserInterface instances.
*
* @var array
*/
protected $guessers = array();

/**
* Returns the singleton instance
* Returns the singleton instance.
*
* @return ExtensionGuesser
*/
Expand All @@ -54,15 +54,15 @@ public static function getInstance()
}

/**
* Registers all natively provided extension guessers
* Registers all natively provided extension guessers.
*/
private function __construct()
{
$this->register(new MimeTypeExtensionGuesser());
}

/**
* Registers a new extension guesser
* Registers a new extension guesser.
*
* When guessing, this guesser is preferred over previously registered ones.
*
Expand All @@ -74,7 +74,7 @@ public function register(ExtensionGuesserInterface $guesser)
}

/**
* Tries to guess the extension
* Tries to guess the extension.
*
* The mime type is passed to each registered mime type guesser in reverse order
* of their registration (last registered is queried first). Once a guesser
Expand Down
2 changes: 1 addition & 1 deletion File/MimeType/ExtensionGuesserInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
namespace Symfony\Component\HttpFoundation\File\MimeType;

/**
* Guesses the file extension corresponding to a given mime type
* Guesses the file extension corresponding to a given mime type.
*/
interface ExtensionGuesserInterface
{
Expand Down
4 changes: 2 additions & 2 deletions File/MimeType/FileBinaryMimeTypeGuesser.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
use Symfony\Component\HttpFoundation\File\Exception\AccessDeniedException;

/**
* Guesses the mime type with the binary "file" (only available on *nix)
* Guesses the mime type with the binary "file" (only available on *nix).
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
Expand All @@ -39,7 +39,7 @@ public function __construct($cmd = 'file -b --mime %s 2>/dev/null')
}

/**
* Returns whether this guesser is supported on the current OS
* Returns whether this guesser is supported on the current OS.
*
* @return bool
*/
Expand Down
2 changes: 1 addition & 1 deletion File/MimeType/FileinfoMimeTypeGuesser.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public function __construct($magicFile = null)
}

/**
* Returns whether this guesser is supported on the current OS/PHP setup
* Returns whether this guesser is supported on the current OS/PHP setup.
*
* @return bool
*/
Expand Down
12 changes: 6 additions & 6 deletions File/MimeType/MimeTypeGuesser.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,21 +40,21 @@
class MimeTypeGuesser implements MimeTypeGuesserInterface
{
/**
* The singleton instance
* The singleton instance.
*
* @var MimeTypeGuesser
*/
private static $instance = null;

/**
* All registered MimeTypeGuesserInterface instances
* All registered MimeTypeGuesserInterface instances.
*
* @var array
*/
protected $guessers = array();

/**
* Returns the singleton instance
* Returns the singleton instance.
*
* @return MimeTypeGuesser
*/
Expand All @@ -68,7 +68,7 @@ public static function getInstance()
}

/**
* Registers all natively provided mime type guessers
* Registers all natively provided mime type guessers.
*/
private function __construct()
{
Expand All @@ -82,7 +82,7 @@ private function __construct()
}

/**
* Registers a new mime type guesser
* Registers a new mime type guesser.
*
* When guessing, this guesser is preferred over previously registered ones.
*
Expand All @@ -94,7 +94,7 @@ public function register(MimeTypeGuesserInterface $guesser)
}

/**
* Tries to guess the mime type of the given file
* Tries to guess the mime type of the given file.
*
* The file is passed to each registered mime type guesser in reverse order
* of their registration (last registered is queried first). Once a guesser
Expand Down
2 changes: 1 addition & 1 deletion File/MimeType/MimeTypeGuesserInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
use Symfony\Component\HttpFoundation\File\Exception\AccessDeniedException;

/**
* Guesses the mime type of a file
* Guesses the mime type of a file.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
Expand Down
4 changes: 2 additions & 2 deletions File/UploadedFile.php
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ public function getClientOriginalName()
}

/**
* Returns the original file extension
* Returns the original file extension.
*
* It is extracted from the original file name that was uploaded.
* Then it should not be considered as a safe value.
Expand Down Expand Up @@ -252,7 +252,7 @@ public function move($directory, $name = null)
}

/**
* Returns the maximum size of an uploaded file as configured in php.ini
* Returns the maximum size of an uploaded file as configured in php.ini.
*
* @return int The maximum size of an uploaded file in bytes
*/
Expand Down
5 changes: 3 additions & 2 deletions IpUtils.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@
class IpUtils
{
/**
* This class should not be instantiated
* This class should not be instantiated.
*/
private function __construct()
{
}

/**
* Checks if an IPv4 or IPv6 address is contained in the list of given IPs or subnets
* Checks if an IPv4 or IPv6 address is contained in the list of given IPs or subnets.
*
* @param string $requestIp IP to check
* @param string|array $ips List of IPs or subnets (can be a string if only a single one)
Expand Down Expand Up @@ -80,6 +80,7 @@ public static function checkIp4($requestIp, $ip)
* In case a subnet is given, it checks if it contains the request IP.
*
* @author David Soria Parra <dsp at php dot net>
*
* @see https://github.com/dsp/v6tools
*
* @param string $requestIp IPv6 address to check
Expand Down
17 changes: 9 additions & 8 deletions Request.php
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ class Request
protected static $httpMethodParameterOverride = false;

/**
* Custom parameters
* Custom parameters.
*
* @var \Symfony\Component\HttpFoundation\ParameterBag
*
Expand All @@ -73,7 +73,7 @@ class Request
public $attributes;

/**
* Request body parameters ($_POST)
* Request body parameters ($_POST).
*
* @var \Symfony\Component\HttpFoundation\ParameterBag
*
Expand All @@ -82,7 +82,7 @@ class Request
public $request;

/**
* Query string parameters ($_GET)
* Query string parameters ($_GET).
*
* @var \Symfony\Component\HttpFoundation\ParameterBag
*
Expand All @@ -91,7 +91,7 @@ class Request
public $query;

/**
* Server and execution environment parameters ($_SERVER)
* Server and execution environment parameters ($_SERVER).
*
* @var \Symfony\Component\HttpFoundation\ServerBag
*
Expand All @@ -100,7 +100,7 @@ class Request
public $server;

/**
* Uploaded files ($_FILES)
* Uploaded files ($_FILES).
*
* @var \Symfony\Component\HttpFoundation\FileBag
*
Expand All @@ -109,7 +109,7 @@ class Request
public $files;

/**
* Cookies ($_COOKIE)
* Cookies ($_COOKIE).
*
* @var \Symfony\Component\HttpFoundation\ParameterBag
*
Expand All @@ -118,7 +118,7 @@ class Request
public $cookies;

/**
* Headers (taken from the $_SERVER)
* Headers (taken from the $_SERVER).
*
* @var \Symfony\Component\HttpFoundation\HeaderBag
*
Expand Down Expand Up @@ -1572,7 +1572,7 @@ public function getCharsets()
}

/**
* Gets a list of content types acceptable by the client browser
* Gets a list of content types acceptable by the client browser.
*
* @return array List of content types in preferable order
*
Expand All @@ -1592,6 +1592,7 @@ public function getAcceptableContentTypes()
*
* It works if your JavaScript library sets an X-Requested-With HTTP header.
* It is known to work with common JavaScript frameworks:
*
* @link http://en.wikipedia.org/wiki/List_of_Ajax_frameworks#JavaScript
*
* @return bool true if the request is an XMLHttpRequest, false otherwise
Expand Down
2 changes: 1 addition & 1 deletion Resources/stubs/SessionHandlerInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
*/

/**
* SessionHandlerInterface for PHP < 5.4
* SessionHandlerInterface for PHP < 5.4.
*
* Extensive documentation can be found at php.net, see links:
*
Expand Down
4 changes: 2 additions & 2 deletions Response.php
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ public function __construct($content = '', $status = 200, $headers = array())
}

/**
* Factory method for chainability
* Factory method for chainability.
*
* Example:
*
Expand Down Expand Up @@ -1188,7 +1188,7 @@ public function isEmpty()
}

/**
* Check if we need to remove Cache-Control for SSL encrypted downloads when using IE < 9
* Check if we need to remove Cache-Control for SSL encrypted downloads when using IE < 9.
*
* @link http://support.microsoft.com/kb/323308
*/
Expand Down
7 changes: 4 additions & 3 deletions ResponseHeaderBag.php
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ public function setCookie(Cookie $cookie)
}

/**
* Removes a cookie from the array, but does not unset it in the browser
* Removes a cookie from the array, but does not unset it in the browser.
*
* @param string $name
* @param string $path
Expand All @@ -191,7 +191,7 @@ public function removeCookie($name, $path = '/', $domain = null)
}

/**
* Returns an array with all cookies
* Returns an array with all cookies.
*
* @param string $format
*
Expand Down Expand Up @@ -224,7 +224,7 @@ public function getCookies($format = self::COOKIES_FLAT)
}

/**
* Clears a cookie in the browser
* Clears a cookie in the browser.
*
* @param string $name
* @param string $path
Expand All @@ -249,6 +249,7 @@ public function clearCookie($name, $path = '/', $domain = null)
* @return string A string suitable for use as a Content-Disposition field-value.
*
* @throws \InvalidArgumentException
*
* @see RFC 6266
*/
public function makeDisposition($disposition, $filename, $filenameFallback = '')
Expand Down
2 changes: 1 addition & 1 deletion Session/Attribute/AttributeBag.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
namespace Symfony\Component\HttpFoundation\Session\Attribute;

/**
* This class relates to session attribute storage
* This class relates to session attribute storage.
*/
class AttributeBag implements AttributeBagInterface, \IteratorAggregate, \Countable
{
Expand Down
Loading

0 comments on commit c7364dc

Please sign in to comment.