Skip to content

Commit

Permalink
Fixed most of the docblocks/unused namespaces
Browse files Browse the repository at this point in the history
  • Loading branch information
dlsniper authored and fabpot committed Dec 19, 2012
1 parent a18fd6c commit 58a1dad
Show file tree
Hide file tree
Showing 10 changed files with 36 additions and 1 deletion.
9 changes: 9 additions & 0 deletions BinaryFileResponse.php
Expand Up @@ -65,6 +65,13 @@ public static function create($file = null, $status = 200, $headers = array(), $
* Sets the file to stream. * Sets the file to stream.
* *
* @param SplFileInfo|string $file The file to stream * @param SplFileInfo|string $file The file to stream
* @param string $contentDisposition
* @param Boolean $autoEtag
* @param Boolean $autoLastModified
*
* @return BinaryFileResponse
*
* @throws FileException
*/ */
public function setFile($file, $contentDisposition = null, $autoEtag = false, $autoLastModified = true) public function setFile($file, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)
{ {
Expand Down Expand Up @@ -127,6 +134,8 @@ public function setAutoEtag()
* @param string $disposition ResponseHeaderBag::DISPOSITION_INLINE or ResponseHeaderBag::DISPOSITION_ATTACHMENT * @param string $disposition ResponseHeaderBag::DISPOSITION_INLINE or ResponseHeaderBag::DISPOSITION_ATTACHMENT
* @param string $filename Optionally use this filename instead of the real name of the file * @param string $filename Optionally use this filename instead of the real name of the file
* @param string $filenameFallback A fallback filename, containing only ASCII characters. Defaults to an automatically encoded filename * @param string $filenameFallback A fallback filename, containing only ASCII characters. Defaults to an automatically encoded filename
*
* @return BinaryFileResponse
*/ */
public function setContentDisposition($disposition, $filename = '', $filenameFallback = '') public function setContentDisposition($disposition, $filename = '', $filenameFallback = '')
{ {
Expand Down
2 changes: 2 additions & 0 deletions Cookie.php
Expand Up @@ -39,6 +39,8 @@ class Cookie
* @param Boolean $secure Whether the cookie should only be transmitted over a secure HTTPS connection from the client * @param Boolean $secure Whether the cookie should only be transmitted over a secure HTTPS connection from the client
* @param Boolean $httpOnly Whether the cookie will be made accessible only through the HTTP protocol * @param Boolean $httpOnly Whether the cookie will be made accessible only through the HTTP protocol
* *
* @throws \InvalidArgumentException
*
* @api * @api
*/ */
public function __construct($name, $value = null, $expire = 0, $path = '/', $domain = null, $secure = false, $httpOnly = true) public function __construct($name, $value = null, $expire = 0, $path = '/', $domain = null, $secure = false, $httpOnly = true)
Expand Down
4 changes: 3 additions & 1 deletion File/MimeType/MimeTypeGuesser.php
Expand Up @@ -99,7 +99,9 @@ public function register(MimeTypeGuesserInterface $guesser)
* *
* @return string The mime type or NULL, if none could be guessed * @return string The mime type or NULL, if none could be guessed
* *
* @throws FileException If the file does not exist * @throws \LogicException
* @throws FileNotFoundException
* @throws AccessDeniedException
*/ */
public function guess($path) public function guess($path)
{ {
Expand Down
2 changes: 2 additions & 0 deletions JsonResponse.php
Expand Up @@ -49,6 +49,8 @@ public static function create($data = array(), $status = 200, $headers = array()
* @param string $callback * @param string $callback
* *
* @return JsonResponse * @return JsonResponse
*
* @throws \InvalidArgumentException
*/ */
public function setCallback($callback = null) public function setCallback($callback = null)
{ {
Expand Down
2 changes: 2 additions & 0 deletions ParameterBag.php
Expand Up @@ -96,6 +96,8 @@ public function add(array $parameters = array())
* *
* @return mixed * @return mixed
* *
* @throws \InvalidArgumentException
*
* @api * @api
*/ */
public function get($path, $default = null, $deep = false) public function get($path, $default = null, $deep = false)
Expand Down
4 changes: 4 additions & 0 deletions RedirectResponse.php
Expand Up @@ -29,6 +29,8 @@ class RedirectResponse extends Response
* @param integer $status The status code (302 by default) * @param integer $status The status code (302 by default)
* @param array $headers The headers (Location is always set to the given url) * @param array $headers The headers (Location is always set to the given url)
* *
* @throws \InvalidArgumentException
*
* @see http://tools.ietf.org/html/rfc2616#section-10.3 * @see http://tools.ietf.org/html/rfc2616#section-10.3
* *
* @api * @api
Expand Down Expand Up @@ -72,6 +74,8 @@ public function getTargetUrl()
* @param string $url The URL to redirect to * @param string $url The URL to redirect to
* *
* @return RedirectResponse The current response. * @return RedirectResponse The current response.
*
* @throws \InvalidArgumentException
*/ */
public function setTargetUrl($url) public function setTargetUrl($url)
{ {
Expand Down
4 changes: 4 additions & 0 deletions Request.php
Expand Up @@ -500,6 +500,8 @@ public static function setTrustedProxies(array $proxies)
* *
* @param string $key The header key * @param string $key The header key
* @param string $value The header name * @param string $value The header name
*
* @throws \InvalidArgumentException
*/ */
public static function setTrustedHeaderName($key, $value) public static function setTrustedHeaderName($key, $value)
{ {
Expand Down Expand Up @@ -1258,6 +1260,8 @@ public function isMethodSafe()
* @param Boolean $asResource If true, a resource will be returned * @param Boolean $asResource If true, a resource will be returned
* *
* @return string|resource The request body content or a resource to read the body stream. * @return string|resource The request body content or a resource to read the body stream.
*
* @throws \LogicException
*/ */
public function getContent($asResource = false) public function getContent($asResource = false)
{ {
Expand Down
4 changes: 4 additions & 0 deletions Response.php
Expand Up @@ -336,6 +336,8 @@ public function send()
* *
* @return Response * @return Response
* *
* @throws \UnexpectedValueException
*
* @api * @api
*/ */
public function setContent($content) public function setContent($content)
Expand Down Expand Up @@ -875,6 +877,8 @@ public function setEtag($etag = null, $weak = false)
* *
* @return Response * @return Response
* *
* @throws \InvalidArgumentException
*
* @api * @api
*/ */
public function setCache(array $options) public function setCache(array $options)
Expand Down
4 changes: 4 additions & 0 deletions Session/Storage/Proxy/AbstractProxy.php
Expand Up @@ -99,6 +99,8 @@ public function getId()
* Sets the session ID. * Sets the session ID.
* *
* @param string $id * @param string $id
*
* @throws \LogicException
*/ */
public function setId($id) public function setId($id)
{ {
Expand All @@ -123,6 +125,8 @@ public function getName()
* Sets the session name. * Sets the session name.
* *
* @param string $name * @param string $name
*
* @throws \LogicException
*/ */
public function setName($name) public function setName($name)
{ {
Expand Down
2 changes: 2 additions & 0 deletions StreamedResponse.php
Expand Up @@ -62,6 +62,8 @@ public static function create($callback = null, $status = 200, $headers = array(
* Sets the PHP callback associated with this Response. * Sets the PHP callback associated with this Response.
* *
* @param mixed $callback A valid PHP callback * @param mixed $callback A valid PHP callback
*
* @throws \LogicException
*/ */
public function setCallback($callback) public function setCallback($callback)
{ {
Expand Down

0 comments on commit 58a1dad

Please sign in to comment.