Add "@deprecated" notices to code with "NOTE" texts (#29)

rougin · Mar 27, 2024 · 6ca29a9 · 6ca29a9
1 parent 900d92e
commit 6ca29a9
Show file tree

Hide file tree

Showing 67 changed files with 157 additions and 140 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@ All notable changes to `Slytherin` will be documented in this file.
 ### Added
 - `phpcsfixer.php` as custom rules for the `friendsofphp/php-cs-fixer` package
 - Test cases for the complete code coverage after running `friendsofphp/php-cs-fixer`
+- `@deprecated` notices for specified classes from previous versions
 
 ### Changed
 - `Router::__construct` supports adding `RouteInterface` in the array

diff --git a/src/Application.php b/src/Application.php
@@ -5,9 +5,9 @@
 use Rougin\Slytherin\System\Routing;
 
 /**
- * Application
+ * @deprecated since ~0.9, use "Routing" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "Routing" instead.
+ * Application
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Application/Application.php b/src/Application/Application.php
@@ -5,9 +5,9 @@
 use Rougin\Slytherin\Application as Slytherin;
 
 /**
- * Application
+ * @deprecated since ~0.9, use "\Application" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "\Application" instead.
+ * Application
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Component/Collection.php b/src/Component/Collection.php
@@ -33,8 +33,9 @@ public function __construct()
     }
 
     /**
+     * @deprecated since ~0.9, use "set" instead.
+     *
      * Adds an instance to the container.
-     * NOTE: To be removed in v1.0.0. Use "set" instead.
      *
      * @param  string $id
      * @param  object $concrete
@@ -79,8 +80,9 @@ public function getDebugger()
     }
 
     /**
+     * @deprecated since ~0.4, use "getContainer" instead.
+     *
      * Returns the dependency injector.
-     * NOTE: To be removed in v1.0.0. Use "getContainer" instead.
      *
      * @return \Rougin\Slytherin\Container\ContainerInterface
      */
@@ -101,8 +103,9 @@ public function getDispatcher()
     }
 
     /**
+     * @deprecated since ~0.4, use "getDebugger" instead.
+     *
      * Returns the error handler.
-     * NOTE: To be removed in v1.0.0. Use "getDebugger" instead.
      *
      * @return \Rougin\Slytherin\Debug\ErrorHandlerInterface
      */
@@ -215,8 +218,9 @@ public function setDebugger(ErrorHandlerInterface $debugger)
     }
 
     /**
+     * @deprecated since ~0.4, use "setContainer" instead.
+     *
      * Sets the dependency injector.
-     * NOTE: To be removed in v1.0.0. Use "setContainer" instead.
      *
      * @param  \Rougin\Slytherin\Container\ContainerInterface $injector
      * @return self
@@ -238,8 +242,9 @@ public function setDispatcher(Routing $dispatcher)
     }
 
     /**
+     * @deprecated since ~0.4, use "setDebugger" instead.
+     *
      * Sets the error handler.
-     * NOTE: To be removed in v1.0.0. Use "setDebugger" instead.
      *
      * @param  \Rougin\Slytherin\Debug\ErrorHandlerInterface $debugger
      * @return self

diff --git a/src/ComponentCollection.php b/src/ComponentCollection.php
@@ -3,13 +3,13 @@
 namespace Rougin\Slytherin;
 
 /**
- * Component Collection
+ * @deprecated since ~0.4, use "Components" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "Component\Collection" instead.
+ * Component Collection
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>
  */
-class ComponentCollection extends Component\Collection
+class ComponentCollection extends Components
 {
 }
diff --git a/src/Components.php b/src/Components.php
@@ -2,14 +2,16 @@
 
 namespace Rougin\Slytherin;
 
+use Rougin\Slytherin\Component\Collection;
+
 /**
- * Component Collection
+ * @deprecated since ~0.4, use "Component\Collection" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "ComponentCollection" instead.
+ * Component Collection
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>
  */
-class Components extends ComponentCollection
+class Components extends Collection
 {
 }
