Rewriting as Laminas Project package

Author: weierophinney

.gitignore

@@ -1,2 +1,2 @@
-composer.lock
-vendor/
+/composer.lock
+/vendor/

.travis.yml

@@ -17,5 +17,4 @@ after_script:
   - php ./vendor/bin/coveralls -v
 
 notifications:
-  irc: "irc.freenode.org#apigility-dev"
   email: false

COPYRIGHT.md

@@ -0,0 +1,2 @@
+Copyright (c) 2019, Laminas Foundation.
+All rights reserved. (https://getlaminas.org/)

Module.php

@@ -1,13 +1,15 @@
 <?php
+
 /**
- * @license   http://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
- * @copyright Copyright (c) 2014 Zend Technologies USA Inc. (http://www.zend.com)
+ * @see       https://github.com/laminas-api-tools/api-tools-documentation for the canonical source repository
+ * @copyright https://github.com/laminas-api-tools/api-tools-documentation/blob/master/COPYRIGHT.md
+ * @license   https://github.com/laminas-api-tools/api-tools-documentation/blob/master/LICENSE.md New BSD License
  */
 
-namespace ZF\Apigility\Documentation;
+namespace Laminas\ApiTools\Documentation;
 
-use Zend\ModuleManager\Feature\AutoloaderProviderInterface;
-use Zend\ModuleManager\Feature\ConfigProviderInterface;
+use Laminas\ModuleManager\Feature\AutoloaderProviderInterface;
+use Laminas\ModuleManager\Feature\ConfigProviderInterface;
 
 class Module implements AutoloaderProviderInterface, ConfigProviderInterface
 {
@@ -19,7 +21,7 @@ public function getConfig()
     public function getAutoloaderConfig()
     {
         return array(
-            'Zend\Loader\StandardAutoloader' => array(
+            'Laminas\Loader\StandardAutoloader' => array(
                 'namespaces' => array(
                     __NAMESPACE__ => __DIR__ . '/src/',
                 ),
@@ -30,11 +32,11 @@ public function getAutoloaderConfig()
     public function getServiceConfig()
     {
         return array('factories' => array(
-            'ZF\Apigility\Documentation\ApiFactory' => function ($services) {
+            'Laminas\ApiTools\Documentation\ApiFactory' => function ($services) {
                     return new ApiFactory(
-                        $services->get('Zend\ModuleManager\ModuleManager'),
+                        $services->get('Laminas\ModuleManager\ModuleManager'),
                         $services->get('Config'),
-                        $services->get('ZF\Configuration\ModuleUtils')
+                        $services->get('Laminas\ApiTools\Configuration\ModuleUtils')
                     );
                 }
         ));

README.md

@@ -1,12 +1,12 @@
-ZF Apigility Documentation
+Laminas API Tools Documentation
 ==========================
 
-[![Build Status](https://travis-ci.org/zfcampus/zf-apigility-documentation.png)](https://travis-ci.org/zfcampus/zf-apigility-documentation)
+[![Build Status](https://travis-ci.org/laminas-api-tools/api-tools-documentation.png)](https://travis-ci.org/laminas-api-tools/api-tools-documentation)
 
 Introduction
 ------------
 
-This ZF2 module can be used with conjunction with Apigility in order to:
+This Laminas module can be used with conjunction with Laminas API Tools in order to:
 
 - provide an object model of all captured documentation information, including:
   - All APIs available.
@@ -20,7 +20,7 @@ This ZF2 module can be used with conjunction with Apigility in order to:
   - end-users may configure alternate/additional formats via content-negotiation.
 
 This module accomplishes all the above use cases by providing an endpoint to connect to
-(`/apigility/documentation[/:api[-v:version][/:service]]`), using content-negotiation to provide
+(`/api-tools/documentation[/:api[-v:version][/:service]]`), using content-negotiation to provide
 both HTML and JSON representations.
 
 Installation
@@ -29,14 +29,14 @@ Installation
 Run the following `composer` command:
 
 ```console
-$ composer require "zfcampus/zf-apigility-documentation:~1.0-dev"
+$ composer require "laminas-api-tools/api-tools-documentation:~1.0-dev"
 ```
 
 Alternately, manually add the following to your `composer.json`, in the `require` section:
 
 ```javascript
 "require": {
-    "zfcampus/zf-apigility-documentation": "~1.0-dev"
+    "laminas-api-tools/api-tools-documentation": "~1.0-dev"
 }
 ```
 
@@ -50,7 +50,7 @@ return array(
     /* ... */
     'modules' => array(
         /* ... */
-        'ZF\Apigility\Documentation',
+        'Laminas\ApiTools\Documentation',
     ),
     /* ... */
 );
@@ -65,23 +65,23 @@ This module does not utilize any user configuration.
 
 ### System Configuration
 
-The following configuration is defined by the module to ensure operation within a Zend Framework 2
+The following configuration is defined by the module to ensure operation within a Laminas
 MVC application.
 
 ```php
 'router' => array(
     'routes' => array(
-        'zf-apigility' => array(
+        'api-tools' => array(
             'child_routes' => array(
                 'documentation' => array(
-                    'type' => 'Zend\Mvc\Router\Http\Segment',
+                    'type' => 'Laminas\Mvc\Router\Http\Segment',
                     'options' => array(
                         'route'    => '/documentation[/:api[-v:version][/:service]]',
                         'constraints' => array(
                             'api' => '[a-zA-Z][a-zA-Z0-9_]+',
                         ),
                         'defaults' => array(
-                            'controller' => 'ZF\Apigility\Documentation\Controller',
+                            'controller' => 'Laminas\ApiTools\Documentation\Controller',
                             'action'     => 'show',
                         ),
                     ),
@@ -92,25 +92,25 @@ MVC application.
 ),
 'controllers' => array(
     'factories' => array(
-        'ZF\Apigility\Documentation\Controller' => 'ZF\Apigility\Documentation\ControllerFactory',
+        'Laminas\ApiTools\Documentation\Controller' => 'Laminas\ApiTools\Documentation\ControllerFactory',
     ),
 ),
-'zf-content-negotiation' => array(
+'api-tools-content-negotiation' => array(
     'controllers' => array(
-        'ZF\Apigility\Documentation\Controller' => 'Documentation',
+        'Laminas\ApiTools\Documentation\Controller' => 'Documentation',
     ),
     'accept_whitelist' => array(
-        'ZF\Apigility\Documentation\Controller' => array(
+        'Laminas\ApiTools\Documentation\Controller' => array(
             0 => 'application/vnd.swagger+json',
             1 => 'application/json',
         ),
     ),
     'selectors' => array(
         'Documentation' => array(
-            'ZF\Apigility\Documentation\JsonModel' => array(
+            'Laminas\ApiTools\Documentation\JsonModel' => array(
                 'application/json',
             ),
-            'Zend\View\Model\ViewModel' => array(
+            'Laminas\View\Model\ViewModel' => array(
                 'text/html',
                 'application/xhtml+xml',
             ),
@@ -119,10 +119,10 @@ MVC application.
 ),
 'view_helpers' => array(
     'invokables' => array(
-        'agacceptheaders'      => 'ZF\Apigility\Documentation\View\AgAcceptHeaders',
-        'agcontenttypeheaders' => 'ZF\Apigility\Documentation\View\AgContentTypeHeaders',
-        'agservicepath'        => 'ZF\Apigility\Documentation\View\AgServicePath',
-        'agstatuscodes'        => 'ZF\Apigility\Documentation\View\AgStatusCodes',
+        'agacceptheaders'      => 'Laminas\ApiTools\Documentation\View\AgAcceptHeaders',
+        'agcontenttypeheaders' => 'Laminas\ApiTools\Documentation\View\AgContentTypeHeaders',
+        'agservicepath'        => 'Laminas\ApiTools\Documentation\View\AgServicePath',
+        'agstatuscodes'        => 'Laminas\ApiTools\Documentation\View\AgStatusCodes',
     ),
 ),
 'view_manager' => array(
@@ -132,37 +132,37 @@ MVC application.
 ),
 ```
 
-ZF2 Events
+Laminas Events
 ==========
 
 This module has no events or listeners.
 
-ZF2 Services
+Laminas Services
 ============
 
 ### View Helpers
 
 The following list of view helpers assist in making API documentation models presentable in view
 scripts.
 
-- `ZF\Apigility\Documentation\View\AgAcceptHeaders` (a.k.a `agAcceptHeaders`) for making a
+- `Laminas\ApiTools\Documentation\View\AgAcceptHeaders` (a.k.a `agAcceptHeaders`) for making a
   list of `Accept` headers, escaped for HTML.
-- `ZF\Apigility\Documentation\View\AgContentTypeHeaders`  (a.k.a `agContentTypeHeaders`) for
+- `Laminas\ApiTools\Documentation\View\AgContentTypeHeaders`  (a.k.a `agContentTypeHeaders`) for
   making a list of `Content-Type` headers, escaped for HTML.
-- `ZF\Apigility\Documentation\View\AgServicePath` (a.k.a `agServicePath`) for making an HTML
+- `Laminas\ApiTools\Documentation\View\AgServicePath` (a.k.a `agServicePath`) for making an HTML
   view representation of the route configuration of a service path.
-- `ZF\Apigility\Documentation\View\AgStatusCodes` (a.k.a `agStatusCodes`) for making an
+- `Laminas\ApiTools\Documentation\View\AgStatusCodes` (a.k.a `agStatusCodes`) for making an
   escaped list of status codes and their messages.
 
 ### Factories
 
-#### `ZF\Apigility\Documentation\ApiFactory`
+#### `Laminas\ApiTools\Documentation\ApiFactory`
 
 The `ApiFactory` service is capable of producing an object-graph representation of the desired
 API documentation that is requested.  This object-graph will be composed of the following types:
 
-- `ZF\Apigility\Documentation\Api`: the root node of an API.
-- `ZF\Apigility\Documentation\Services`: an array of services in the API (a service can be one
+- `Laminas\ApiTools\Documentation\Api`: the root node of an API.
+- `Laminas\ApiTools\Documentation\Services`: an array of services in the API (a service can be one
   of a REST or RPC style service).
-- `ZF\Apigility\Documentation\Operations`: an array of operations in the service.
-- `ZF\Apigility\Documentation\Fields`: an array of fields for a service.
+- `Laminas\ApiTools\Documentation\Operations`: an array of operations in the service.
+- `Laminas\ApiTools\Documentation\Fields`: an array of fields for a service.

composer.json

@@ -1,21 +1,24 @@
 {
-    "name": "zfcampus/zf-apigility-documentation",
-    "description": "Apigility API documentation module",
-    "type": "library",
+    "name": "laminas-api-tools/api-tools-documentation",
+    "description": "Laminas API Tools API documentation module",
     "license": "BSD-3-Clause",
     "keywords": [
-        "zf2",
-        "zend",
+        "laminas",
+        "api-tools",
         "module",
-        "apigiltiy",
         "documentation"
     ],
-    "homepage": "http://apigility.org/",
+    "homepage": "https://api-tools.getlaminas.org",
     "support": {
-        "email": "apigility-users@zend.com",
-        "irc": "irc://irc.freenode.net/apigility",
-        "source": "https://github.com/zfcampus/zf-apigility-documentation",
-        "issues": "https://github.com/zfcampus/zf-apigility-documentation/issues"
+        "docs": "https://api-tools.getlaminas.org/documentation",
+        "issues": "https://github.com/laminas-api-tools/api-tools-documentation/issues",
+        "source": "https://github.com/laminas-api-tools/api-tools-documentation",
+        "rss": "https://github.com/laminas-api-tools/api-tools-documentation/releases.atom",
+        "chat": "https://laminas.dev/chat",
+        "forum": "https://discourse.laminas.dev"
+    },
+    "config": {
+        "sort-packages": true
     },
     "extra": {
         "branch-alias": {
@@ -24,20 +27,24 @@
     },
     "require": {
         "php": ">=5.3.23",
-        "zendframework/zendframework": "~2.3"
+        "laminas/laminas": "~2.3",
+        "laminas/laminas-zendframework-bridge": "^1.0"
     },
     "require-dev": {
         "fabpot/php-cs-fixer": "*@dev",
-        "phpunit/PHPUnit": "3.7.*",
+        "phpunit/phpunit": "3.7.*",
         "satooshi/php-coveralls": ">=0.6.0"
     },
     "autoload": {
         "psr-4": {
-            "ZF\\Apigility\\Documentation\\": "src/",
-            "ZFTest\\Apigility\\Documentation\\": "test/"
+            "Laminas\\ApiTools\\Documentation\\": "src/",
+            "LaminasTest\\ApiTools\\Documentation\\": "test/"
         },
         "classmap": [
             "Module.php"
         ]
+    },
+    "replace": {
+        "zfcampus/zf-apigility-documentation": "self.version"
     }
 }

config/module.config.php

@@ -1,23 +1,25 @@
 <?php
+
 /**
- * @license   http://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
- * @copyright Copyright (c) 2014 Zend Technologies USA Inc. (http://www.zend.com)
+ * @see       https://github.com/laminas-api-tools/api-tools-documentation for the canonical source repository
+ * @copyright https://github.com/laminas-api-tools/api-tools-documentation/blob/master/COPYRIGHT.md
+ * @license   https://github.com/laminas-api-tools/api-tools-documentation/blob/master/LICENSE.md New BSD License
  */
 
 return array(
     'router' => array(
         'routes' => array(
-            'zf-apigility' => array(
+            'api-tools' => array(
                 'child_routes' => array(
                     'documentation' => array(
-                        'type' => 'Zend\Mvc\Router\Http\Segment',
+                        'type' => 'Laminas\Mvc\Router\Http\Segment',
                         'options' => array(
                             'route'    => '/documentation[/:api[-v:version][/:service]]',
                             'constraints' => array(
                                 'api' => '[a-zA-Z][a-zA-Z0-9_]+',
                             ),
                             'defaults' => array(
-                                'controller' => 'ZF\Apigility\Documentation\Controller',
+                                'controller' => 'Laminas\ApiTools\Documentation\Controller',
                                 'action'     => 'show',
                             ),
                         ),
@@ -28,25 +30,25 @@
     ),
     'controllers' => array(
         'factories' => array(
-            'ZF\Apigility\Documentation\Controller' => 'ZF\Apigility\Documentation\ControllerFactory',
+            'Laminas\ApiTools\Documentation\Controller' => 'Laminas\ApiTools\Documentation\ControllerFactory',
         ),
     ),
-    'zf-content-negotiation' => array(
+    'api-tools-content-negotiation' => array(
         'controllers' => array(
-            'ZF\Apigility\Documentation\Controller' => 'Documentation',
+            'Laminas\ApiTools\Documentation\Controller' => 'Documentation',
         ),
         'accept_whitelist' => array(
-            'ZF\Apigility\Documentation\Controller' => array(
+            'Laminas\ApiTools\Documentation\Controller' => array(
                 0 => 'application/vnd.swagger+json',
                 1 => 'application/json',
             ),
         ),
         'selectors' => array(
             'Documentation' => array(
-                'ZF\Apigility\Documentation\JsonModel' => array(
+                'Laminas\ApiTools\Documentation\JsonModel' => array(
                     'application/json',
                 ),
-                'Zend\View\Model\ViewModel' => array(
+                'Laminas\View\Model\ViewModel' => array(
                     'text/html',
                     'application/xhtml+xml',
                 ),
@@ -55,10 +57,10 @@
     ),
     'view_helpers' => array(
         'invokables' => array(
-            'agacceptheaders'      => 'ZF\Apigility\Documentation\View\AgAcceptHeaders',
-            'agcontenttypeheaders' => 'ZF\Apigility\Documentation\View\AgContentTypeHeaders',
-            'agservicepath'        => 'ZF\Apigility\Documentation\View\AgServicePath',
-            'agstatuscodes'        => 'ZF\Apigility\Documentation\View\AgStatusCodes',
+            'agacceptheaders'      => 'Laminas\ApiTools\Documentation\View\AgAcceptHeaders',
+            'agcontenttypeheaders' => 'Laminas\ApiTools\Documentation\View\AgContentTypeHeaders',
+            'agservicepath'        => 'Laminas\ApiTools\Documentation\View\AgServicePath',
+            'agstatuscodes'        => 'Laminas\ApiTools\Documentation\View\AgStatusCodes',
         ),
     ),
     'view_manager' => array(

phpunit.xml

@@ -1,6 +1,6 @@
 <phpunit bootstrap="./test/Bootstrap.php" colors="true">
     <testsuites>
-        <testsuite name="ZF Apigility Documentation Module Tests">
+        <testsuite name="Laminas API Tools Documentation Module Tests">
             <directory>./test</directory>
         </testsuite>
     </testsuites>