From 946478e7a129d4a403580f31310bbbede4817680 Mon Sep 17 00:00:00 2001
From: Mark Story <mark@mark-story.com>
Date: Sun, 22 Jan 2017 12:51:23 -0500
Subject: [PATCH] Update backwards compat alias generation.

Generate aliases in the new files. This allows us to resolve issues
where typehints result in fatal errors by ensuring that aliases exist
when the new class is used. The old class location forces the new
location to load which ensures that both names resolve to the same state
(class + alias loaded).

Unfortunately this requires relaxing the PSR1 side-effect rules as the
`@codingStandardsIgnoreStart` tags did not work.
---
 composer.json                         | 2 --
 phpcs.xml.dist                        | 7 ++++++-
 src/Database/Schema/Table.php         | 4 ++--
 src/Database/Schema/TableSchema.php   | 3 +++
 src/Database/backwards_compat.php     | 3 ---
 src/Http/Client.php                   | 2 ++
 src/Http/Client/Adapter/Stream.php    | 3 +++
 src/Http/Client/Auth/Basic.php        | 3 +++
 src/Http/Client/Auth/Digest.php       | 3 +++
 src/Http/Client/Auth/Oauth.php        | 3 +++
 src/Http/Client/CookieCollection.php  | 3 +++
 src/Http/Client/FormData.php          | 3 +++
 src/Http/Client/FormDataPart.php      | 3 +++
 src/Http/Client/Message.php           | 3 +++
 src/Http/Client/Request.php           | 3 +++
 src/Http/Client/Response.php          | 3 +++
 src/Http/Response.php                 | 3 +++
 src/Http/ServerRequest.php            | 3 +++
 src/Http/backwards_compat.php         | 4 ----
 src/Network/Http/Adapter/Stream.php   | 4 ++--
 src/Network/Http/Auth/Basic.php       | 4 ++--
 src/Network/Http/Auth/Digest.php      | 4 ++--
 src/Network/Http/Auth/Oauth.php       | 4 ++--
 src/Network/Http/Client.php           | 4 ++--
 src/Network/Http/CookieCollection.php | 4 ++--
 src/Network/Http/FormData.php         | 4 ++--
 src/Network/Http/FormData/Part.php    | 3 ++-
 src/Network/Http/Message.php          | 4 ++--
 src/Network/Http/Request.php          | 4 ++--
 src/Network/Http/Response.php         | 4 ++--
 src/Network/Request.php               | 4 ++--
 src/Network/Response.php              | 4 ++--
 32 files changed, 75 insertions(+), 37 deletions(-)
 delete mode 100644 src/Database/backwards_compat.php
 delete mode 100644 src/Http/backwards_compat.php

diff --git a/composer.json b/composer.json
index 5479d1d3673..875b79cb824 100644
--- a/composer.json
+++ b/composer.json
@@ -42,8 +42,6 @@
             "src/Core/functions.php",
             "src/Collection/functions.php",
             "src/I18n/functions.php",
-            "src/Database/backwards_compat.php",
-            "src/Http/backwards_compat.php",
             "src/Utility/bootstrap.php"
         ]
     },
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
index ed13fb26c0d..9d4c21b752d 100644
--- a/phpcs.xml.dist
+++ b/phpcs.xml.dist
@@ -1,4 +1,9 @@
 <?xml version="1.0"?>
 <ruleset name="CakePHP Core">
-    <rule ref="./vendor/cakephp/cakephp-codesniffer/CakePHP/ruleset.xml"/>
+ <rule ref="./vendor/cakephp/cakephp-codesniffer/CakePHP/ruleset.xml"/>
+
+ <!-- Necessary for class aliases used for backwards compat -->
+ <rule ref="PSR1.Files.SideEffects.FoundWithSymbols">
+  <severity>0</severity>
+ </rule>
 </ruleset>
