Skip to content

Commit

Permalink
remove api tags from code
Browse files Browse the repository at this point in the history
  • Loading branch information
Tobion committed Sep 28, 2015
1 parent e0e6540 commit f9aad38
Show file tree
Hide file tree
Showing 17 changed files with 0 additions and 384 deletions.
20 changes: 0 additions & 20 deletions Cookie.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@
* Represents a cookie.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*
* @api
*/
class Cookie
{
Expand All @@ -40,8 +38,6 @@ class Cookie
* @param bool $httpOnly Whether the cookie will be made accessible only through the HTTP protocol
*
* @throws \InvalidArgumentException
*
* @api
*/
public function __construct($name, $value = null, $expire = 0, $path = '/', $domain = null, $secure = false, $httpOnly = true)
{
Expand Down Expand Up @@ -116,8 +112,6 @@ public function __toString()
* Gets the name of the cookie.
*
* @return string
*
* @api
*/
public function getName()
{
Expand All @@ -128,8 +122,6 @@ public function getName()
* Gets the value of the cookie.
*
* @return string
*
* @api
*/
public function getValue()
{
Expand All @@ -140,8 +132,6 @@ public function getValue()
* Gets the domain that the cookie is available to.
*
* @return string
*
* @api
*/
public function getDomain()
{
Expand All @@ -152,8 +142,6 @@ public function getDomain()
* Gets the time the cookie expires.
*
* @return int
*
* @api
*/
public function getExpiresTime()
{
Expand All @@ -164,8 +152,6 @@ public function getExpiresTime()
* Gets the path on the server in which the cookie will be available on.
*
* @return string
*
* @api
*/
public function getPath()
{
Expand All @@ -176,8 +162,6 @@ public function getPath()
* Checks whether the cookie should only be transmitted over a secure HTTPS connection from the client.
*
* @return bool
*
* @api
*/
public function isSecure()
{
Expand All @@ -188,8 +172,6 @@ public function isSecure()
* Checks whether the cookie will be made accessible only through the HTTP protocol.
*
* @return bool
*
* @api
*/
public function isHttpOnly()
{
Expand All @@ -200,8 +182,6 @@ public function isHttpOnly()
* Whether this cookie is about to be cleared.
*
* @return bool
*
* @api
*/
public function isCleared()
{
Expand Down
12 changes: 0 additions & 12 deletions File/File.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@
* A file in the file system.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*
* @api
*/
class File extends \SplFileInfo
{
Expand All @@ -32,8 +30,6 @@ class File extends \SplFileInfo
* @param bool $checkPath Whether to check the path or not
*
* @throws FileNotFoundException If the given path is not a file
*
* @api
*/
public function __construct($path, $checkPath = true)
{
Expand All @@ -54,8 +50,6 @@ public function __construct($path, $checkPath = true)
*
* @return string|null The guessed extension or null if it cannot be guessed
*
* @api
*
* @see ExtensionGuesser
* @see getMimeType()
*/
Expand All @@ -77,8 +71,6 @@ public function guessExtension()
* @return string|null The guessed mime type (i.e. "application/pdf")
*
* @see MimeTypeGuesser
*
* @api
*/
public function getMimeType()
{
Expand All @@ -93,8 +85,6 @@ public function getMimeType()
* \SplFileInfo::getExtension() is not available before PHP 5.3.6
*
* @return string The extension
*
* @api
*/
public function getExtension()
{
Expand All @@ -110,8 +100,6 @@ public function getExtension()
* @return File A File object representing the new file
*
* @throws FileException if the target file could not be created
*
* @api
*/
public function move($directory, $name = null)
{
Expand Down
16 changes: 0 additions & 16 deletions File/UploadedFile.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@
* @author Bernhard Schussek <bschussek@gmail.com>
* @author Florian Eckerstorfer <florian@eckerstorfer.org>
* @author Fabien Potencier <fabien@symfony.com>
*
* @api
*/
class UploadedFile extends File
{
Expand Down Expand Up @@ -86,8 +84,6 @@ class UploadedFile extends File
*
* @throws FileException If file_uploads is disabled
* @throws FileNotFoundException If the file does not exist
*
* @api
*/
public function __construct($path, $originalName, $mimeType = null, $size = null, $error = null, $test = false)
{
Expand All @@ -107,8 +103,6 @@ public function __construct($path, $originalName, $mimeType = null, $size = null
* Then it should not be considered as a safe value.
*
* @return string|null The original name
*
* @api
*/
public function getClientOriginalName()
{
Expand Down Expand Up @@ -140,8 +134,6 @@ public function getClientOriginalExtension()
* @return string|null The mime type
*
* @see getMimeType()
*
* @api
*/
public function getClientMimeType()
{
Expand Down Expand Up @@ -180,8 +172,6 @@ public function guessClientExtension()
* Then it should not be considered as a safe value.
*
* @return int|null The file size
*
* @api
*/
public function getClientSize()
{
Expand All @@ -195,8 +185,6 @@ public function getClientSize()
* Otherwise one of the other UPLOAD_ERR_XXX constants is returned.
*
* @return int The upload error
*
* @api
*/
public function getError()
{
Expand All @@ -207,8 +195,6 @@ public function getError()
* Returns whether the file was uploaded successfully.
*
* @return bool True if the file has been uploaded with HTTP and no error occurred.
*
* @api
*/
public function isValid()
{
Expand All @@ -226,8 +212,6 @@ public function isValid()
* @return File A File object representing the new file
*
* @throws FileException if, for any reason, the file could not have been moved
*
* @api
*/
public function move($directory, $name = null)
{
Expand Down
10 changes: 0 additions & 10 deletions FileBag.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Bulat Shakirzyanov <mallluhuct@gmail.com>
*
* @api
*/
class FileBag extends ParameterBag
{
Expand All @@ -29,8 +27,6 @@ class FileBag extends ParameterBag
* Constructor.
*
* @param array $parameters An array of HTTP files
*
* @api
*/
public function __construct(array $parameters = array())
{
Expand All @@ -39,8 +35,6 @@ public function __construct(array $parameters = array())

/**
* {@inheritdoc}
*
* @api
*/
public function replace(array $files = array())
{
Expand All @@ -50,8 +44,6 @@ public function replace(array $files = array())

/**
* {@inheritdoc}
*
* @api
*/
public function set($key, $value)
{
Expand All @@ -64,8 +56,6 @@ public function set($key, $value)

/**
* {@inheritdoc}
*
* @api
*/
public function add(array $files = array())
{
Expand Down
24 changes: 0 additions & 24 deletions HeaderBag.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@
* HeaderBag is a container for HTTP headers.
*
* @author Fabien Potencier <fabien@symfony.com>
*
* @api
*/
class HeaderBag implements \IteratorAggregate, \Countable
{
Expand All @@ -27,8 +25,6 @@ class HeaderBag implements \IteratorAggregate, \Countable
* Constructor.
*
* @param array $headers An array of HTTP headers
*
* @api
*/
public function __construct(array $headers = array())
{
Expand Down Expand Up @@ -67,8 +63,6 @@ public function __toString()
* Returns the headers.
*
* @return array An array of headers
*
* @api
*/
public function all()
{
Expand All @@ -79,8 +73,6 @@ public function all()
* Returns the parameter keys.
*
* @return array An array of parameter keys
*
* @api
*/
public function keys()
{
Expand All @@ -91,8 +83,6 @@ public function keys()
* Replaces the current HTTP headers by a new set.
*
* @param array $headers An array of HTTP headers
*
* @api
*/
public function replace(array $headers = array())
{
Expand All @@ -104,8 +94,6 @@ public function replace(array $headers = array())
* Adds new headers the current HTTP headers set.
*
* @param array $headers An array of HTTP headers
*
* @api
*/
public function add(array $headers)
{
Expand All @@ -122,8 +110,6 @@ public function add(array $headers)
* @param bool $first Whether to return the first value or all header values
*
* @return string|array The first header value if $first is true, an array of values otherwise
*
* @api
*/
public function get($key, $default = null, $first = true)
{
Expand All @@ -150,8 +136,6 @@ public function get($key, $default = null, $first = true)
* @param string $key The key
* @param string|array $values The value or an array of values
* @param bool $replace Whether to replace the actual value or not (true by default)
*
* @api
*/
public function set($key, $values, $replace = true)
{
Expand All @@ -176,8 +160,6 @@ public function set($key, $values, $replace = true)
* @param string $key The HTTP header
*
* @return bool true if the parameter exists, false otherwise
*
* @api
*/
public function has($key)
{
Expand All @@ -191,8 +173,6 @@ public function has($key)
* @param string $value The HTTP value
*
* @return bool true if the value is contained in the header, false otherwise
*
* @api
*/
public function contains($key, $value)
{
Expand All @@ -203,8 +183,6 @@ public function contains($key, $value)
* Removes a header.
*
* @param string $key The HTTP header name
*
* @api
*/
public function remove($key)
{
Expand All @@ -226,8 +204,6 @@ public function remove($key)
* @return null|\DateTime The parsed DateTime or the default value if the header does not exist
*
* @throws \RuntimeException When the HTTP header is not parseable
*
* @api
*/
public function getDate($key, \DateTime $default = null)
{
Expand Down
Loading

0 comments on commit f9aad38

Please sign in to comment.