zendframework/zend-component-installer

Name: zend-component-installer

Owner: Zend Framework

Description: Composer post-package-(un)install scripts for modules and components.

Created: 2015-12-17 15:18:15.0

Updated: 2018-05-23 14:43:53.0

Pushed: 2018-05-23 14:49:45.0

Homepage: https://docs.zendframework.com/zend-component-installer/

Size: 1887

Language: PHP

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Component Installer for Zend Framework 3 Applications

This repository contains the Composer plugin class Zend\ComponentInstaller\ComponentInstaller, which provides Composer event hooks for the events:

• post-package-install
• post-package-uninstall

Via Composer global install

To install the utility for use with all projects you use:

mposer global require zendframework/zend-component-installer

Per project installation

To install the utility for use with a specific project already managed by composer:

mposer require zendframework/zend-component-installer

Writing packages that utilize the installer

Packages can opt-in to the workflow from zend-component-installer by defining one or more of the following keys under the extra.zf configuration in their composer.json file:

ra": {
f": {
"component": "Component\\Namespace",
"config-provider": "Classname\\For\\ConfigProvider",
"module": "Module\\Namespace"

• A component is for use specifically with zend-mvc + zend-modulemanager; a Module class must be present in the namespace associated with it. The setting indicates a low-level component that should be injected to the top of the modules list of one of:

• config/application.config.php

• config/modules.config.php

• config/development.config.php

• A module is for use specifically with zend-mvc + zend-modulemanager; a Module class must be present in the namespace associated with it. The setting indicates a userland or third-party module that should be injected to the bottom of the modules list of one of:

• config/application.config.php

• config/modules.config.php

• config/development.config.php

• A config-provider is for use with applications that utilize expressive-config-manager or zend-config-aggregator (which may or may not be Expressive applications). The class listed must be an invokable that returns an array of configuration, and will be injected at the top of:

• config/config.php

Whitelisting packages to install automatically

At the project level, you can mark packages that expose configuration providers and modules that you want to automatically inject via the component-whitelist key:

ra": {
f": {
"component-whitelist": [
  "zendframework/zend-expressive",
  "zendframework/zend-expressive-helpers"
]

This configuration must be made at the root package level (the package consuming configuration providing packages).