diff --git a/src/Database/Schema/Table.php b/src/Database/Schema/Table.php
index a6069bea88f..d7dccd59393 100644
--- a/src/Database/Schema/Table.php
+++ b/src/Database/Schema/Table.php
@@ -1,3 +1,3 @@
 <?php
-// @deprecated Backwards compatibility with earlier 3.x versions.
-class_alias('Cake\Database\Schema\TableSchema', 'Cake\Database\Schema\Table');
+// @deprecated Load new class and alias
+class_exists('Cake\Database\Schema\TableSchema');
diff --git a/src/Database/Schema/TableSchema.php b/src/Database/Schema/TableSchema.php
index 94f1b45b4c5..05bb72bb9f1 100644
--- a/src/Database/Schema/TableSchema.php
+++ b/src/Database/Schema/TableSchema.php
@@ -879,3 +879,6 @@ public function dropConstraintSql(ConnectionInterface $connection)
         return $dialect->dropConstraintSql($this);
     }
 }
+
+// @deprecated Add backwards compat alias.
+class_alias('Cake\Database\Schema\TableSchema', 'Cake\Database\Schema\Table');
diff --git a/src/Database/backwards_compat.php b/src/Database/backwards_compat.php
deleted file mode 100644
index e9780d4c949..00000000000
--- a/src/Database/backwards_compat.php
+++ /dev/null
@@ -1,3 +0,0 @@
-<?php
-// Ensure backwards compat aliases exists.
-class_exists('Cake\Database\Schema\Table');
diff --git a/src/Http/Client.php b/src/Http/Client.php
index 81516506445..ad8630b83dc 100644
--- a/src/Http/Client.php
+++ b/src/Http/Client.php
@@ -549,3 +549,5 @@ protected function _createAuth($auth, $options)
         return new $class($this, $options);
     }
 }
+// @deprecated Backwards compatibility with earler 3.x versions.
+class_alias('Cake\Http\Client', 'Cake\Network\Http\Client');
diff --git a/src/Http/Client/Adapter/Stream.php b/src/Http/Client/Adapter/Stream.php
index 019462d5574..dbf0bb85b06 100644
--- a/src/Http/Client/Adapter/Stream.php
+++ b/src/Http/Client/Adapter/Stream.php
@@ -320,3 +320,6 @@ public function contextOptions()
         return array_merge($this->_contextOptions, $this->_sslContextOptions);
     }
 }
+
+// @deprecated Add backwards compat alias.
+class_alias('Cake\Http\Client\Adapter\Stream', 'Cake\Network\Http\Adapter\Stream');
diff --git a/src/Http/Client/Auth/Basic.php b/src/Http/Client/Auth/Basic.php
index 853e8cbc576..4a37bdb437f 100644
--- a/src/Http/Client/Auth/Basic.php
+++ b/src/Http/Client/Auth/Basic.php
@@ -72,3 +72,6 @@ protected function _generateHeader($user, $pass)
         return 'Basic ' . base64_encode($user . ':' . $pass);
     }
 }
+
+// @deprecated Add backwards compat alias.
+class_alias('Cake\Http\Client\Auth\Basic', 'Cake\Network\Http\Auth\Basic');
diff --git a/src/Http/Client/Auth/Digest.php b/src/Http/Client/Auth/Digest.php
index 2f513f7b192..1d5eea22ab0 100644
--- a/src/Http/Client/Auth/Digest.php
+++ b/src/Http/Client/Auth/Digest.php
@@ -142,3 +142,6 @@ protected function _generateHeader(Request $request, $credentials)
         return $authHeader;
     }
 }
+
+// @deprecated Add backwards compat alias.
+class_alias('Cake\Http\Client\Auth\Digest', 'Cake\Network\Http\Auth\Digest');
diff --git a/src/Http/Client/Auth/Oauth.php b/src/Http/Client/Auth/Oauth.php
index 8fe7dd964c5..bdfe941b1b8 100644
--- a/src/Http/Client/Auth/Oauth.php
+++ b/src/Http/Client/Auth/Oauth.php
@@ -350,3 +350,6 @@ protected function _encode($value)
         );
     }
 }