diff --git a/src/Configuration.php b/src/Configuration.php
@@ -3,9 +3,9 @@
 namespace Rougin\Slytherin;
 
 /**
- * Configuration
+ * @deprecated since ~0.9, use "Integration/Configuration" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "Integration/Configuration" instead.
+ * Configuration
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Container/AurynContainer.php b/src/Container/AurynContainer.php
@@ -46,8 +46,9 @@ public function __construct(Injector $injector)
     }
 
     /**
+     * @deprecated since ~0.9, use "set" instead.
+     *
      * Adds a new instance to the container.
-     * NOTE: To be removed in v1.0.0. Use "set" instead.
      *
      * @param  string     $id
      * @param  mixed|null $concrete

diff --git a/src/Container/Container.php b/src/Container/Container.php
@@ -28,8 +28,9 @@ public function __construct(array $items = array())
     }
 
     /**
+     * @deprecated since ~0.9, use "set" instead.
+     *
      * Adds a new instance to the container.
-     * NOTE: To be removed in v1.0.0. Use "set" instead.
      *
      * @param  string $id
      * @param  mixed  $concrete

diff --git a/src/Container/Exception/ContainerException.php b/src/Container/Exception/ContainerException.php
@@ -5,9 +5,9 @@
 use Rougin\Slytherin\Container\ContainerException as Slytherin;
 
 /**
- * Container Exception
+ * @deprecated since ~0.9, use "Container\ContainerException" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "Container\ContainerException" instead.
+ * Container Exception
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Container/Exception/NotFoundException.php b/src/Container/Exception/NotFoundException.php
@@ -5,9 +5,9 @@
 use Rougin\Slytherin\Container\NotFoundException as Slytherin;
 
 /**
- * Not Found Exception
+ * @deprecated since ~0.9, use "Container\NotFoundException" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "Container\NotFoundException" instead.
+ * Not Found Exception
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Container/VanillaContainer.php b/src/Container/VanillaContainer.php
@@ -3,9 +3,9 @@
 namespace Rougin\Slytherin\Container;
 
 /**
- * Container
+ * @deprecated since ~0.9, use "Container" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "Container" instead.
+ * Container
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Debug/Debugger.php b/src/Debug/Debugger.php
@@ -5,9 +5,9 @@
 use Rougin\Slytherin\Debug\Vanilla\Debugger as Slytherin;
 
 /**
- * Debugger
+ * @deprecated since ~0.8, use "Vanilla\Debugger" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "VanillaDebugger" instead.
+ * Debugger
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Debug/DebuggerInterface.php b/src/Debug/DebuggerInterface.php
@@ -3,9 +3,9 @@
 namespace Rougin\Slytherin\Debug;
 
 /**
- * Debugger Interface
+ * @deprecated since ~0.9, use "ErrorHandlerInterface" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "ErrorHandlerInterface" instead.
+ * Debugger Interface
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Debug/ErrorHandler.php b/src/Debug/ErrorHandler.php
@@ -26,8 +26,9 @@ public function __construct($environment = 'development')
     }
 
     /**
+     * @deprecated since ~0.9, already not part of the "ErrorHandlerInterface".
+     *
      * Sets up the environment to be used.
-     * NOTE: To be removed in v1.0.0. It is not part of the "ErrorHandlerInterface".
      *
      * @param  string $environment
      * @return self
@@ -40,8 +41,9 @@ public function setEnvironment($environment)
     }
 
     /**
+     * @deprecated since ~0.9, already not part of the "ErrorHandlerInterface".
+     *
      * Returns the specified environment.
-     * NOTE: To be removed in v1.0.0. It is not part of the "ErrorHandlerInterface".
      *
      * @return string
      */

