All notable changes to this project will be documented in this file, in reverse chronological order by release.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- #393 adds the documentation key "identifier" to the
DocumentationModeland allowed documentation keys; the key is used in conjunction with the API Blueprint "identifier" and Swagger "operationId" fields.
- #398 changes how paths are globbed to use
realpath()when providing a path toglob(), fixing an issue when used on IBM i platforms.
- Nothing.
- Nothing.
- Nothing.
- #396 adds support for zend-hydrator v3 releases, and maintains compatibility with v1 and v2.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- #373 adds a new optional argument to
ModuleModel::createModule(),int $version = 1. This option allows a newly created module to start at a version greater than 1 if desired.
- #392 updates all dependency constraints to pin to versions that support PHP 7.2 where possible.
- Nothing.
- #392 removes support for HHVM.
- Nothing.
- #383 adds official support for PHP 7.1 and 7.2 by ensuring we test against both versions during continuous integration. Tests passed with no additional code changes.
- Nothing.
- Nothing.
- Nothing.
-
#382 updates the signatures of each of the following listed filters to be compatible with
Zend\InputFilter\BaseInputFilter::isValid()across all compatible versions of zend-inputfilter, eliminating an error when using zend-inputfilter 2.8+:AuthorizationInputFilterDocumentationInputFilterInputFilterInputFilter
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- #381 updates the
signature of
PostInputFilter::isValid()to be compatible withZend\InputFilter\BaseInputFilter::isValid()across all compatible versions of zend-inputfilter, eliminating an error when using zend-inputfilter 2.8+.
- Nothing.
- Nothing.
- Nothing.
- Nothing.
- #378 modifies the package requirements to exclude zf-configuration v1.3.1, as that version has a backwards-incompatible change that prevents creation of services via the admin.
- Nothing.
- Nothing.
- Nothing.
- #370 provides a fix
to the
RpcServiceModel::fetchAll()method that allows it to work with PSR-4 structured modules.
- Nothing.
- Nothing.
- Nothing.
- #369 updates the
migration script's
public/index.phpchanges such that the stub generated now will vary the script location forzf-development-modebased on whether or not a Windows operating system is detected.
- #363 adds an entry
for
Zend\Validator\Uuidto the validator metadata. - #368 updates the
bin/apigility-upgrade-to-1.5script to also inject a stub into thepublic/index.phpthat will interceptphp public/index.php development [enable|disable]commands, and proxy them to the v3 zf-development-mode tooling.
- Nothing.
- Nothing.
- #365 updates the
logic in the
DbAutodiscoveryModelto catch and report exceptions due to metadata discovery issues (typically invalid character sets) that were previously returning an empty list, providing better diagnostic details to end-users.
- Nothing.
- Nothing.
- Nothing.
- #362 adds an entry
to remove
ZF\Apigility\Providerfrom the module list in theapigility-update-to-1.5script. The package does not need to be listed as a module, as Composer will autoload all interfaces it defines.
- Nothing.
- Nothing.
- Nothing.
- #361 updates the
ModuleModelto vary the contents of a generatedmodule.config.phpbased on the short-array notation configuration setting. - This release updates the following dependencies to the listed minimum
supported versions:
- zfcampus/zf-apigility-admin-ui: 1.3.7
- zfcampus/zf-configuration: 1.2.1
- #358 adds
documentation for the
zf-apigility-admin.path_specconfiguration value to both the README and the module configuration file.
- Nothing.
- Nothing.
- #360 fixes how the
ModuleModelgenerates configuration, allowing it to generate short array syntax. The behavior is configurable using thezf-configuration.enable_short_arrayconfiguration value.
- Nothing.
- Nothing.
- Nothing.
- #357 fixes an issue with detection of module versions when using Apigility-generated PSR-4 modules.
- Nothing.
- Nothing.
- Nothing.
- #356 fixes a fatal
error when calling the versioning API, due to providing the
VersioningControllerwith an incorrect versioning model factory. - #356 fixes issues
when versioning API modules that are in PSR-4 layout. The
ModuleModelnow autodiscovers which layout (PSR-0 or PSR-4) is used by a given module.
- Nothing.
- Nothing.
- Nothing.
- #354 updates the
upgrade script to add dependencies required by Apigility 1.3 and earlier
skeletons. These changes include:
- adding zendframework/zend-mvc-i18n as a dependency
- adding the
Zend\I18nandZend\Mvc\I18nmodules toconfig/modules.config.php
- #353 adds the
apigility-versionAPI, to allow reporting to the UI the current Apigility skeleton version. It returns the value ofApigility\VERSIONif defined, and@devif not.
- Nothing.
- Nothing.
- Nothing.
-
#348 updates the component to be forwards compatible with Zend Framework component v3 releases, while retaining support for v2 releases. This includes supporting both v2 and v3 versions of factory invocation, and triggering event listeners using syntax that works on both v2 and v3 releases of zend-eventmanager, amonst other changes.
-
#348 adds a script to assist users in updating existing Apigility applications to use Zend Framework component v3 releases:
$ ./vendor/bin/apigility-upgrade-to-1.5 -h
In most cases, you can call it without arguments. Running the script updates your
composer.jsonto remove several entries, update others, and add some; it then updates your list of modules, and then installs dependencies for you.If you need to update manually for any reason, you will need to follow the steps in the README.
-
#321 adds a
patchList()stub to the REST resource class template, so that it's present by default. -
#327 adds support for working with modules that are in PSR-4 directory format. While the admin still does not create PSR-4 modules, it will now correctly interact with those that you manually convert to PSR-4.
-
#348 extracts listeners previously defined in the
Moduleclass into their own classes. These include:ZF\Apigility\Admin\DisableHttpCacheListener, which listens on theMvcEvent::EVENT_FINISHevent at high priority in order to return cache busting headers in the returned response.ZF\Apigility\Admin\EnableHalRenderCollectionsListener, which listens on theMvcEvent::EVENT_ROUTEevent at low priority in order to set the "render collections" flag on zf-hal'sHalplugin if a controller from the module is matched.ZF\Apigility\Admin\InjectModuleResourceLinksListener, which listens on theMvcEvent::EVENT_RENDERevent at high priority in order to attach listeners to events on the zf-halHalplugin. These listeners were also previously defined in theModuleclass, and are now part of this new listener, as it aggregates some state used by each.ZF\Apigility\Admin\NormalizeMatchedControllerServiceNameListener, which listens on theMvcEvent::EVENT_ROUTEat low priority in order to normalize the controller service name provided via the URI to a FQCN.ZF\Apigility\Admin\NormalizeMatchedInputFilterNameListener, which listens on theMvcEvent::EVENT_ROUTEat low priority in order to normalize the input filter name provided via the URI to a FQCN.
-
#348 extracts service factories previously defined in the
Moduleclass into their own classes. These include:ZF\Apigility\Admin\Model\AuthenticationModelFactoryZF\Apigility\Admin\Model\AuthorizationModelFactoryZF\Apigility\Admin\Model\ContentNegotiationModelFactoryZF\Apigility\Admin\Model\ContentNegotiationResourceFactoryZF\Apigility\Admin\Model\DbAdapterModelFactoryZF\Apigility\Admin\Model\DbAdapterResourceFactoryZF\Apigility\Admin\Model\DbAutodiscoveryModelFactoryZF\Apigility\Admin\Model\DoctrineAdapterModelFactoryZF\Apigility\Admin\Model\DoctrineAdapterResourceFactoryZF\Apigility\Admin\Model\DocumentationModelFactoryZF\Apigility\Admin\Model\FiltersModelFactoryZF\Apigility\Admin\Model\InputFilterModelFactoryZF\Apigility\Admin\Model\ModuleModelFactoryZF\Apigility\Admin\Model\ModulePathSpecFactoryZF\Apigility\Admin\Model\ModuleResourceFactoryZF\Apigility\Admin\Model\ModuleVersioningModelFactoryZF\Apigility\Admin\Model\ModuleVersioningModelFactoryFactoryZF\Apigility\Admin\Model\RestServiceModelFactoryZF\Apigility\Admin\Model\RestServiceModelFactoryFactoryZF\Apigility\Admin\Model\RestServiceResourceFactoryZF\Apigility\Admin\Model\RpcServiceModelFactoryFactoryZF\Apigility\Admin\Model\RpcServiceResourceFactoryZF\Apigility\Admin\Model\ValidatorMetadataModelFactoryZF\Apigility\Admin\Model\ValidatorsModelFactoryZF\Apigility\Admin\Model\VersioningModelFactoryZF\Apigility\Admin\Model\VersioningModelFactoryFactory
-
#348 extracts controller factories previously defined in the
Moduleclass into their own classes, and updates several factories that already existed. Factories that existed were updated to follow both the zend-servicemanager v2 and v3 signatures, to allow compatibility with both versions; as such, if you were extending these previously, you may potentially experience breakage due to signatures. The new classes include:ZF\Apigility\Admin\Controller\AuthenticationControllerFactoryZF\Apigility\Admin\Controller\AuthenticationTypeControllerFactoryZF\Apigility\Admin\Controller\AuthorizationControllerFactoryZF\Apigility\Admin\Controller\ConfigControllerFactoryZF\Apigility\Admin\Controller\DashboardControllerFactoryZF\Apigility\Admin\Controller\DbAutodiscoveryControllerFactoryZF\Apigility\Admin\Controller\DocumentationControllerFactoryZF\Apigility\Admin\Controller\FiltersControllerFactoryZF\Apigility\Admin\Controller\HydratorsControllerFactoryZF\Apigility\Admin\Controller\InputFilterControllerFactoryZF\Apigility\Admin\Controller\ModuleConfigControllerFactoryZF\Apigility\Admin\Controller\ModuleCreationControllerFactoryZF\Apigility\Admin\Controller\SourceControllerFactoryZF\Apigility\Admin\Controller\StrategyControllerFactoryZF\Apigility\Admin\Controller\ValidatorsControllerFactoryZF\Apigility\Admin\Controller\VersioningControllerFactory
-
#348 exposes the module to zend-component-installer.
- Nothing.
- #348 removes support for PHP 5.5.
- #348 removes the
dependency on rwoverdijk/assetmanager, allowing usage of any tool that
understands the same configuration (and, specifically, the
asset_manager.resolver_configs.pathsconfiguration directive). However, this means that for those upgrading via simplecomposer update, you will also need to executecomposer require rwoverdijk/assetmanagerimmediately for your application to continue to work.
- #348 updates
ZF\Apigility\Admin\Controller\StrategyControllerto accept aContainerInterfaceto its constructor, instead of relying on auto-injection of a zend-servicemanager instance via an initializer; this change removes deprecation notices from its usage ofgetServiceLocator()(it no longer calls that method), and documents the dependency explicitly. If you were extending this class previously, you may need to update your factory. - #348 updates
ZF\Apigility\Admin\Model\DoctrineAdapterResource's contructor to make the second argument,$loadedModules, optional. If you were extending the class previously, you may need to update your signature.
- Nothing.
- Nothing.
- Nothing.
- #350 updates the
Moduleclass to pull entities composed inZF\Hal\Entityinstances via thegetEntity()method of that class, if it exists (introduced in zf-hal 1.4). This change prevents zf-hal 1.4+ versions from emitting deprecation notices, and thus breaking usage of the admin API.
- Nothing.
- Nothing.
- Nothing.
- #344 removes the
ServiceLocatorAwareInterface, and updates factories for autodiscovery classes to inject their service locator instead. This change removes deprecation notices when using Apigility with the zend-mvc 2.7+ series.
- #329 improved install instructions
- Nothing.
- Nothing.
- #320 typo fixes on array_fill() usage
- #317 updates the component to use zend-hydrator for hydrator functionality; this provides forward compatibility with zend-hydrator, and backwards compatibility with hydrators from older versions of zend-stdlib.
- Nothing.
- Nothing.
- Nothing.
- #311 updates the API to allow using custom authentication adapters (vs only OAuth2 or HTTP).
- #314 provides a
simple fix to the
DbAutodiscoveryModelwhich allows using database views for DB-connected services.
- Nothing.
- Nothing.