+
+// @deprecated Add backwards compat alias.
+class_alias('Cake\Http\Client\Auth\Oauth', 'Cake\Network\Http\Auth\Oauth');
diff --git a/src/Http/Client/CookieCollection.php b/src/Http/Client/CookieCollection.php
index f036adc0719..c4ba8ea3fbc 100644
--- a/src/Http/Client/CookieCollection.php
+++ b/src/Http/Client/CookieCollection.php
@@ -117,3 +117,6 @@ public function getAll()
         return array_values($this->_cookies);
     }
 }
+
+// @deprecated Add backwards compat alias.
+class_alias('Cake\Http\Client\CookieCollection', 'Cake\Network\Http\CookieCollection');
diff --git a/src/Http/Client/FormData.php b/src/Http/Client/FormData.php
index ed9f5997ce2..aa946966301 100644
--- a/src/Http/Client/FormData.php
+++ b/src/Http/Client/FormData.php
@@ -268,3 +268,6 @@ public function __toString()
         return http_build_query($data);
     }
 }
+
+// @deprecated Add backwards compat alias.
+class_alias('Cake\Http\Client\FormData', 'Cake\Network\Http\FormData');
diff --git a/src/Http/Client/FormDataPart.php b/src/Http/Client/FormDataPart.php
index 40f7fea6357..e1f0df5b31e 100644
--- a/src/Http/Client/FormDataPart.php
+++ b/src/Http/Client/FormDataPart.php
@@ -221,3 +221,6 @@ public function __toString()
         return $out;
     }
 }
+
+// @deprecated Add backwards compat alias.
+class_alias('Cake\Http\Client\FormDataPart', 'Cake\Network\Http\FormData\Part');
diff --git a/src/Http/Client/Message.php b/src/Http/Client/Message.php
index aeddafdffe2..0afc4d2b442 100644
--- a/src/Http/Client/Message.php
+++ b/src/Http/Client/Message.php
@@ -171,3 +171,6 @@ public function body($body = null)
         return $this;
     }
 }
+
+// @deprecated Add backwards compat alias.
+class_alias('Cake\Http\Client\Message', 'Cake\Network\Http\Message');
diff --git a/src/Http/Client/Request.php b/src/Http/Client/Request.php
index 15ac07d273c..10882031664 100644
--- a/src/Http/Client/Request.php
+++ b/src/Http/Client/Request.php
@@ -254,3 +254,6 @@ public function body($body = null)
         return $this;
     }
 }
+
+// @deprecated Add backwards compat alias.
+class_alias('Cake\Http\Client\Request', 'Cake\Network\Http\Request');
diff --git a/src/Http/Client/Response.php b/src/Http/Client/Response.php
index 5dab10f4646..0589c6acc25 100644
--- a/src/Http/Client/Response.php
+++ b/src/Http/Client/Response.php
@@ -601,3 +601,6 @@ public function __isset($name)
         return isset($this->{$key});
     }
 }
+
+// @deprecated Add backwards compat alias.
+class_alias('Cake\Http\Client\Response', 'Cake\Network\Http\Response');
diff --git a/src/Http/Response.php b/src/Http/Response.php
index 2f702b961f4..974da18ef09 100644
--- a/src/Http/Response.php
+++ b/src/Http/Response.php
@@ -2439,3 +2439,6 @@ public function __debugInfo()
         ];
     }
 }
+
+// @deprecated Add backwards compat alias.
+class_alias('Cake\Http\Response', 'Cake\Network\Response');
diff --git a/src/Http/ServerRequest.php b/src/Http/ServerRequest.php
index 1ca4ab6422c..9bde731c4c2 100644
--- a/src/Http/ServerRequest.php
+++ b/src/Http/ServerRequest.php
@@ -2132,3 +2132,6 @@ public function offsetUnset($name)
         unset($this->params[$name]);
     }
 }
