Rewriting as Laminas Project package

Author: weierophinney

.gitattributes

@@ -2,7 +2,6 @@
 /.gitattributes export-ignore
 /.gitignore export-ignore
 /.travis.yml export-ignore
-/composer.lock export-ignore
 /docs/ export-ignore
 /phpcs.xml export-ignore
 /phpunit.xml.dist export-ignore

.gitignore

@@ -1,4 +1,5 @@
 /clover.xml
+/composer.lock
 /coveralls-upload.json
 /phpunit.xml
 /vendor/

.travis.yml

@@ -1,5 +1,3 @@
-sudo: false
-
 language: php
 
 cache:
@@ -12,24 +10,17 @@ env:
     - COVERAGE_DEPS="php-coveralls/php-coveralls"
 
 matrix:
+  fast_finish: true
   include:
     - php: 5.6
       env:
         - DEPS=lowest
-    - php: 5.6
-      env:
-        - DEPS=locked
-        - LEGACY_DEPS="phpunit/phpunit"
     - php: 5.6
       env:
         - DEPS=latest
     - php: 7
       env:
         - DEPS=lowest
-    - php: 7
-      env:
-        - DEPS=locked
-        - LEGACY_DEPS="phpunit/phpunit"
     - php: 7
       env:
         - DEPS=latest
@@ -38,18 +29,12 @@ matrix:
         - DEPS=lowest
     - php: 7.1
       env:
-        - DEPS=locked
+        - DEPS=latest
         - CS_CHECK=true
         - TEST_COVERAGE=true
-    - php: 7.1
-      env:
-        - DEPS=latest
     - php: 7.2
       env:
         - DEPS=lowest
-    - php: 7.2
-      env:
-        - DEPS=locked
     - php: 7.2
       env:
         - DEPS=latest

CHANGELOG.md

@@ -28,13 +28,13 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Added
 