diff --git a/src/Debug/Vanilla/Debugger.php b/src/Debug/Vanilla/Debugger.php
@@ -5,9 +5,9 @@
 use Rougin\Slytherin\Debug\VanillaErrorHandler;
 
 /**
- * Debugger
+ * @deprecated since ~0.9, use "VanillaErrorHandler" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "VanillaErrorHandler" instead.
+ * Debugger
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Debug/VanillaErrorHandler.php b/src/Debug/VanillaErrorHandler.php
@@ -3,9 +3,9 @@
 namespace Rougin\Slytherin\Debug;
 
 /**
- * Error Handler
+ * @deprecated since ~0.9, use "ErrorHandler" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "ErrorHandler" instead.
+ * Error Handler
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Debug/Whoops/Debugger.php b/src/Debug/Whoops/Debugger.php
@@ -5,9 +5,9 @@
 use Rougin\Slytherin\Debug\WhoopsErrorHandler;
 
 /**
- * Debugger
+ * @deprecated since ~0.9, use "WhoopsErrorHandler" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "WhoopsErrorHandler" instead.
+ * Debugger
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Debug/WhoopsDebugger.php b/src/Debug/WhoopsDebugger.php
@@ -5,9 +5,9 @@
 use Rougin\Slytherin\Debug\Whoops\Debugger as Slytherin;
 
 /**
- * Whoops Debugger
+ * @deprecated since ~0.8, use "Whoops\Debugger" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "Whoops\Debugger" instead.
+ * Whoops Debugger
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Debug/WhoopsErrorHandler.php b/src/Debug/WhoopsErrorHandler.php
@@ -39,8 +39,9 @@ public function __construct(Run $whoops, $environment = 'development')
     }
 
     /**
+     * @deprecated since ~0.9, already not part of the "ErrorHandlerInterface".
+     *
      * Sets up the environment to be used.
-     * NOTE: To be removed in v1.0.0. It is not part of the "ErrorHandlerInterface".
      *
      * @param  string $environment
      * @return self
@@ -53,8 +54,9 @@ public function setEnvironment($environment)
     }
 
     /**
+     * @deprecated since ~0.9, already not part of the "ErrorHandlerInterface".
+     *
      * Returns the specified environment.
-     * NOTE: To be removed in v1.0.0. It is not part of the "ErrorHandlerInterface".
      *
      * @return string
      */
@@ -64,8 +66,9 @@ public function getEnvironment()
     }
 
     /**
+     * @deprecated since ~0.9, use magic method "__call" instead.
+     *
      * Returns a listing of handlers.
-     * NOTE: To be removed in v1.0.0. Use the magic method "__call" instead.
      *
      * @return \Whoops\Handler\HandlerInterface[]
      */
@@ -91,8 +94,9 @@ public function display()
     }
 
     /**
+     * @deprecated since ~0.9, use magic method "__call" instead.
+     *
      * Sets a handler.
-     * NOTE: To be removed in v1.0.0. Use __call" instead.
      *
      * @param  \Whoops\Handler\HandlerInterface|callable $handler
      * @return void

diff --git a/src/Dispatching/BaseRouter.php b/src/Dispatching/BaseRouter.php
@@ -5,9 +5,9 @@
 use Rougin\Slytherin\Routing\Router as Slytherin;
 
 /**
- * Base Router
+ * @deprecated since ~0.9, use "Routing\Router" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "Routing\Router" instead.
+ * Base Router
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Dispatching/Dispatcher.php b/src/Dispatching/Dispatcher.php
@@ -5,9 +5,9 @@
 use Rougin\Slytherin\Dispatching\Vanilla\Dispatcher as Slytherin;
 
 /**
- * Dispatcher
+ * @deprecated since ~0.8, use "Vanilla\Dispatcher" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "Vanilla\Dispatcher" instead.
+ * Dispatcher
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Dispatching/DispatcherInterface.php b/src/Dispatching/DispatcherInterface.php
@@ -5,9 +5,9 @@
 use Rougin\Slytherin\Routing\DispatcherInterface as Slytherin;
 
 /**
- * Dispatcher Interface
+ * @deprecated since ~0.9, use "Routing\DispatcherInterface" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "Routing\DispatcherInterface" instead.
+ * Dispatcher Interface
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Dispatching/FastRoute/Dispatcher.php b/src/Dispatching/FastRoute/Dispatcher.php
@@ -5,9 +5,9 @@
 use Rougin\Slytherin\Routing\FastRoute\Dispatcher as Slytherin;
 
 /**
- * FastRoute Dispatcher
+ * @deprecated since ~0.9, use "Routing\FastRoute\Dispatcher" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "Routing\FastRoute\Dispatcher" instead.
+ * FastRoute Dispatcher
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>

diff --git a/src/Dispatching/FastRoute/Router.php b/src/Dispatching/FastRoute/Router.php
@@ -5,9 +5,9 @@
 use Rougin\Slytherin\Routing\FastRoute\Router as Slytherin;
 
 /**
- * FastRoute Router
+ * @deprecated since ~0.9, use "Routing\FastRoute\Router" instead.
  *
- * NOTE: To be removed in v1.0.0. Use "Routing\FastRoute\Router" instead.
+ * FastRoute Router
  *
  * @package Slytherin
  * @author  Rougin Gutib <rougingutib@gmail.com>