Changeset 52328 for trunk/src/wp-includes/Requests/Cookie/Jar.php

Timestamp:

12/06/2021 09:29:00 PM (3 years ago)

Author:

SergeyBiryukov

Message:

HTTP API: Revert changeset [52244].

Reverting Requests 2.0.0 changes and moving to WordPress 6.0 cycle. Why? The namespace and file case renaming revealed 2 issues in Core's upgrader process.

See https://core.trac.wordpress.org/ticket/54504#comment:22 for more information.

Follow-up to [52327].

See #54562, #54504.

File:

• trunk/src/wp-includes/Requests/Cookie/Jar.php (modified) (11 diffs)

trunk/src/wp-includes/Requests/Cookie/Jar.php

@@ -3 +3 @@
  * Cookie holder object
  *
- * @package Requests\Cookies
+ * @package Requests
+ * @subpackage Cookies
  */
-
-namespace WpOrg\Requests\Cookie;
-
-use ArrayAccess;
-use ArrayIterator;
-use IteratorAggregate;
-use ReturnTypeWillChange;
-use WpOrg\Requests\Cookie;
-use WpOrg\Requests\Exception;
-use WpOrg\Requests\Exception\InvalidArgument;
-use WpOrg\Requests\HookManager;
-use WpOrg\Requests\Iri;
-use WpOrg\Requests\Response;
 
 /**
  * Cookie holder object
  *
- * @package Requests\Cookies
+ * @package Requests
+ * @subpackage Cookies
  */
-class Jar implements ArrayAccess, IteratorAggregate {
+class Requests_Cookie_Jar implements ArrayAccess, IteratorAggregate {
     /**
      * Actual item data
@@ -30 +19 @@
      * @var array
      */
-    protected $cookies = [];
+    protected $cookies = array();
 
     /**
@@ -36 +25 @@
      *
      * @param array $cookies Existing cookie values
-     *
-     * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed argument is not an array.
      */
-    public function __construct($cookies = []) {
-        if (is_array($cookies) === false) {
-            throw InvalidArgument::create(1, '$cookies', 'array', gettype($cookies));
-        }
-
+    public function __construct($cookies = array()) {
         $this->cookies = $cookies;
     }
 
     /**
-     * Normalise cookie data into a \WpOrg\Requests\Cookie
+     * Normalise cookie data into a Requests_Cookie
      *
-     * @param string|\WpOrg\Requests\Cookie $cookie
-     * @return \WpOrg\Requests\Cookie
+     * @param string|Requests_Cookie $cookie
+     * @return Requests_Cookie
      */
-    public function normalize_cookie($cookie, $key = '') {
-        if ($cookie instanceof Cookie) {
+    public function normalize_cookie($cookie, $key = null) {
+        if ($cookie instanceof Requests_Cookie) {
             return $cookie;
         }
 
-        return Cookie::parse($cookie, $key);
+        return Requests_Cookie::parse($cookie, $key);
+    }
+
+    /**
+     * Normalise cookie data into a Requests_Cookie
+     *
+     * @codeCoverageIgnore
+     * @deprecated Use {@see Requests_Cookie_Jar::normalize_cookie}
+     * @return Requests_Cookie
+     */
+    public function normalizeCookie($cookie, $key = null) {
+        return $this->normalize_cookie($cookie, $key);
     }
 
@@ -64 +58 @@
      * Check if the given item exists
      *
-     * @param string $offset Item key
+     * @param string $key Item key
      * @return boolean Does the item exist?
      */
-    #[ReturnTypeWillChange]
-    public function offsetExists($offset) {
-        return isset($this->cookies[$offset]);
+    public function offsetExists($key) {
+        return isset($this->cookies[$key]);
     }
 
@@ -75 +68 @@
      * Get the value for the item
      *
-     * @param string $offset Item key
+     * @param string $key Item key
      * @return string|null Item value (null if offsetExists is false)
      */
-    #[ReturnTypeWillChange]
-    public function offsetGet($offset) {
-        if (!isset($this->cookies[$offset])) {
+    public function offsetGet($key) {
+        if (!isset($this->cookies[$key])) {
             return null;
         }
 
-        return $this->cookies[$offset];
+        return $this->cookies[$key];
     }
 
@@ -90 +82 @@
      * Set the given item
      *
-     * @param string $offset Item name
+     * @throws Requests_Exception On attempting to use dictionary as list (`invalidset`)
+     *
+     * @param string $key Item name
      * @param string $value Item value
-     *
-     * @throws \WpOrg\Requests\Exception On attempting to use dictionary as list (`invalidset`)
      */
-    #[ReturnTypeWillChange]
-    public function offsetSet($offset, $value) {
-        if ($offset === null) {
-            throw new Exception('Object is a dictionary, not a list', 'invalidset');
+    public function offsetSet($key, $value) {
+        if ($key === null) {
+            throw new Requests_Exception('Object is a dictionary, not a list', 'invalidset');
         }
 
-        $this->cookies[$offset] = $value;
+        $this->cookies[$key] = $value;
     }
 
@@ -107 +98 @@
      * Unset the given header
      *
-     * @param string $offset
+     * @param string $key
      */
-    #[ReturnTypeWillChange]
-    public function offsetUnset($offset) {
-        unset($this->cookies[$offset]);
+    public function offsetUnset($key) {
+        unset($this->cookies[$key]);
     }
 
@@ -117 +107 @@
      * Get an iterator for the data
      *
-     * @return \ArrayIterator
+     * @return ArrayIterator
      */
-    #[ReturnTypeWillChange]
     public function getIterator() {
         return new ArrayIterator($this->cookies);
@@ -127 +116 @@
      * Register the cookie handler with the request's hooking system
      *
-     * @param \WpOrg\Requests\HookManager $hooks Hooking system
+     * @param Requests_Hooker $hooks Hooking system
      */
-    public function register(HookManager $hooks) {
-        $hooks->register('requests.before_request', [$this, 'before_request']);
-        $hooks->register('requests.before_redirect_check', [$this, 'before_redirect_check']);
+    public function register(Requests_Hooker $hooks) {
+        $hooks->register('requests.before_request', array($this, 'before_request'));
+        $hooks->register('requests.before_redirect_check', array($this, 'before_redirect_check'));
     }
 
@@ -146 +135 @@
      */
     public function before_request($url, &$headers, &$data, &$type, &$options) {
-        if (!$url instanceof Iri) {
-            $url = new Iri($url);
+        if (!$url instanceof Requests_IRI) {
+            $url = new Requests_IRI($url);
         }
 
         if (!empty($this->cookies)) {
-            $cookies = [];
+            $cookies = array();
             foreach ($this->cookies as $key => $cookie) {
                 $cookie = $this->normalize_cookie($cookie, $key);
@@ -172 +161 @@
      * Parse all cookies from a response and attach them to the response
      *
-     * @param \WpOrg\Requests\Response $response
+     * @var Requests_Response $response
      */
-    public function before_redirect_check(Response $response) {
-        $url = $response->url;
-        if (!$url instanceof Iri) {
-            $url = new Iri($url);
+    public function before_redirect_check(Requests_Response $return) {
+        $url = $return->url;
+        if (!$url instanceof Requests_IRI) {
+            $url = new Requests_IRI($url);
         }
 
-        $cookies           = Cookie::parse_from_headers($response->headers, $url);
-        $this->cookies     = array_merge($this->cookies, $cookies);
-        $response->cookies = $this;
+        $cookies         = Requests_Cookie::parse_from_headers($return->headers, $url);
+        $this->cookies   = array_merge($this->cookies, $cookies);
+        $return->cookies = $this;
     }
 }