+
+// @deprecated Add backwards compat alias.
+class_alias('Cake\Http\ServerRequest', 'Cake\Network\Request');
diff --git a/src/Http/backwards_compat.php b/src/Http/backwards_compat.php
deleted file mode 100644
index fb73833278a..00000000000
--- a/src/Http/backwards_compat.php
+++ /dev/null
@@ -1,4 +0,0 @@
-<?php
-// Ensure backwards compat aliases exists.
-class_exists('Cake\Network\Request');
-class_exists('Cake\Network\Response');
diff --git a/src/Network/Http/Adapter/Stream.php b/src/Network/Http/Adapter/Stream.php
index adce34d16c8..4cdf7731bb4 100644
--- a/src/Network/Http/Adapter/Stream.php
+++ b/src/Network/Http/Adapter/Stream.php
@@ -1,3 +1,3 @@
 <?php
-// @deprecated Backwards compatibility with earler 3.x versions.
-class_alias('Cake\Http\Client\Adapter\Stream', 'Cake\Network\Http\Adapter\Stream');
+// @deprecated Load new class and alias.
+class_exists('Cake\Http\Client\Adapter\Stream');
diff --git a/src/Network/Http/Auth/Basic.php b/src/Network/Http/Auth/Basic.php
index 6a97f7de2c8..c05e371bd2b 100644
--- a/src/Network/Http/Auth/Basic.php
+++ b/src/Network/Http/Auth/Basic.php
@@ -1,3 +1,3 @@
 <?php
-// @deprecated Backwards compatibility with earler 3.x versions.
-class_alias('Cake\Http\Client\Auth\Basic', 'Cake\Network\Http\Auth\Basic');
+// @deprecated Load new class and alias.
+class_exists('Cake\Http\Client\Auth\Basic');
diff --git a/src/Network/Http/Auth/Digest.php b/src/Network/Http/Auth/Digest.php
index 2309728d40f..1ae1614e46c 100644
--- a/src/Network/Http/Auth/Digest.php
+++ b/src/Network/Http/Auth/Digest.php
@@ -1,3 +1,3 @@
 <?php
-// @deprecated Backwards compatibility with earler 3.x versions.
-class_alias('Cake\Http\Client\Auth\Digest', 'Cake\Network\Http\Auth\Digest');
+// @deprecated Load new class and alias.
+class_exists('Cake\Http\Client\Auth\Digest');
diff --git a/src/Network/Http/Auth/Oauth.php b/src/Network/Http/Auth/Oauth.php
index 0a242c24e5e..6e91ad916df 100644
--- a/src/Network/Http/Auth/Oauth.php
+++ b/src/Network/Http/Auth/Oauth.php
@@ -1,3 +1,3 @@
 <?php
-// @deprecated Backwards compatibility with earler 3.x versions.
-class_alias('Cake\Http\Client\Auth\Oauth', 'Cake\Network\Http\Auth\Oauth');
+// @deprecated Load new class and alias.
+class_exists('Cake\Http\Client\Auth\Oauth');
diff --git a/src/Network/Http/Client.php b/src/Network/Http/Client.php
index 5b00aecc351..5c767aa3882 100644
--- a/src/Network/Http/Client.php
+++ b/src/Network/Http/Client.php
@@ -1,3 +1,3 @@
 <?php
-// @deprecated Backwards compatibility with earler 3.x versions.
-class_alias('Cake\Http\Client', 'Cake\Network\Http\Client');
+// @deprecated Load new class and alias.
+class_exists('Cake\Http\Client');
diff --git a/src/Network/Http/CookieCollection.php b/src/Network/Http/CookieCollection.php
index 677157987de..fff589e3a7b 100644
--- a/src/Network/Http/CookieCollection.php
+++ b/src/Network/Http/CookieCollection.php
@@ -1,3 +1,3 @@
 <?php
