فهرست منبع

Merge remote branch 'brikou/phpdoc_request'

* brikou/phpdoc_request:
  removed docblock for isNoCache
  fixed the description of isNoCache method
  fixed description for isNoCache method
  added missing method's docblock
Fabien Potencier 14 سال پیش
والد
کامیت
d88f6b9c24
1فایلهای تغییر یافته به همراه45 افزوده شده و 0 حذف شده
  1. 45 0
      src/Symfony/Component/HttpFoundation/Request.php

+ 45 - 0
src/Symfony/Component/HttpFoundation/Request.php

@@ -326,6 +326,11 @@ class Request
         return $this->query->get($key, $this->attributes->get($key, $this->request->get($key, $default, $deep), $deep), $deep);
     }
 
+    /**
+     * Gets the Session.
+     * 
+     * @return Session|null The session
+     */
     public function getSession()
     {
         return $this->session;
@@ -353,6 +358,11 @@ class Request
         return null !== $this->session;
     }
 
+    /**
+     * Sets the Session.
+     * 
+     * @param Session $session The Session
+     */
     public function setSession(Session $session)
     {
         $this->session = $session;
@@ -449,11 +459,21 @@ class Request
         return $this->baseUrl;
     }
 
+    /**
+     * Gets the request's scheme.
+     * 
+     * @return string
+     */
     public function getScheme()
     {
         return $this->isSecure() ? 'https' : 'http';
     }
 
+    /**
+     * Returns the port on which the request is made.
+     * 
+     * @return string
+     */
     public function getPort()
     {
         return $this->headers->get('X-Forwarded-Port') ?: $this->server->get('SERVER_PORT');
@@ -480,6 +500,11 @@ class Request
         return $name.':'.$port;
     }
 
+    /**
+     * Returns the requested URI.
+     * 
+     * @return string
+     */
     public function getRequestUri()
     {
         if (null === $this->requestUri) {
@@ -550,6 +575,11 @@ class Request
         return implode('&', $parts);
     }
 
+    /**
+     * Checks whether the request is secure or not.
+     * 
+     * @return Boolean
+     */
     public function isSecure()
     {
         return (
@@ -586,6 +616,11 @@ class Request
         return trim($host);
     }
 
+    /**
+     * Sets the request method.
+     * 
+     * @param string $method
+     */
     public function setMethod($method)
     {
         $this->method = null;
@@ -689,6 +724,11 @@ class Request
         $this->format = $format;
     }
 
+    /**
+     * Checks whether the method is safe or not.
+     * 
+     * @return Boolean
+     */
     public function isMethodSafe()
     {
         return in_array($this->getMethod(), array('GET', 'HEAD'));
@@ -720,6 +760,11 @@ class Request
         return $this->content;
     }
 
+    /**
+     * Gets the Etags.
+     * 
+     * @return array The entity tags
+     */
     public function getETags()
     {
         return preg_split('/\s*,\s*/', $this->headers->get('if_none_match'), null, PREG_SPLIT_NO_EMPTY);