Updates all file-level docblocks

Updates all to use the new format (I found at least 4 different styles throughout the component!). Also removes redundant class-level license/copyright notices, and sorts all import statements.
laminas · Apr 17, 2018 · fcb4d5a · fcb4d5a
1 parent bc449e7
commit fcb4d5a
Show file tree

Hide file tree

Showing 42 changed files with 175 additions and 297 deletions.
diff --git a/src/Collector/AbstractCollector.php b/src/Collector/AbstractCollector.php
@@ -1,10 +1,8 @@
 <?php
 /**
- * Zend Developer Tools for Zend Framework (http://framework.zend.com/)
- *
- * @link       http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\Collector;

diff --git a/src/Collector/AutoHideInterface.php b/src/Collector/AutoHideInterface.php
@@ -1,29 +1,15 @@
 <?php
 /**
- * ZendDeveloperTools
- *
- * LICENSE
- *
- * This source file is subject to the new BSD license that is bundled
- * with this package in the file LICENSE.txt.
- * It is also available through the world-wide-web at this URL:
- * http://framework.zend.com/license/new-bsd
- * If you did not receive a copy of the license and are unable to
- * obtain it through the world-wide-web, please send an email
- * to [email protected] so we can send you a copy immediately.
- *
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd     New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\Collector;
 
 /**
  * Auto hide Interface provides the ability for collectors, to specify that
  * they can be hidden.
- *
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 interface AutoHideInterface
 {

diff --git a/src/Collector/CollectorInterface.php b/src/Collector/CollectorInterface.php
@@ -1,10 +1,8 @@
 <?php
 /**
- * Zend Developer Tools for Zend Framework (http://framework.zend.com/)
- *
- * @link       http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\Collector;
@@ -13,7 +11,6 @@
 
 /**
  * Collector Interface.
- *
  */
 interface CollectorInterface
 {

diff --git a/src/Collector/ConfigCollector.php b/src/Collector/ConfigCollector.php
@@ -1,20 +1,18 @@
 <?php
 /**
- * Zend Developer Tools for Zend Framework (http://framework.zend.com/)
- *
- * @link       http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\Collector;
 
+use Closure;
 use Serializable;
 use Traversable;
-use Closure;
+use ZendDeveloperTools\Stub\ClosureStub;
 use Zend\Mvc\MvcEvent;
 use Zend\Stdlib\ArrayUtils;
-use ZendDeveloperTools\Stub\ClosureStub;
 
 /**
  * Config data collector - dumps the contents of the `Config` and `ApplicationConfig` services

diff --git a/src/Collector/DbCollector.php b/src/Collector/DbCollector.php
@@ -1,22 +1,20 @@
 <?php
 /**
- * Zend Developer Tools for Zend Framework (http://framework.zend.com/)
- *
- * @link       http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\Collector;
 
-use Zend\Mvc\MvcEvent;
 use BjyProfiler\Db\Profiler\Profiler;
+use Serializable;
+use Zend\Mvc\MvcEvent;
 
 /**
  * Database (Zend\Db) Data Collector.
- *
  */
-class DbCollector implements CollectorInterface, AutoHideInterface, \Serializable
+class DbCollector implements CollectorInterface, AutoHideInterface, Serializable
 {
     /**
      * @var Profiler
@@ -129,15 +127,15 @@ public function getQueryTime($mode = null)
     }
 
     /**
-     * @see \Serializable
+     * @see Serializable
      */
     public function serialize()
     {
         return serialize($this->profiler);
     }
 
     /**
-     * @see \Serializable
+     * @see Serializable
      */
     public function unserialize($profiler)
     {

diff --git a/src/Collector/EventCollectorInterface.php b/src/Collector/EventCollectorInterface.php
@@ -1,10 +1,8 @@
 <?php
 /**
- * Zend Developer Tools for Zend Framework (http://framework.zend.com/)
- *
- * @link       http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\Collector;
@@ -13,7 +11,6 @@
 
 /**
  * Event Data Collector Interface.
- *
  */
 interface EventCollectorInterface
 {

diff --git a/src/Collector/ExceptionCollector.php b/src/Collector/ExceptionCollector.php
@@ -1,21 +1,18 @@
 <?php
 /**
- * Zend Developer Tools for Zend Framework (http://framework.zend.com/)
- *
- * @link       http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\Collector;
 
-use Zend\Mvc\MvcEvent;
-use Zend\Mvc\Application;
 use ZendDeveloperTools\Exception\SerializableException;
+use Zend\Mvc\Application;
+use Zend\Mvc\MvcEvent;
 
 /**
  * Exception Data Collector.
- *
  */
 class ExceptionCollector extends AbstractCollector
 {

diff --git a/src/Collector/MailCollector.php b/src/Collector/MailCollector.php
@@ -1,10 +1,8 @@
 <?php
 /**
- * Zend Developer Tools for Zend Framework (http://framework.zend.com/)
- *
- * @link       http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\Collector;

diff --git a/src/Collector/MemoryCollector.php b/src/Collector/MemoryCollector.php
@@ -1,16 +1,14 @@
 <?php
 /**
- * Zend Developer Tools for Zend Framework (http://framework.zend.com/)
- *
- * @link      http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license   http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 namespace ZendDeveloperTools\Collector;
 
-use Zend\Mvc\MvcEvent;
-use Zend\EventManager\Event;
 use ZendDeveloperTools\EventLogging\EventContextProvider;
+use Zend\EventManager\Event;
+use Zend\Mvc\MvcEvent;
 
 /**
  * Memory Data Collector.

diff --git a/src/Collector/RequestCollector.php b/src/Collector/RequestCollector.php
@@ -1,10 +1,8 @@
 <?php
 /**
- * Zend Developer Tools for Zend Framework (http://framework.zend.com/)
- *
- * @link       http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\Collector;

diff --git a/src/Collector/TimeCollector.php b/src/Collector/TimeCollector.php
@@ -1,16 +1,14 @@
 <?php
 /**
- * Zend Developer Tools for Zend Framework (http://framework.zend.com/)
- *
- * @link       http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 namespace ZendDeveloperTools\Collector;
 
-use Zend\Mvc\MvcEvent;
-use Zend\EventManager\Event;
 use ZendDeveloperTools\EventLogging\EventContextProvider;
+use Zend\EventManager\Event;
+use Zend\Mvc\MvcEvent;
 
 /**
  * Time Data Collector.

diff --git a/src/Controller/DeveloperToolsController.php b/src/Controller/DeveloperToolsController.php
@@ -1,16 +1,14 @@
 <?php
 /**
- * Zend Developer Tools for Zend Framework (http://framework.zend.com/)
- *
- * @link       http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\Controller;
 
-use Zend\View\Model\ViewModel;
 use Zend\Mvc\Controller\AbstractActionController;
+use Zend\View\Model\ViewModel;
 
 class IndexController extends AbstractActionController
 {

diff --git a/src/EventLogging/EventContextInterface.php b/src/EventLogging/EventContextInterface.php
@@ -1,8 +1,8 @@
 <?php
 /**
- * @link      http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
- * @license   http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\EventLogging;

diff --git a/src/EventLogging/EventContextProvider.php b/src/EventLogging/EventContextProvider.php
@@ -1,12 +1,13 @@
 <?php
 /**
- * @link      http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
- * @license   http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\EventLogging;
 
+use InvalidArgumentException;
 use Zend\EventManager\EventInterface;
 
 /**
@@ -55,7 +56,7 @@ public function setEvent(EventInterface $event)
     public function getEvent()
     {
         if (! $this->event) {
-            throw new \InvalidArgumentException(sprintf(
+            throw new InvalidArgumentException(sprintf(
                 '%s: expects an event to have been set.',
                 __METHOD__
             ));

diff --git a/src/Exception/CollectorException.php b/src/Exception/CollectorException.php
@@ -1,10 +1,8 @@
 <?php
 /**
- * Zend Developer Tools for Zend Framework (http://framework.zend.com/)
- *
- * @link       http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\Exception;

diff --git a/src/Exception/ExceptionInterface.php b/src/Exception/ExceptionInterface.php
@@ -1,10 +1,8 @@
 <?php
 /**
- * Zend Developer Tools for Zend Framework (http://framework.zend.com/)
- *
- * @link       http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\Exception;

diff --git a/src/Exception/InvalidOptionException.php b/src/Exception/InvalidOptionException.php
@@ -1,14 +1,14 @@
 <?php
 /**
- * Zend Developer Tools for Zend Framework (http://framework.zend.com/)
- *
- * @link       http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd New BSD License
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\Exception;
 
-class InvalidOptionException extends \InvalidArgumentException implements ExceptionInterface
+use InvalidArgumentException;
+
+class InvalidOptionException extends InvalidArgumentException implements ExceptionInterface
 {
 }
diff --git a/src/Exception/ParameterMissingException.php b/src/Exception/ParameterMissingException.php
@@ -1,21 +1,12 @@
 <?php
 /**
- * Zend Developer Tools for Zend Framework (http://framework.zend.com/)
- *
- * @link       http://github.com/zendframework/ZendDeveloperTools for the canonical source repository
- * @copyright  Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license    http://framework.zend.com/license/new-bsd New BSD License
- * @package    ZendDeveloperTools
- * @subpackage Exception
+ * @see       https://github.com/zendframework/ZendDeveloperTools for the canonical source repository
+ * @copyright Copyright (c) 2011-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/ZendDeveloperTools/blob/master/LICENSE.md New BSD License
  */
 
 namespace ZendDeveloperTools\Exception;
 
-/**
- * @category   Zend
- * @package    ZendDeveloperTools
- * @subpackage Exception
- */
 class ParameterMissingException extends \Exception implements ExceptionInterface
 {
 }