-// @deprecated Backwards compatibility with earler 3.x versions.
-class_alias('Cake\Http\Client\CookieCollection', 'Cake\Network\Http\CookieCollection');
+// @deprecated Load new class and alias.
+class_exists('Cake\Http\Client\CookieCollection');
diff --git a/src/Network/Http/FormData.php b/src/Network/Http/FormData.php
index f7d0e63784a..1b037ab69e1 100644
--- a/src/Network/Http/FormData.php
+++ b/src/Network/Http/FormData.php
@@ -1,3 +1,3 @@
 <?php
-// @deprecated Backwards compatibility with earler 3.x versions.
-class_alias('Cake\Http\Client\FormData', 'Cake\Network\Http\FormData');
+// @deprecated Load new class and alias.
+class_exists('Cake\Http\Client\FormData');
diff --git a/src/Network/Http/FormData/Part.php b/src/Network/Http/FormData/Part.php
index a7894f83336..315709e899b 100644
--- a/src/Network/Http/FormData/Part.php
+++ b/src/Network/Http/FormData/Part.php
@@ -1,2 +1,3 @@
 <?php
-class_alias('Cake\Http\Client\FormDataPart', 'Cake\Network\Http\FormData\Part');
+// @deprecated Load new class and alias.
+class_exists('Cake\Http\Client\FormDataPart');
diff --git a/src/Network/Http/Message.php b/src/Network/Http/Message.php
index 3ef51cbc231..07b04f6c4a0 100644
--- a/src/Network/Http/Message.php
+++ b/src/Network/Http/Message.php
@@ -1,3 +1,3 @@
 <?php
-// @deprecated Backwards compatibility with earler 3.x versions.
-class_alias('Cake\Http\Client\Message', 'Cake\Network\Http\Message');
+// @deprecated Load new class and alias.
+class_exists('Cake\Http\Client\Message');
diff --git a/src/Network/Http/Request.php b/src/Network/Http/Request.php
index 05f17ebe262..e697638a693 100644
--- a/src/Network/Http/Request.php
+++ b/src/Network/Http/Request.php
@@ -1,3 +1,3 @@
 <?php
-// @deprecated Backwards compatibility with earler 3.x versions.
-class_alias('Cake\Http\Client\Request', 'Cake\Network\Http\Request');
+// @deprecated Load new class and alias.
+class_exists('Cake\Http\Client\Request');
diff --git a/src/Network/Http/Response.php b/src/Network/Http/Response.php
index ccc3f89342c..10bf32e09d3 100644
--- a/src/Network/Http/Response.php
+++ b/src/Network/Http/Response.php
@@ -1,3 +1,3 @@
 <?php
-// @deprecated Backwards compatibility with earler 3.x versions.
-class_alias('Cake\Http\Client\Response', 'Cake\Network\Http\Response');
+// @deprecated Load new class and alias.
+class_exists('Cake\Http\Client\Response');
diff --git a/src/Network/Request.php b/src/Network/Request.php
index 78381410336..2f4228db302 100644
--- a/src/Network/Request.php
+++ b/src/Network/Request.php
@@ -1,3 +1,3 @@
 <?php
-// @deprecated Backwards compatibility with earler 3.x versions.
-class_alias('Cake\Http\ServerRequest', 'Cake\Network\Request');
+// @deprecated Load new class and alias
+class_exists('Cake\Http\ServerRequest');
diff --git a/src/Network/Response.php b/src/Network/Response.php
index 0754cb6e9df..350fd02c6a9 100644
--- a/src/Network/Response.php
+++ b/src/Network/Response.php
@@ -1,3 +1,3 @@
 <?php
-// @deprecated Backwards compatibility with earler 3.x versions.
-class_alias('Cake\Http\Response', 'Cake\Network\Response');
+// @deprecated Load new class and alias
+class_exists('Cake\Http\Response');