Requests_Cookie_Jar: change to namespaced class

Includes: * Moving the namespaced version of the class to the `src` directory. * [Custom autoload] Adding the class to the `$deprecated_classes` array in the `WpOrg\Requests\Autoload` class. * [Composer autoload] Adding the class to the `Deprecated.php` file. * Updating all references to the class.
WordPress · Sep 17, 2021 · d0b8c06 · d0b8c06
1 parent 53c9204
commit d0b8c06
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 21 deletions.
diff --git a/examples/cookie_jar.php b/examples/cookie_jar.php
@@ -7,7 +7,7 @@
 WpOrg\Requests\Autoload::register();
 
 // Say you need to fake a login cookie
-$c = new Requests_Cookie_Jar(['login_uid' => 'something']);
+$c = new WpOrg\Requests\Cookie\Jar(['login_uid' => 'something']);
 
 // Now let's make a request!
 $request = WpOrg\Requests\Requests::get(

diff --git a/library/Deprecated.php b/library/Deprecated.php
@@ -43,3 +43,4 @@ class Requests_Session extends WpOrg\Requests\Session {}
 class Requests_SSL extends WpOrg\Requests\Ssl {}
 
 class Requests_Auth_Basic extends WpOrg\Requests\Auth\Basic {}
+class Requests_Cookie_Jar extends WpOrg\Requests\Cookie\Jar {}
diff --git a/src/Autoload.php b/src/Autoload.php
@@ -50,6 +50,7 @@ class Autoload {
 			'requests_session'     => '\WpOrg\Requests\Session',
 			'requests_ssl'         => '\WpOrg\Requests\Ssl',
 			'requests_auth_basic'  => '\WpOrg\Requests\Auth\Basic',
+			'requests_cookie_jar'  => '\WpOrg\Requests\Cookie\Jar',
 		);
 
 		/**

diff --git a/library/Requests/Cookie/Jar.php → src/Cookie/Jar.php b/library/Requests/Cookie/Jar.php → src/Cookie/Jar.php
@@ -6,6 +6,12 @@
  * @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\Hooker;
@@ -18,7 +24,7 @@
  * @package Requests
  * @subpackage Cookies
  */
-class Requests_Cookie_Jar implements ArrayAccess, IteratorAggregate {
+class Jar implements ArrayAccess, IteratorAggregate {
 	/**
 	 * Actual item data
 	 *
@@ -105,7 +111,7 @@ public function offsetUnset($key) {
 	/**
 	 * Get an iterator for the data
 	 *
-	 * @return ArrayIterator
+	 * @return \ArrayIterator
 	 */
 	#[ReturnTypeWillChange]
 	public function getIterator() {

diff --git a/src/Requests.php b/src/Requests.php
@@ -11,11 +11,11 @@
 
 namespace WpOrg\Requests;
 
-use Requests_Cookie_Jar;
 use Requests_Proxy_HTTP;
 use Requests_Transport_cURL;
 use Requests_Transport_fsockopen;
 use WpOrg\Requests\Auth\Basic;
+use WpOrg\Requests\Cookie\Jar;
 use WpOrg\Requests\Exception;
 use WpOrg\Requests\Hooks;
 use WpOrg\Requests\IdnaEncoder;
@@ -388,7 +388,7 @@ public static function request($url, $headers = array(), $data = array(), $type
 	 *    parameter to {@see \WpOrg\Requests\Requests::request}
 	 *    (string, default: `\WpOrg\Requests\Requests::GET`)
 	 * - `cookies`: Associative array of cookie name to value, or cookie jar.
-	 *    (array|Requests_Cookie_Jar)
+	 *    (array|\WpOrg\Requests\Cookie\Jar)
 	 *
 	 * If the `$options` parameter is specified, individual requests will
 	 * inherit options from it. This can be used to use a single hooking system,
@@ -565,10 +565,10 @@ protected static function set_defaults(&$url, &$headers, &$data, &$type, &$optio
 		}
 
 		if (is_array($options['cookies'])) {
-			$options['cookies'] = new Requests_Cookie_Jar($options['cookies']);
+			$options['cookies'] = new Jar($options['cookies']);
 		}
 		elseif (empty($options['cookies'])) {
-			$options['cookies'] = new Requests_Cookie_Jar();
+			$options['cookies'] = new Jar();
 		}
 		if ($options['cookies'] !== false) {
 			$options['cookies']->register($options['hooks']);

diff --git a/src/Response.php b/src/Response.php
@@ -8,9 +8,9 @@
 
 namespace WpOrg\Requests;
 
-use Requests_Cookie_Jar;
 use Requests_Exception_HTTP;
 use Requests_Response_Headers;
+use WpOrg\Requests\Cookie\Jar;
 use WpOrg\Requests\Exception;
 
 /**
@@ -25,7 +25,7 @@ class Response {
 	 */
 	public function __construct() {
 		$this->headers = new Requests_Response_Headers();
-		$this->cookies = new Requests_Cookie_Jar();
+		$this->cookies = new Jar();
 	}
 
 	/**
@@ -94,7 +94,7 @@ public function __construct() {
 	/**
 	 * Cookies from the request
 	 *
-	 * @var Requests_Cookie_Jar Array-like object representing a cookie jar
+	 * @var \WpOrg\Requests\Cookie\Jar Array-like object representing a cookie jar
 	 */
 	public $cookies = array();
 

diff --git a/src/Session.php b/src/Session.php
@@ -8,7 +8,7 @@
 
 namespace WpOrg\Requests;
 
-use Requests_Cookie_Jar;
+use WpOrg\Requests\Cookie\Jar;
 use WpOrg\Requests\Iri;
 use WpOrg\Requests\Requests;
 
@@ -78,7 +78,7 @@ public function __construct($url = null, $headers = array(), $data = array(), $o
 		$this->options = $options;
 
 		if (empty($this->options['cookies'])) {
-			$this->options['cookies'] = new Requests_Cookie_Jar();
+			$this->options['cookies'] = new Jar();
 		}
 	}
 

diff --git a/tests/CookiesTest.php b/tests/CookiesTest.php
@@ -3,10 +3,10 @@
 namespace Requests\Tests;
 
 use Requests\Tests\TestCase;
-use Requests_Cookie_Jar;
 use Requests_Response_Headers;
 use Requests_Utility_CaseInsensitiveDictionary;
 use WpOrg\Requests\Cookie;
+use WpOrg\Requests\Cookie\Jar;
 use WpOrg\Requests\Exception;
 use WpOrg\Requests\Iri;
 use WpOrg\Requests\Requests;
@@ -46,10 +46,10 @@ public function testEmptyAttributes() {
 	}
 
 	public function testCookieJarSetter() {
-		$jar1                        = new Requests_Cookie_Jar();
+		$jar1                        = new Jar();
 		$jar1['requests-testcookie'] = 'testvalue';
 
-		$jar2 = new Requests_Cookie_Jar(
+		$jar2 = new Jar(
 			array(
 				'requests-testcookie' => 'testvalue',
 			)
@@ -58,7 +58,7 @@ public function testCookieJarSetter() {
 	}
 
 	public function testCookieJarUnsetter() {
-		$jar                        = new Requests_Cookie_Jar();
+		$jar                        = new Jar();
 		$jar['requests-testcookie'] = 'testvalue';
 
 		$this->assertSame('testvalue', $jar['requests-testcookie']);
@@ -71,7 +71,7 @@ public function testCookieJarUnsetter() {
 	public function testCookieJarAsList() {
 		$this->expectException(Exception::class);
 		$this->expectExceptionMessage('Object is a dictionary, not a list');
-		$cookies   = new Requests_Cookie_Jar();
+		$cookies   = new Jar();
 		$cookies[] = 'requests-testcookie1=testvalue1';
 	}
 
@@ -80,7 +80,7 @@ public function testCookieJarIterator() {
 			'requests-testcookie1' => 'testvalue1',
 			'requests-testcookie2' => 'testvalue2',
 		);
-		$jar     = new Requests_Cookie_Jar($cookies);
+		$jar     = new Jar($cookies);
 
 		foreach ($jar as $key => $value) {
 			$this->assertSame($cookies[$key], $value);
@@ -154,7 +154,7 @@ public function testCookieExpiration() {
 	}
 
 	public function testSendingCookieWithJar() {
-		$cookies = new Requests_Cookie_Jar(
+		$cookies = new Jar(
 			array(
 				'requests-testcookie1' => 'testvalue1',
 			)
@@ -180,7 +180,7 @@ public function testSendingMultipleCookies() {
 	}
 
 	public function testSendingMultipleCookiesWithJar() {
-		$cookies = new Requests_Cookie_Jar(
+		$cookies = new Jar(
 			array(
 				'requests-testcookie1' => 'testvalue1',
 				'requests-testcookie2' => 'testvalue2',
@@ -196,7 +196,7 @@ public function testSendingMultipleCookiesWithJar() {
 	}
 
 	public function testSendingPrebakedCookie() {
-		$cookies = new Requests_Cookie_Jar(
+		$cookies = new Jar(
 			array(
 				new Cookie('requests-testcookie', 'testvalue'),
 			)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -43,3 +43,4 @@ class Requests_Session extends WpOrg\Requests\Session {}
		class Requests_SSL extends WpOrg\Requests\Ssl {}

		class Requests_Auth_Basic extends WpOrg\Requests\Auth\Basic {}
		class Requests_Cookie_Jar extends WpOrg\Requests\Cookie\Jar {}