diff --git a/Cookie.php b/Cookie.php index 466d02043..061703d9c 100644 --- a/Cookie.php +++ b/Cookie.php @@ -15,8 +15,6 @@ * Represents a cookie. * * @author Johannes M. Schmitt - * - * @api */ class Cookie { @@ -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) { @@ -116,8 +112,6 @@ public function __toString() * Gets the name of the cookie. * * @return string - * - * @api */ public function getName() { @@ -128,8 +122,6 @@ public function getName() * Gets the value of the cookie. * * @return string - * - * @api */ public function getValue() { @@ -140,8 +132,6 @@ public function getValue() * Gets the domain that the cookie is available to. * * @return string - * - * @api */ public function getDomain() { @@ -152,8 +142,6 @@ public function getDomain() * Gets the time the cookie expires. * * @return int - * - * @api */ public function getExpiresTime() { @@ -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() { @@ -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() { @@ -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() { @@ -200,8 +182,6 @@ public function isHttpOnly() * Whether this cookie is about to be cleared. * * @return bool - * - * @api */ public function isCleared() { diff --git a/File/File.php b/File/File.php index 87c1606d4..cc1488a97 100644 --- a/File/File.php +++ b/File/File.php @@ -20,8 +20,6 @@ * A file in the file system. * * @author Bernhard Schussek - * - * @api */ class File extends \SplFileInfo { @@ -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) { @@ -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() */ @@ -77,8 +71,6 @@ public function guessExtension() * @return string|null The guessed mime type (i.e. "application/pdf") * * @see MimeTypeGuesser - * - * @api */ public function getMimeType() { @@ -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() { @@ -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) { diff --git a/File/UploadedFile.php b/File/UploadedFile.php index 24d03437d..ad8c796c4 100644 --- a/File/UploadedFile.php +++ b/File/UploadedFile.php @@ -21,8 +21,6 @@ * @author Bernhard Schussek * @author Florian Eckerstorfer * @author Fabien Potencier - * - * @api */ class UploadedFile extends File { @@ -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) { @@ -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() { @@ -140,8 +134,6 @@ public function getClientOriginalExtension() * @return string|null The mime type * * @see getMimeType() - * - * @api */ public function getClientMimeType() { @@ -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() { @@ -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() { @@ -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() { @@ -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) { diff --git a/FileBag.php b/FileBag.php index 43b8af3c8..197eab42f 100644 --- a/FileBag.php +++ b/FileBag.php @@ -18,8 +18,6 @@ * * @author Fabien Potencier * @author Bulat Shakirzyanov - * - * @api */ class FileBag extends ParameterBag { @@ -29,8 +27,6 @@ class FileBag extends ParameterBag * Constructor. * * @param array $parameters An array of HTTP files - * - * @api */ public function __construct(array $parameters = array()) { @@ -39,8 +35,6 @@ public function __construct(array $parameters = array()) /** * {@inheritdoc} - * - * @api */ public function replace(array $files = array()) { @@ -50,8 +44,6 @@ public function replace(array $files = array()) /** * {@inheritdoc} - * - * @api */ public function set($key, $value) { @@ -64,8 +56,6 @@ public function set($key, $value) /** * {@inheritdoc} - * - * @api */ public function add(array $files = array()) { diff --git a/HeaderBag.php b/HeaderBag.php index ffbd5433c..bcf143099 100644 --- a/HeaderBag.php +++ b/HeaderBag.php @@ -15,8 +15,6 @@ * HeaderBag is a container for HTTP headers. * * @author Fabien Potencier - * - * @api */ class HeaderBag implements \IteratorAggregate, \Countable { @@ -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()) { @@ -67,8 +63,6 @@ public function __toString() * Returns the headers. * * @return array An array of headers - * - * @api */ public function all() { @@ -79,8 +73,6 @@ public function all() * Returns the parameter keys. * * @return array An array of parameter keys - * - * @api */ public function keys() { @@ -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()) { @@ -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) { @@ -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) { @@ -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) { @@ -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) { @@ -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) { @@ -203,8 +183,6 @@ public function contains($key, $value) * Removes a header. * * @param string $key The HTTP header name - * - * @api */ public function remove($key) { @@ -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) { diff --git a/ParameterBag.php b/ParameterBag.php index 26ca79863..125a4d041 100644 --- a/ParameterBag.php +++ b/ParameterBag.php @@ -15,8 +15,6 @@ * ParameterBag is a container for key/value pairs. * * @author Fabien Potencier - * - * @api */ class ParameterBag implements \IteratorAggregate, \Countable { @@ -31,8 +29,6 @@ class ParameterBag implements \IteratorAggregate, \Countable * Constructor. * * @param array $parameters An array of parameters - * - * @api */ public function __construct(array $parameters = array()) { @@ -43,8 +39,6 @@ public function __construct(array $parameters = array()) * Returns the parameters. * * @return array An array of parameters - * - * @api */ public function all() { @@ -55,8 +49,6 @@ public function all() * Returns the parameter keys. * * @return array An array of parameter keys - * - * @api */ public function keys() { @@ -67,8 +59,6 @@ public function keys() * Replaces the current parameters by a new set. * * @param array $parameters An array of parameters - * - * @api */ public function replace(array $parameters = array()) { @@ -79,8 +69,6 @@ public function replace(array $parameters = array()) * Adds parameters. * * @param array $parameters An array of parameters - * - * @api */ public function add(array $parameters = array()) { @@ -97,8 +85,6 @@ public function add(array $parameters = array()) * @return mixed * * @throws \InvalidArgumentException - * - * @api */ public function get($path, $default = null, $deep = false) { @@ -154,8 +140,6 @@ public function get($path, $default = null, $deep = false) * * @param string $key The key * @param mixed $value The value - * - * @api */ public function set($key, $value) { @@ -168,8 +152,6 @@ public function set($key, $value) * @param string $key The key * * @return bool true if the parameter exists, false otherwise - * - * @api */ public function has($key) { @@ -180,8 +162,6 @@ public function has($key) * Removes a parameter. * * @param string $key The key - * - * @api */ public function remove($key) { @@ -196,8 +176,6 @@ public function remove($key) * @param bool $deep If true, a path like foo[bar] will find deeper items * * @return string The filtered value - * - * @api */ public function getAlpha($key, $default = '', $deep = false) { @@ -212,8 +190,6 @@ public function getAlpha($key, $default = '', $deep = false) * @param bool $deep If true, a path like foo[bar] will find deeper items * * @return string The filtered value - * - * @api */ public function getAlnum($key, $default = '', $deep = false) { @@ -228,8 +204,6 @@ public function getAlnum($key, $default = '', $deep = false) * @param bool $deep If true, a path like foo[bar] will find deeper items * * @return string The filtered value - * - * @api */ public function getDigits($key, $default = '', $deep = false) { @@ -245,8 +219,6 @@ public function getDigits($key, $default = '', $deep = false) * @param bool $deep If true, a path like foo[bar] will find deeper items * * @return int The filtered value - * - * @api */ public function getInt($key, $default = 0, $deep = false) { diff --git a/RedirectResponse.php b/RedirectResponse.php index 5dc0b9edd..a21eb5cc5 100644 --- a/RedirectResponse.php +++ b/RedirectResponse.php @@ -15,8 +15,6 @@ * RedirectResponse represents an HTTP response doing a redirect. * * @author Fabien Potencier - * - * @api */ class RedirectResponse extends Response { @@ -32,8 +30,6 @@ class RedirectResponse extends Response * @throws \InvalidArgumentException * * @see http://tools.ietf.org/html/rfc2616#section-10.3 - * - * @api */ public function __construct($url, $status = 302, $headers = array()) { diff --git a/Request.php b/Request.php index 4119c3552..c79bccc39 100644 --- a/Request.php +++ b/Request.php @@ -25,8 +25,6 @@ * * getUriForPath * * @author Fabien Potencier - * - * @api */ class Request { @@ -67,8 +65,6 @@ class Request * Custom parameters. * * @var \Symfony\Component\HttpFoundation\ParameterBag - * - * @api */ public $attributes; @@ -76,8 +72,6 @@ class Request * Request body parameters ($_POST). * * @var \Symfony\Component\HttpFoundation\ParameterBag - * - * @api */ public $request; @@ -85,8 +79,6 @@ class Request * Query string parameters ($_GET). * * @var \Symfony\Component\HttpFoundation\ParameterBag - * - * @api */ public $query; @@ -94,8 +86,6 @@ class Request * Server and execution environment parameters ($_SERVER). * * @var \Symfony\Component\HttpFoundation\ServerBag - * - * @api */ public $server; @@ -103,8 +93,6 @@ class Request * Uploaded files ($_FILES). * * @var \Symfony\Component\HttpFoundation\FileBag - * - * @api */ public $files; @@ -112,8 +100,6 @@ class Request * Cookies ($_COOKIE). * * @var \Symfony\Component\HttpFoundation\ParameterBag - * - * @api */ public $cookies; @@ -121,8 +107,6 @@ class Request * Headers (taken from the $_SERVER). * * @var \Symfony\Component\HttpFoundation\HeaderBag - * - * @api */ public $headers; @@ -206,8 +190,6 @@ class Request * @param array $files The FILES parameters * @param array $server The SERVER parameters * @param string|resource $content The raw body data - * - * @api */ public function __construct(array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), $content = null) { @@ -226,8 +208,6 @@ public function __construct(array $query = array(), array $request = array(), ar * @param array $files The FILES parameters * @param array $server The SERVER parameters * @param string|resource $content The raw body data - * - * @api */ public function initialize(array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), $content = null) { @@ -255,8 +235,6 @@ public function initialize(array $query = array(), array $request = array(), arr * Creates a new request with values from PHP's super globals. * * @return Request A new request - * - * @api */ public static function createFromGlobals() { @@ -300,8 +278,6 @@ public static function createFromGlobals() * @param string $content The raw body data * * @return Request A Request instance - * - * @api */ public static function create($uri, $method = 'GET', $parameters = array(), $cookies = array(), $files = array(), $server = array(), $content = null) { @@ -406,8 +382,6 @@ public static function create($uri, $method = 'GET', $parameters = array(), $coo * @param array $server The SERVER parameters * * @return Request The duplicated request - * - * @api */ public function duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null) { @@ -493,8 +467,6 @@ public function __toString() * * It overrides $_GET, $_POST, $_REQUEST, $_SERVER, $_COOKIE. * $_FILES is never overridden, see rfc1867 - * - * @api */ public function overrideGlobals() { @@ -531,8 +503,6 @@ public function overrideGlobals() * You should only list the reverse proxies that you manage directly. * * @param array $proxies A list of trusted proxies - * - * @api */ public static function setTrustedProxies(array $proxies) { @@ -730,8 +700,6 @@ public function get($key, $default = null, $deep = false) * Gets the Session. * * @return SessionInterface|null The session - * - * @api */ public function getSession() { @@ -743,8 +711,6 @@ public function getSession() * previous requests. * * @return bool - * - * @api */ public function hasPreviousSession() { @@ -760,8 +726,6 @@ public function hasPreviousSession() * is associated with a Session instance. * * @return bool true when the Request contains a Session object, false otherwise - * - * @api */ public function hasSession() { @@ -772,8 +736,6 @@ public function hasSession() * Sets the Session. * * @param SessionInterface $session The Session - * - * @api */ public function setSession(SessionInterface $session) { @@ -843,8 +805,6 @@ public function getClientIps() * * @see getClientIps() * @see http://en.wikipedia.org/wiki/X-Forwarded-For - * - * @api */ public function getClientIp() { @@ -857,8 +817,6 @@ public function getClientIp() * Returns current script name. * * @return string - * - * @api */ public function getScriptName() { @@ -878,8 +836,6 @@ public function getScriptName() * * http://localhost/mysite/about?var=1 returns '/about' * * @return string The raw path (i.e. not urldecoded) - * - * @api */ public function getPathInfo() { @@ -901,8 +857,6 @@ public function getPathInfo() * * http://localhost/we%20b/index.php returns '/we%20b' * * @return string The raw path (i.e. not urldecoded) - * - * @api */ public function getBasePath() { @@ -922,8 +876,6 @@ public function getBasePath() * script filename (e.g. index.php) if one exists. * * @return string The raw URL (i.e. not urldecoded) - * - * @api */ public function getBaseUrl() { @@ -938,8 +890,6 @@ public function getBaseUrl() * Gets the request's scheme. * * @return string - * - * @api */ public function getScheme() { @@ -958,8 +908,6 @@ public function getScheme() * configure it via "setTrustedHeaderName()" with the "client-port" key. * * @return string - * - * @api */ public function getPort() { @@ -1033,8 +981,6 @@ public function getUserInfo() * The port name will be appended to the host if it's non-standard. * * @return string - * - * @api */ public function getHttpHost() { @@ -1052,8 +998,6 @@ public function getHttpHost() * Returns the requested URI (path and query string). * * @return string The raw URI (i.e. not URI decoded) - * - * @api */ public function getRequestUri() { @@ -1083,8 +1027,6 @@ public function getSchemeAndHttpHost() * @return string A normalized URI (URL) for the Request * * @see getQueryString() - * - * @api */ public function getUri() { @@ -1101,8 +1043,6 @@ public function getUri() * @param string $path A path to use instead of the current one * * @return string The normalized URI for the path - * - * @api */ public function getUriForPath($path) { @@ -1116,8 +1056,6 @@ public function getUriForPath($path) * and have consistent escaping. * * @return string|null A normalized query string for the Request - * - * @api */ public function getQueryString() { @@ -1139,8 +1077,6 @@ public function getQueryString() * the "client-proto" key. * * @return bool - * - * @api */ public function isSecure() { @@ -1167,8 +1103,6 @@ public function isSecure() * @return string * * @throws \UnexpectedValueException when the host name is invalid - * - * @api */ public function getHost() { @@ -1218,8 +1152,6 @@ public function getHost() * Sets the request method. * * @param string $method - * - * @api */ public function setMethod($method) { @@ -1240,8 +1172,6 @@ public function setMethod($method) * * @return string The request method * - * @api - * * @see getRealMethod() */ public function getMethod() @@ -1279,8 +1209,6 @@ public function getRealMethod() * @param string $format The format * * @return string The associated mime type (null if not found) - * - * @api */ public function getMimeType($format) { @@ -1297,8 +1225,6 @@ public function getMimeType($format) * @param string $mimeType The associated mime type * * @return string|null The format (null if not found) - * - * @api */ public function getFormat($mimeType) { @@ -1322,8 +1248,6 @@ public function getFormat($mimeType) * * @param string $format The format * @param string|array $mimeTypes The associated mime types (the preferred one must be the first as it will be used as the content type) - * - * @api */ public function setFormat($format, $mimeTypes) { @@ -1346,8 +1270,6 @@ public function setFormat($format, $mimeTypes) * @param string $default The default format * * @return string The request format - * - * @api */ public function getRequestFormat($default = 'html') { @@ -1362,8 +1284,6 @@ public function getRequestFormat($default = 'html') * Sets the request format. * * @param string $format The request format. - * - * @api */ public function setRequestFormat($format) { @@ -1374,8 +1294,6 @@ public function setRequestFormat($format) * Gets the format associated with the request. * * @return string|null The format (null if no content type is present) - * - * @api */ public function getContentType() { @@ -1386,8 +1304,6 @@ public function getContentType() * Sets the default locale. * * @param string $locale - * - * @api */ public function setDefaultLocale($locale) { @@ -1412,8 +1328,6 @@ public function getDefaultLocale() * Sets the locale. * * @param string $locale - * - * @api */ public function setLocale($locale) { @@ -1446,8 +1360,6 @@ public function isMethod($method) * Checks whether the method is safe or not. * * @return bool - * - * @api */ public function isMethodSafe() { @@ -1528,8 +1440,6 @@ public function isNoCache() * @param array $locales An array of ordered available locales * * @return string|null The preferred locale - * - * @api */ public function getPreferredLanguage(array $locales = null) { @@ -1563,8 +1473,6 @@ public function getPreferredLanguage(array $locales = null) * Gets a list of languages acceptable by the client browser. * * @return array Languages ordered in the user browser preferences - * - * @api */ public function getLanguages() { @@ -1605,8 +1513,6 @@ public function getLanguages() * Gets a list of charsets acceptable by the client browser. * * @return array List of charsets in preferable order - * - * @api */ public function getCharsets() { @@ -1621,8 +1527,6 @@ public function getCharsets() * Gets a list of content types acceptable by the client browser. * * @return array List of content types in preferable order - * - * @api */ public function getAcceptableContentTypes() { @@ -1642,8 +1546,6 @@ public function getAcceptableContentTypes() * @link http://en.wikipedia.org/wiki/List_of_Ajax_frameworks#JavaScript * * @return bool true if the request is an XMLHttpRequest, false otherwise - * - * @api */ public function isXmlHttpRequest() { diff --git a/RequestMatcher.php b/RequestMatcher.php index da95c3acc..3cfb7737a 100644 --- a/RequestMatcher.php +++ b/RequestMatcher.php @@ -15,8 +15,6 @@ * RequestMatcher compares a pre-defined set of checks against a Request instance. * * @author Fabien Potencier - * - * @api */ class RequestMatcher implements RequestMatcherInterface { @@ -126,8 +124,6 @@ public function matchAttribute($key, $regexp) /** * {@inheritdoc} - * - * @api */ public function matches(Request $request) { diff --git a/RequestMatcherInterface.php b/RequestMatcherInterface.php index b45f80ce8..066e7e8bf 100644 --- a/RequestMatcherInterface.php +++ b/RequestMatcherInterface.php @@ -15,8 +15,6 @@ * RequestMatcherInterface is an interface for strategies to match a Request. * * @author Fabien Potencier - * - * @api */ interface RequestMatcherInterface { @@ -26,8 +24,6 @@ interface RequestMatcherInterface * @param Request $request The request to check for a match * * @return bool true if the request matches, false otherwise - * - * @api */ public function matches(Request $request); } diff --git a/Response.php b/Response.php index df36c5a93..27361dee8 100644 --- a/Response.php +++ b/Response.php @@ -15,8 +15,6 @@ * Response represents an HTTP response. * * @author Fabien Potencier - * - * @api */ class Response { @@ -132,8 +130,6 @@ class Response * @param array $headers An array of response headers * * @throws \InvalidArgumentException When the HTTP status code is not valid - * - * @api */ public function __construct($content = '', $status = 200, $headers = array()) { @@ -306,8 +302,6 @@ public function sendContent() * Sends HTTP headers and content. * * @return Response - * - * @api */ public function send() { @@ -351,8 +345,6 @@ public function send() * @return Response * * @throws \UnexpectedValueException - * - * @api */ public function setContent($content) { @@ -369,8 +361,6 @@ public function setContent($content) * Gets the current response content. * * @return string Content - * - * @api */ public function getContent() { @@ -383,8 +373,6 @@ public function getContent() * @param string $version The HTTP protocol version * * @return Response - * - * @api */ public function setProtocolVersion($version) { @@ -397,8 +385,6 @@ public function setProtocolVersion($version) * Gets the HTTP protocol version. * * @return string The HTTP protocol version - * - * @api */ public function getProtocolVersion() { @@ -417,8 +403,6 @@ public function getProtocolVersion() * @return Response * * @throws \InvalidArgumentException When the HTTP status code is not valid - * - * @api */ public function setStatusCode($code, $text = null) { @@ -448,8 +432,6 @@ public function setStatusCode($code, $text = null) * Retrieves the status code for the current web response. * * @return int Status code - * - * @api */ public function getStatusCode() { @@ -462,8 +444,6 @@ public function getStatusCode() * @param string $charset Character set * * @return Response - * - * @api */ public function setCharset($charset) { @@ -476,8 +456,6 @@ public function setCharset($charset) * Retrieves the response charset. * * @return string Character set - * - * @api */ public function getCharset() { @@ -494,8 +472,6 @@ public function getCharset() * validator (Last-Modified, ETag) are considered uncacheable. * * @return bool true if the response is worth caching, false otherwise - * - * @api */ public function isCacheable() { @@ -518,8 +494,6 @@ public function isCacheable() * indicator or Expires header and the calculated age is less than the freshness lifetime. * * @return bool true if the response is fresh, false otherwise - * - * @api */ public function isFresh() { @@ -531,8 +505,6 @@ public function isFresh() * the response with the origin server using a conditional GET request. * * @return bool true if the response is validateable, false otherwise - * - * @api */ public function isValidateable() { @@ -545,8 +517,6 @@ public function isValidateable() * It makes the response ineligible for serving other clients. * * @return Response - * - * @api */ public function setPrivate() { @@ -562,8 +532,6 @@ public function setPrivate() * It makes the response eligible for serving other clients. * * @return Response - * - * @api */ public function setPublic() { @@ -582,8 +550,6 @@ public function setPublic() * greater than the value provided by the origin. * * @return bool true if the response must be revalidated by a cache, false otherwise - * - * @api */ public function mustRevalidate() { @@ -596,8 +562,6 @@ public function mustRevalidate() * @return \DateTime A \DateTime instance * * @throws \RuntimeException When the header is not parseable - * - * @api */ public function getDate() { @@ -610,8 +574,6 @@ public function getDate() * @param \DateTime $date A \DateTime instance * * @return Response - * - * @api */ public function setDate(\DateTime $date) { @@ -639,8 +601,6 @@ public function getAge() * Marks the response stale by setting the Age header to be equal to the maximum age of the response. * * @return Response - * - * @api */ public function expire() { @@ -655,8 +615,6 @@ public function expire() * Returns the value of the Expires header as a DateTime instance. * * @return \DateTime|null A DateTime instance or null if the header does not exist - * - * @api */ public function getExpires() { @@ -676,8 +634,6 @@ public function getExpires() * @param \DateTime|null $date A \DateTime instance or null to remove the header * * @return Response - * - * @api */ public function setExpires(\DateTime $date = null) { @@ -700,8 +656,6 @@ public function setExpires(\DateTime $date = null) * back on an expires header. It returns null when no maximum age can be established. * * @return int|null Number of seconds - * - * @api */ public function getMaxAge() { @@ -726,8 +680,6 @@ public function getMaxAge() * @param int $value Number of seconds * * @return Response - * - * @api */ public function setMaxAge($value) { @@ -744,8 +696,6 @@ public function setMaxAge($value) * @param int $value Number of seconds * * @return Response - * - * @api */ public function setSharedMaxAge($value) { @@ -764,8 +714,6 @@ public function setSharedMaxAge($value) * revalidating with the origin. * * @return int|null The TTL in seconds - * - * @api */ public function getTtl() { @@ -782,8 +730,6 @@ public function getTtl() * @param int $seconds Number of seconds * * @return Response - * - * @api */ public function setTtl($seconds) { @@ -800,8 +746,6 @@ public function setTtl($seconds) * @param int $seconds Number of seconds * * @return Response - * - * @api */ public function setClientTtl($seconds) { @@ -816,8 +760,6 @@ public function setClientTtl($seconds) * @return \DateTime|null A DateTime instance or null if the header does not exist * * @throws \RuntimeException When the HTTP header is not parseable - * - * @api */ public function getLastModified() { @@ -832,8 +774,6 @@ public function getLastModified() * @param \DateTime|null $date A \DateTime instance or null to remove the header * * @return Response - * - * @api */ public function setLastModified(\DateTime $date = null) { @@ -852,8 +792,6 @@ public function setLastModified(\DateTime $date = null) * Returns the literal value of the ETag HTTP header. * * @return string|null The ETag HTTP header or null if it does not exist - * - * @api */ public function getEtag() { @@ -867,8 +805,6 @@ public function getEtag() * @param bool $weak Whether you want a weak ETag or not * * @return Response - * - * @api */ public function setEtag($etag = null, $weak = false) { @@ -895,8 +831,6 @@ public function setEtag($etag = null, $weak = false) * @return Response * * @throws \InvalidArgumentException - * - * @api */ public function setCache(array $options) { @@ -948,8 +882,6 @@ public function setCache(array $options) * @return Response * * @see http://tools.ietf.org/html/rfc2616#section-10.3.5 - * - * @api */ public function setNotModified() { @@ -968,8 +900,6 @@ public function setNotModified() * Returns true if the response includes a Vary header. * * @return bool true if the response includes a Vary header, false otherwise - * - * @api */ public function hasVary() { @@ -980,8 +910,6 @@ public function hasVary() * Returns an array of header names given in the Vary header. * * @return array An array of Vary names - * - * @api */ public function getVary() { @@ -1004,8 +932,6 @@ public function getVary() * @param bool $replace Whether to replace the actual value of not (true by default) * * @return Response - * - * @api */ public function setVary($headers, $replace = true) { @@ -1024,8 +950,6 @@ public function setVary($headers, $replace = true) * @param Request $request A Request instance * * @return bool true if the Response validators match the Request, false otherwise - * - * @api */ public function isNotModified(Request $request) { @@ -1057,8 +981,6 @@ public function isNotModified(Request $request) * Is response invalid? * * @return bool - * - * @api */ public function isInvalid() { @@ -1069,8 +991,6 @@ public function isInvalid() * Is response informative? * * @return bool - * - * @api */ public function isInformational() { @@ -1081,8 +1001,6 @@ public function isInformational() * Is response successful? * * @return bool - * - * @api */ public function isSuccessful() { @@ -1093,8 +1011,6 @@ public function isSuccessful() * Is the response a redirect? * * @return bool - * - * @api */ public function isRedirection() { @@ -1105,8 +1021,6 @@ public function isRedirection() * Is there a client error? * * @return bool - * - * @api */ public function isClientError() { @@ -1117,8 +1031,6 @@ public function isClientError() * Was there a server side error? * * @return bool - * - * @api */ public function isServerError() { @@ -1129,8 +1041,6 @@ public function isServerError() * Is the response OK? * * @return bool - * - * @api */ public function isOk() { @@ -1141,8 +1051,6 @@ public function isOk() * Is the response forbidden? * * @return bool - * - * @api */ public function isForbidden() { @@ -1153,8 +1061,6 @@ public function isForbidden() * Is the response a not found error? * * @return bool - * - * @api */ public function isNotFound() { @@ -1167,8 +1073,6 @@ public function isNotFound() * @param string $location * * @return bool - * - * @api */ public function isRedirect($location = null) { @@ -1179,8 +1083,6 @@ public function isRedirect($location = null) * Is the response empty? * * @return bool - * - * @api */ public function isEmpty() { diff --git a/ResponseHeaderBag.php b/ResponseHeaderBag.php index 702859f9e..a0a3f6308 100644 --- a/ResponseHeaderBag.php +++ b/ResponseHeaderBag.php @@ -15,8 +15,6 @@ * ResponseHeaderBag is a container for Response HTTP headers. * * @author Fabien Potencier - * - * @api */ class ResponseHeaderBag extends HeaderBag { @@ -45,8 +43,6 @@ class ResponseHeaderBag extends HeaderBag * Constructor. * * @param array $headers An array of HTTP headers - * - * @api */ public function __construct(array $headers = array()) { @@ -84,8 +80,6 @@ public function allPreserveCase() /** * {@inheritdoc} - * - * @api */ public function replace(array $headers = array()) { @@ -100,8 +94,6 @@ public function replace(array $headers = array()) /** * {@inheritdoc} - * - * @api */ public function set($key, $values, $replace = true) { @@ -121,8 +113,6 @@ public function set($key, $values, $replace = true) /** * {@inheritdoc} - * - * @api */ public function remove($key) { @@ -156,8 +146,6 @@ public function getCacheControlDirective($key) * Sets a cookie. * * @param Cookie $cookie - * - * @api */ public function setCookie(Cookie $cookie) { @@ -170,8 +158,6 @@ public function setCookie(Cookie $cookie) * @param string $name * @param string $path * @param string $domain - * - * @api */ public function removeCookie($name, $path = '/', $domain = null) { @@ -198,8 +184,6 @@ public function removeCookie($name, $path = '/', $domain = null) * @throws \InvalidArgumentException When the $format is invalid * * @return array - * - * @api */ public function getCookies($format = self::COOKIES_FLAT) { @@ -229,8 +213,6 @@ public function getCookies($format = self::COOKIES_FLAT) * @param string $name * @param string $path * @param string $domain - * - * @api */ public function clearCookie($name, $path = '/', $domain = null) { diff --git a/Session/Session.php b/Session/Session.php index ac626fd58..b743fe1b1 100644 --- a/Session/Session.php +++ b/Session/Session.php @@ -23,8 +23,6 @@ * * @author Fabien Potencier * @author Drak - * - * @api */ class Session implements SessionInterface, \IteratorAggregate, \Countable { diff --git a/Session/SessionInterface.php b/Session/SessionInterface.php index c1482fa08..602e54482 100644 --- a/Session/SessionInterface.php +++ b/Session/SessionInterface.php @@ -26,8 +26,6 @@ interface SessionInterface * @return bool True if session started. * * @throws \RuntimeException If session fails to start. - * - * @api */ public function start(); @@ -35,8 +33,6 @@ public function start(); * Returns the session ID. * * @return string The session ID. - * - * @api */ public function getId(); @@ -44,8 +40,6 @@ public function getId(); * Sets the session ID. * * @param string $id - * - * @api */ public function setId($id); @@ -53,8 +47,6 @@ public function setId($id); * Returns the session name. * * @return mixed The session name. - * - * @api */ public function getName(); @@ -62,8 +54,6 @@ public function getName(); * Sets the session name. * * @param string $name - * - * @api */ public function setName($name); @@ -79,8 +69,6 @@ public function setName($name); * not a Unix timestamp. * * @return bool True if session invalidated, false if error. - * - * @api */ public function invalidate($lifetime = null); @@ -95,8 +83,6 @@ public function invalidate($lifetime = null); * not a Unix timestamp. * * @return bool True if session migrated, false if error. - * - * @api */ public function migrate($destroy = false, $lifetime = null); @@ -115,8 +101,6 @@ public function save(); * @param string $name The attribute name * * @return bool true if the attribute is defined, false otherwise - * - * @api */ public function has($name); @@ -127,8 +111,6 @@ public function has($name); * @param mixed $default The default value if not found. * * @return mixed - * - * @api */ public function get($name, $default = null); @@ -137,8 +119,6 @@ public function get($name, $default = null); * * @param string $name * @param mixed $value - * - * @api */ public function set($name, $value); @@ -146,8 +126,6 @@ public function set($name, $value); * Returns attributes. * * @return array Attributes - * - * @api */ public function all(); @@ -164,15 +142,11 @@ public function replace(array $attributes); * @param string $name * * @return mixed The removed value - * - * @api */ public function remove($name); /** * Clears all attributes. - * - * @api */ public function clear(); diff --git a/Session/Storage/Handler/NullSessionHandler.php b/Session/Storage/Handler/NullSessionHandler.php index d88ce895b..1516d4314 100644 --- a/Session/Storage/Handler/NullSessionHandler.php +++ b/Session/Storage/Handler/NullSessionHandler.php @@ -17,8 +17,6 @@ * Can be used in unit testing or in a situations where persisted sessions are not desired. * * @author Drak - * - * @api */ class NullSessionHandler implements \SessionHandlerInterface { diff --git a/Session/Storage/SessionStorageInterface.php b/Session/Storage/SessionStorageInterface.php index 5dd309cad..9f81847a1 100644 --- a/Session/Storage/SessionStorageInterface.php +++ b/Session/Storage/SessionStorageInterface.php @@ -18,8 +18,6 @@ * * @author Fabien Potencier * @author Drak - * - * @api */ interface SessionStorageInterface { @@ -29,8 +27,6 @@ interface SessionStorageInterface * @throws \RuntimeException If something goes wrong starting the session. * * @return bool True if started. - * - * @api */ public function start(); @@ -45,8 +41,6 @@ public function isStarted(); * Returns the session ID. * * @return string The session ID or empty. - * - * @api */ public function getId(); @@ -54,8 +48,6 @@ public function getId(); * Sets the session ID. * * @param string $id - * - * @api */ public function setId($id); @@ -63,8 +55,6 @@ public function setId($id); * Returns the session name. * * @return mixed The session name. - * - * @api */ public function getName(); @@ -72,8 +62,6 @@ public function getName(); * Sets the session name. * * @param string $name - * - * @api */ public function setName($name); @@ -105,8 +93,6 @@ public function setName($name); * @return bool True if session regenerated, false if error * * @throws \RuntimeException If an error occurs while regenerating this storage - * - * @api */ public function regenerate($destroy = false, $lifetime = null); diff --git a/StreamedResponse.php b/StreamedResponse.php index 683568318..02c1914ad 100644 --- a/StreamedResponse.php +++ b/StreamedResponse.php @@ -23,8 +23,6 @@ * @see flush() * * @author Fabien Potencier - * - * @api */ class StreamedResponse extends Response { @@ -37,8 +35,6 @@ class StreamedResponse extends Response * @param mixed $callback A valid PHP callback * @param int $status The response status code * @param array $headers An array of response headers - * - * @api */ public function __construct($callback = null, $status = 200, $headers = array()) {