laminas-api-tools / api-tools-configuration
Laminas module providing a REST resource for manipulating configuration
Fund package maintenance!
Community Bridge
Installs: 123 817
Dependents: 4
Suggesters: 0
Security: 0
Stars: 2
Watchers: 10
Forks: 5
Open Issues: 6
Requires
- php: ^7.3 || ~8.0.0
- laminas/laminas-config: ^2.6 || ^3.0
- laminas/laminas-modulemanager: ^2.7.1
- laminas/laminas-stdlib: ^2.7.7 || ^3.0.1
- laminas/laminas-zendframework-bridge: ^1.0
Requires (Dev)
- container-interop/container-interop: ^1.1
- laminas/laminas-coding-standard: ~1.0.0
- phpunit/phpunit: ^9.3
- psalm/plugin-phpunit: ^0.13.0
- vimeo/psalm: ^4.2
Replaces
- zfcampus/zf-configuration: ^1.3.3
README
Introduction
api-tools-configuration is a module that provides configuration services that provide for the runtime management and modification of Laminas application configuration files.
Requirements
Please see the composer.json file.
Installation
Run the following composer
command:
$ composer require laminas-api-tools/api-tools-configuration
Alternately, manually add the following to your composer.json
, in the require
section:
"require": { "laminas-api-tools/api-tools-configuration": "^1.2" }
And then run composer update
to ensure the module is installed.
Finally, add the module name to your project's config/application.config.php
under the modules
key:
return [ /* ... */ 'modules' => [ /* ... */ 'Laminas\ApiTools\Configuration', ], /* ... */ ];
laminas-component-installer
If you use laminas-component-installer, that plugin will install api-tools-configuration as a module for you.
Configuration
User Configuration
The top-level configuration key for user configuration of this module is api-tools-configuration
.
'api-tools-configuration' => [ 'config_file' => 'config/autoload/development.php', 'enable_short_array' => false, 'class_name_scalars' => false, ],
Key: enable_short_array
Set this value to a boolean true
if you want to use PHP 5.4's square bracket (aka "short") array
syntax.
Key: class_name_scalars
- Since 1.2.1
Set this value to a boolean true
if you want to use PHP 5.5's class name scalars (::class
notation).
Laminas Events
There are no events or listeners.
Laminas Services
Laminas\ApiTools\Configuration\ConfigWriter
Laminas\ApiTools\Configuration\ConfigWriter
is by default an instance of Laminas\Config\Writer\PhpArray
. This
service serves the purpose of providing the necessary dependencies for ConfigResource
and
ConfigResourceFactory
.
Laminas\ApiTools\Configuration\ConfigResource
Laminas\ApiTools\Configuration\ConfigResource
service is used for modifying an existing configuration files with
methods such as patch()
and replace()
. The service returned by the service manager is bound to
the file specified in the config_file
key.
Laminas\ApiTools\Configuration\ConfigResourceFactory
Laminas\ApiTools\Configuration\ConfigResourceFactory
is a factory service that provides consumers with the
ability to create Laminas\ApiTools\Configuration\ConfigResource
objects, with dependencies injected for specific
config files (not the one listed in the module.config.php
.
Laminas\ApiTools\Configuration\ModuleUtils
Laminas\ApiTools\Configuration\ModuleUtils
is a service that consumes the ModuleManager
and provides the
ability to traverse modules to find their path on disk as well as the path to their configuration
files.