Merge "Cleaning up English messages for clarity and correctness"

[lhc/web/wiklou.git] / includes / Cookie.php

diff --git a/includes/Cookie.php b/includes/Cookie.php
index a6eb79a..e0a11a2 100644 (file)
--- a/includes/Cookie.php
+++ b/includes/Cookie.php
@@ -43,8 +43,8 @@ class Cookie {
         * cookies. Used internally after a request to parse the
         * Set-Cookie headers.
         *
-        * @param $value String: the value of the cookie
-        * @param $attr Array: possible key/values:
+        * @param string $value the value of the cookie
+        * @param array $attr possible key/values:
         *        expires A date string
         *        path    The path this cookie is used on
         *        domain  Domain this cookie is used on
@@ -82,10 +82,11 @@ class Cookie {
         * http://publicsuffix.org/
         *
         * @todo fixme fails to detect 3-letter top-level domains
-        * @todo fixme fails to detect 2-letter top-level domains for single-domain use (probably not a big problem in practice, but there are test cases)
+        * @todo fixme fails to detect 2-letter top-level domains for single-domain use (probably
+        * not a big problem in practice, but there are test cases)
         *
-        * @param $domain String: the domain to validate
-        * @param $originDomain String: (optional) the domain the cookie originates from
+        * @param string $domain the domain to validate
+        * @param string $originDomain (optional) the domain the cookie originates from
         * @return Boolean
         */
        public static function validateCookieDomain( $domain, $originDomain = null ) {
@@ -130,8 +131,14 @@ class Cookie {
                        }
 
                        if ( substr( $domain, 0, 1 ) == '.'
-                               && substr_compare( $originDomain, $domain, -strlen( $domain ),
-                                                                  strlen( $domain ), true ) != 0 ) {
+                               && substr_compare(
+                                       $originDomain,
+                                       $domain,
+                                       -strlen( $domain ),
+                                       strlen( $domain ),
+                                       true
+                               ) != 0
+                       ) {
                                return false;
                        }
                }
@@ -142,8 +149,8 @@ class Cookie {
        /**
         * Serialize the cookie jar into a format useful for HTTP Request headers.
         *
-        * @param $path String: the path that will be used. Required.
-        * @param $domain String: the domain that will be used. Required.
+        * @param string $path the path that will be used. Required.
+        * @param string $domain the domain that will be used. Required.
         * @return String
         */
        public function serializeToHttpRequest( $path, $domain ) {
@@ -166,8 +173,15 @@ class Cookie {
                if ( $domain == $this->domain
                        || ( strlen( $domain ) > strlen( $this->domain )
                                && substr( $this->domain, 0, 1 ) == '.'
-                               && substr_compare( $domain, $this->domain, -strlen( $this->domain ),
-                                                                       strlen( $this->domain ), true ) == 0 ) ) {
+                               && substr_compare(
+                                       $domain,
+                                       $this->domain,
+                                       -strlen( $this->domain ),
+                                       strlen( $this->domain ),
+                                       true
+                               ) == 0
+                       )
+               ) {
                        return true;
                }
 
@@ -197,7 +211,7 @@ class CookieJar {
         * Set a cookie in the cookie jar. Make sure only one cookie per-name exists.
         * @see Cookie::set()
         */
-       public function setCookie ( $name, $value, $attr ) {
+       public function setCookie( $name, $value, $attr ) {
                /* cookies: case insensitive, so this should work.
                 * We'll still send the cookies back in the same case we got them, though.
                 */
@@ -232,10 +246,10 @@ class CookieJar {
         * Parse the content of an Set-Cookie HTTP Response header.
         *
         * @param $cookie String
-        * @param $domain String: cookie's domain
+        * @param string $domain cookie's domain
         * @return null
         */
-       public function parseCookieResponseHeader ( $cookie, $domain ) {
+       public function parseCookieResponseHeader( $cookie, $domain ) {
                $len = strlen( 'Set-Cookie:' );
 
                if ( substr_compare( 'Set-Cookie:', $cookie, 0, $len, true ) === 0 ) {