-- [#69](https://github.com/zfcampus/zf-apigility-documentation/pull/69) adds support for PHP 7.1 and 7.2.
+- [zfcampus/zf-apigility-documentation#69](https://github.com/zfcampus/zf-apigility-documentation/pull/69) adds support for PHP 7.1 and 7.2.
 
-- [#59](https://github.com/zfcampus/zf-apigility-documentation/pull/59) adds the ability to specify examples for fields.
+- [zfcampus/zf-apigility-documentation#59](https://github.com/zfcampus/zf-apigility-documentation/pull/59) adds the ability to specify examples for fields.
 
 ### Changed
 
-- [#62](https://github.com/zfcampus/zf-apigility-documentation/pull/62) updates the `ZF\Apigility\Documentation\Controller` to accept a `BasePath`
+- [zfcampus/zf-apigility-documentation#62](https://github.com/zfcampus/zf-apigility-documentation/pull/62) updates the `Laminas\ApiTools\Documentation\Controller` to accept a `BasePath`
   view helper as a construction aregument; this is then used to prefix any generated links with
   the currently detected/configured base path to the application.
 
@@ -44,14 +44,14 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Removed
 
-- [#69](https://github.com/zfcampus/zf-apigility-documentation/pull/69) removes support for HHVM.
+- [zfcampus/zf-apigility-documentation#69](https://github.com/zfcampus/zf-apigility-documentation/pull/69) removes support for HHVM.
 
 ### Fixed
 
-- [#59](https://github.com/zfcampus/zf-apigility-documentation/pull/59) provides a fix to configuration detection that removes an emitted
-  notice when no zf-rpc and/or no zf-rest configuration is present.
+- [zfcampus/zf-apigility-documentation#59](https://github.com/zfcampus/zf-apigility-documentation/pull/59) provides a fix to configuration detection that removes an emitted
+  notice when no api-tools-rpc and/or no api-tools-rest configuration is present.
 
-- [#59](https://github.com/zfcampus/zf-apigility-documentation/pull/59) fixes the "api" route parameter constraint to accept `%` characters, which
+- [zfcampus/zf-apigility-documentation#59](https://github.com/zfcampus/zf-apigility-documentation/pull/59) fixes the "api" route parameter constraint to accept `%` characters, which
   are often present when multi-segment namespaces are used for a given API name.
 
 ## 1.2.3 - 2016-10-11
@@ -74,12 +74,12 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- [#49](https://github.com/zfcampus/zf-apigility-documentation/pull/49) fixes
+- [zfcampus/zf-apigility-documentation#49](https://github.com/zfcampus/zf-apigility-documentation/pull/49) fixes
   representation of nested collections.
-- [#50](https://github.com/zfcampus/zf-apigility-documentation/pull/50) fixes
+- [zfcampus/zf-apigility-documentation#50](https://github.com/zfcampus/zf-apigility-documentation/pull/50) fixes
   escaping of field decriptions; previously, the template was improperly using
   `escapeTransformDescription()` instead of `agTransformDescription()`.
-- [#52](https://github.com/zfcampus/zf-apigility-documentation/pull/52) fixes
+- [zfcampus/zf-apigility-documentation#52](https://github.com/zfcampus/zf-apigility-documentation/pull/52) fixes
   output of fields when the `allows_only_fields_in_filter` parameter is present
   for an input filter.
 
@@ -99,7 +99,7 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- [#53](https://github.com/zfcampus/zf-apigility-documentation/pull/53) fixes an
+- [zfcampus/zf-apigility-documentation#53](https://github.com/zfcampus/zf-apigility-documentation/pull/53) fixes an
 
 ## 1.2.2 - 2016-08-10
 
@@ -117,7 +117,7 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- [#53](https://github.com/zfcampus/zf-apigility-documentation/pull/53) fixes an
+- [zfcampus/zf-apigility-documentation#53](https://github.com/zfcampus/zf-apigility-documentation/pull/53) fixes an
   import statement in the configuration file.
 
 ## 1.2.1 - 2016-08-04
@@ -136,29 +136,29 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- [#48](https://github.com/zfcampus/zf-apigility-documentation/pull/48) updates
+- [zfcampus/zf-apigility-documentation#48](https://github.com/zfcampus/zf-apigility-documentation/pull/48) updates
   the `ControllerFactory` implementation to be forwards compatible with
-  zend-servicemanager v3.
+  laminas-servicemanager v3.
 
 ## 1.2.0 - 2016-07-14
 
 ### Added
 
-- [#43](https://github.com/zfcampus/zf-apigility-documentation/pull/43) adds
-  support for v3 releases of Zend Framework components, while retaining support
+- [zfcampus/zf-apigility-documentation#43](https://github.com/zfcampus/zf-apigility-documentation/pull/43) adds
+  support for v3 releases of Laminas components, while retaining support
   for v2 releases.
-- [#43](https://github.com/zfcampus/zf-apigility-documentation/pull/43) extracts
+- [zfcampus/zf-apigility-documentation#43](https://github.com/zfcampus/zf-apigility-documentation/pull/43) extracts
   the `ApiFactory` factory inlined in the `Module` class to a first-class
-  factory, `ZF\Apigility\Documentation\Factory\ApiFactoryFactory`.
-- [#19](https://github.com/zfcampus/zf-apigility-documentation/pull/19) adds
+  factory, `Laminas\ApiTools\Documentation\Factory\ApiFactoryFactory`.
+- [zfcampus/zf-apigility-documentation#19](https://github.com/zfcampus/zf-apigility-documentation/pull/19) adds
   support for displaying documentation of APIs with nested namespaces (e.g.,
   `Company\ApiName` vs just `ApiName`). Such services are now denoted with
   dot-notation: `Company.ApiName`.
-- [#35](https://github.com/zfcampus/zf-apigility-documentation/pull/35) adds
+- [zfcampus/zf-apigility-documentation#35](https://github.com/zfcampus/zf-apigility-documentation/pull/35) adds
   a new view helper, `agTransformDescription()`, which will transform markdown
   descriptions to HTML. This is now used by default in the supplied view
   scripts. **This means you can now use markdown in your API descriptions!**
-- [#38](https://github.com/zfcampus/zf-apigility-documentation/pull/38) updates
+- [zfcampus/zf-apigility-documentation#38](https://github.com/zfcampus/zf-apigility-documentation/pull/38) updates
   the `Field` class to allow setting the field type, and updates the operation
   view script to now display field types for given operations.
 
@@ -168,7 +168,7 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Removed
 
-- [#43](https://github.com/zfcampus/zf-apigility-documentation/pull/43) removes
+- [zfcampus/zf-apigility-documentation#43](https://github.com/zfcampus/zf-apigility-documentation/pull/43) removes
   support for PHP 5.5.
 
 ### Fixed
@@ -191,16 +191,16 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- [#39](https://github.com/zfcampus/zf-apigility-documentation/pull/39) updates
-  the component to properly display information about zend-inputfilter
+- [zfcampus/zf-apigility-documentation#39](https://github.com/zfcampus/zf-apigility-documentation/pull/39) updates
+  the component to properly display information about laminas-inputfilter
   Collections when displaying operation validation information.
-- [#40](https://github.com/zfcampus/zf-apigility-documentation/pull/40) updates
+- [zfcampus/zf-apigility-documentation#40](https://github.com/zfcampus/zf-apigility-documentation/pull/40) updates
   the Operations view script to:
   - display HTTP method-specific fields first, if present.
   - display general fields only if they exist (the fix prevents an empty row
     displaying).
   - insert a closing `</span>` tag within the table data cell containing the
     required flag.
-- [#41](https://github.com/zfcampus/zf-apigility-documentation/pull/41) updates
+- [zfcampus/zf-apigility-documentation#41](https://github.com/zfcampus/zf-apigility-documentation/pull/41) updates
   the `ApiFactory` to ensure that if an entity has no collection associated with
   it, documentation will not attempt to retrieve the fields.

COPYRIGHT.md

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

LICENSE.md

@@ -1,19 +1,19 @@
-Copyright (c) 2014-2018, Zend Technologies USA, Inc.
+Copyright (c) 2019, Laminas Foundation
 All rights reserved.
 
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
 - Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
 
-- Redistributions in binary form must reproduce the above copyright notice, this
-  list of conditions and the following disclaimer in the documentation and/or
-  other materials provided with the distribution.
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
 
-- Neither the name of Zend Technologies USA, Inc. nor the names of its
-  contributors may be used to endorse or promote products derived from this
-  software without specific prior written permission.
+- Neither the name of Laminas Foundation nor the names of its contributors may
+  be used to endorse or promote products derived from this software without
+  specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

README.md

@@ -1,11 +1,11 @@
-# ZF Apigility Documentation
+# Laminas API Tools Documentation
 
-[![Build Status](https://secure.travis-ci.org/zfcampus/zf-apigility-documentation.svg?branch=master)](https://secure.travis-ci.org/zfcampus/zf-apigility-documentation)
-[![Coverage Status](https://coveralls.io/repos/github/zfcampus/zf-apigility-documentation/badge.svg?branch=master)](https://coveralls.io/github/zfcampus/zf-apigility-documentation?branch=master)
+[![Build Status](https://travis-ci.org/laminas-api-tools/api-tools-documentation.svg?branch=master)](https://travis-ci.org/laminas-api-tools/api-tools-documentation)
+[![Coverage Status](https://coveralls.io/repos/github/laminas-api-tools/api-tools-documentation/badge.svg?branch=master)](https://coveralls.io/github/laminas-api-tools/api-tools-documentation?branch=master)
 
 ## Introduction
 
-This Zend Framework 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.
@@ -19,7 +19,7 @@ This Zend Framework module can be used with conjunction with Apigility in order
   - 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.
 
 ## Requirements
@@ -31,14 +31,14 @@ Please see the [composer.json](composer.json) file.
 Run the following `composer` command:
 
 ```console
-$ composer require zfcampus/zf-apigility-documentation
+$ composer require laminas-api-tools/api-tools-documentation
 ```
 
 Alternately, manually add the following to your `composer.json`, in the `require` section:
 
 ```javascript
 "require": {
-    "zfcampus/zf-apigility-documentation": "^1.2-dev"
+    "laminas-api-tools/api-tools-documentation": "^1.2-dev"
 }
 ```
 
@@ -52,16 +52,16 @@ return [
     /* ... */
     'modules' => [
         /* ... */
-        'ZF\Apigility\Documentation',
+        'Laminas\ApiTools\Documentation',
     ],
     /* ... */
 ];
 ```
 
-> ### zf-component-installer
+> ### laminas-component-installer
 >
-> If you use [zf-component-installer](https://github.com/zendframework/zf-component-installer),
-> that plugin will install zf-apigility-documentation as a module for you.
+> If you use [laminas-component-installer](https://github.com/laminas/laminas-component-installer),
+> that plugin will install api-tools-documentation as a module for you.
 
 ## Configuration
 
@@ -71,19 +71,19 @@ 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
-namespace ZF\Apigility\Documentation;
+namespace Laminas\ApiTools\Documentation;
 
-use Zend\ServiceManager\Factory\InvokableFactory;
-use Zend\View\Model\ViewModel;
+use Laminas\ServiceManager\Factory\InvokableFactory;
+use Laminas\View\Model\ViewModel;
 
 return [
     'router' => [
         'routes' => [
-            'zf-apigility' => [
+            'api-tools' => [
                 'child_routes' => [
                     'documentation' => [
                         'type' => 'segment',
@@ -112,7 +112,7 @@ return [
             Controller::class => ControllerFactory::class,
         ],
     ],
-    'zf-content-negotiation' => [
+    'api-tools-content-negotiation' => [
         'controllers' => [
             Controller::class => 'Documentation',
         ],
@@ -163,37 +163,37 @@ return [
 ];
 ```
 
-## ZF Events
+## Laminas Events
 
 This module has no events or listeners.
 
-## ZF 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.
-- `ZF\Apigility\Documentation\View\AgTransformDescription` (a.k.a `agTransformDescription`) for transforming the written 
+- `Laminas\ApiTools\Documentation\View\AgTransformDescription` (a.k.a `agTransformDescription`) for transforming the written 
   descriptions into Markdown.
 
 ### 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.