composer / installers by Seldaek

A multi-framework Composer library installer
15,418,775
1,027
48
Package Data
Maintainer Username: Seldaek
Maintainer Contact: kyle@dontkry.com (Kyle Robinson Young)
Package Create Date: 2012-06-18
Package Last Update: 2018-12-09
Home Page: http://composer.github.com/installers
Language: PHP
License: MIT
Last Refreshed: 2018-12-11 12:39:34
Package Statistics
Total Downloads: 15,418,775
Monthly Downloads: 580,039
Daily Downloads: 24,742
Total Stars: 1,027
Total Watchers: 48
Total Forks: 364
Total Open Issues: 35

A Multi-Framework Composer Library Installer

Build Status

This is for PHP package authors to require in their composer.json. It will install their package to the correct location based on the specified package type.

The goal of Installers is to be a simple package type to install path map. Users can also customize the install path per package and package authors can modify the package name upon installing.

Installers isn't intended on replacing all custom installers. If your package requires special installation handling then by all means, create a custom installer to handle it.

Natively Supported Frameworks:

The following frameworks natively work with Composer and will be installed to the default vendor directory. composer/installers is not needed to install packages with these frameworks:

  • Aura
  • Symfony2
  • Yii
  • Yii2

Current Supported Package Types

Stable types are marked as bold, this means that installation paths for those type will not be changed. Any adjustment for those types would require creation of brand new type that will cover required changes.

| Framework | Types | --------- | ----- | Aimeos | aimeos-extension | Asgard | asgard-module
asgard-theme | Attogram | attogram-module | AGL | agl-module | Bonefish | bonefish-package | AnnotateCms | annotatecms-module
annotatecms-component
annotatecms-service | Bitrix | bitrix-module (deprecated)
bitrix-component (deprecated)
bitrix-theme (deprecated)

bitrix-d7-module
bitrix-d7-component
bitrix-d7-template | CakePHP 2+ | cakephp-plugin | Chef | chef-cookbook
chef-role | CiviCrm | civicrm-ext | CCFramework | ccframework-ship
ccframework-theme | Cockpit | cockpit-module | CodeIgniter | codeigniter-library
codeigniter-third-party
codeigniter-module | concrete5 | concrete5-core
concrete5-package
concrete5-theme
concrete5-block
concrete5-update | Craft | craft-plugin | Croogo | croogo-plugin
croogo-theme | Decibel | decibel-app | Dframe | dframe-module | DokuWiki | dokuwiki-plugin
dokuwiki-template | Dolibarr | dolibarr-module | Drupal | drupal-core
drupal-module
drupal-theme

drupal-library
drupal-profile
drupal-drush
drupal-custom-theme
drupal-custom-module | Elgg | elgg-plugin | Eliasis | eliasis-component
eliasis-module
eliasis-plugin
eliasis-template | ExpressionEngine 3 | ee3-addon
ee3-theme | eZ Platform | ezplatform-assets
ezplatform-meta-assets | FuelPHP v1.x | fuel-module
fuel-package
fuel-theme | FuelPHP v2.x | fuelphp-component | Grav | grav-plugin
grav-theme | Hurad | hurad-plugin
hurad-theme | ImageCMS | imagecms-template
imagecms-module
imagecms-library | iTop | itop-extension | Joomla | joomla-component
joomla-module
joomla-template
joomla-plugin
joomla-library | Kanboard | kanboard-plugin | Kirby | kirby-plugin
kirby-field
kirby-tag | KodiCMS | kodicms-plugin
kodicms-media | Kohana | kohana-module | Lan Management System | lms-plugin
lms-template
lms-document-template
lms-userpanel-module | Laravel | laravel-library | Lavalite | lavalite-theme
lavalite-package | Lithium | lithium-library
lithium-source
| Magento | magento-library
magento-skin
magento-theme | majima | majima-plugin | Mako | mako-package | Mautic | mautic-plugin
mautic-theme | Maya | maya-module | MODX | modx-extra | MODX Evo | modxevo-snippet
modxevo-plugin
modxevo-module
modxevo-template
modxevo-lib | MediaWiki | mediawiki-extension | October | october-module
october-plugin
october-theme
| OntoWiki | ontowiki-extension
ontowiki-theme
ontowiki-translation | OXID | oxid-module
oxid-theme
oxid-out | Osclass | osclass-plugin
osclass-theme
osclass-language | MODULEWork | modulework-module | Moodle | moodle-* (Please check source for all supported types) | Piwik | piwik-plugin | phpBB | phpbb-extension
phpbb-style
phpbb-language | Pimcore | pimcore-plugin(deprecated, only used for versions <= 4) | Plentymarkets | plentymarkets-plugin | PPI | ppi-module | Puppet | puppet-module | Porto | porto-container | RadPHP | radphp-bundle | REDAXO | redaxo-addon | ReIndex | reindex-plugin
reindex-theme | Roundcube | roundcube-plugin | shopware | shopware-backend-plugin
shopware-core-plugin
shopware-frontend-plugin
shopware-theme
shopware-plugin
shopware-frontend-theme | SilverStripe | silverstripe-module
silverstripe-theme | SiteDirect | sitedirect-module
sitedirect-plugin | SMF | smf-module
smf-theme | SyDES | sydes-module
sydes-theme | symfony1 | symfony1-plugin | Tusk | tusk-task
tusk-command
tusk-asset | TYPO3 Flow | typo3-flow-package
typo3-flow-framework
typo3-flow-plugin
typo3-flow-site
typo3-flow-boilerplate
typo3-flow-build | TYPO3 CMS | typo3-cms-extension (Deprecated in this package, use the TYPO3 CMS Installers instead) | UserFrosting | userfrosting-sprinkle | Vanilla | vanilla-plugin
vanilla-theme | Vgmcp | vgmcp-bundle
vgmcp-theme | WHMCS | whmcs-addons
whmcs-fraud
whmcs-gateways
whmcs-notifications
whmcs-registrars
whmcs-reports
whmcs-security
whmcs-servers
whmcs-social
whmcs-support
whmcs-templates
whmcs-includes | Wolf CMS | wolfcms-plugin | WordPress | wordpress-plugin
wordpress-theme

wordpress-muplugin
wordpress-dropin | YAWIK | yawik-module | Zend | zend-library
zend-extra
zend-module | Zikula | zikula-module
zikula-theme | Prestashop | prestashop-module
prestashop-theme | Phifty | phifty-bundle
phifty-framework
phifty-library

Example composer.json File

This is an example for a CakePHP plugin. The only important parts to set in your composer.json file are "type": "cakephp-plugin" which describes what your package is and "require": { "composer/installers": "~1.0" } which tells composer to load the custom installers.

{
    "name": "you/ftp",
    "type": "cakephp-plugin",
    "require": {
        "composer/installers": "~1.0"
    }
}

This would install your package to the Plugin/Ftp/ folder of a CakePHP app when a user runs php composer.phar install.

So submit your packages to packagist.org!

Custom Install Paths

If you are consuming a package that uses the composer/installers you can override the install path with the following extra in your composer.json:

{
    "extra": {
        "installer-paths": {
            "your/custom/path/{$name}/": ["shama/ftp", "vendor/package"]
        }
    }
}

A package type can have a custom installation path with a type: prefix.

{
    "extra": {
        "installer-paths": {
            "your/custom/path/{$name}/": ["type:wordpress-plugin"]
        }
    }
}

You can also have the same vendor packages with a custom installation path by using the vendor: prefix.

{
    "extra": {
        "installer-paths": {
            "your/custom/path/{$name}/": ["vendor:my_organization"]
        }
    }
}

These would use your custom path for each of the listed packages. The available variables to use in your paths are: {$name}, {$vendor}, {$type}.

Custom Install Names

If you're a package author and need your package to be named differently when installed consider using the installer-name extra.

For example you have a package named shama/cakephp-ftp with the type cakephp-plugin. Installing with composer/installers would install to the path Plugin/CakephpFtp. Due to the strict naming conventions, you as a package author actually need the package to be named and installed to Plugin/Ftp. Using the following config within your package composer.json will allow this:

{
    "name": "shama/cakephp-ftp",
    "type": "cakephp-plugin",
    "extra": {
        "installer-name": "Ftp"
    }
}

Please note the name entered into installer-name will be the final and will not be inflected.

Disabling installers

There may be time when you want to disable one or more installers from composer/installers. For example, if you are managing a package or project that uses a framework specific installer that conflicts with composer/installers but also have a dependency on a package that depends on composer/installers.

Installers can be disabled for your project by specifying the extra installer-disable property. If set to true, "all", or "*" all installers will be disabled.

{
    "extra": {
        "installer-disable": true
    }
}

Otherwise a single installer or an array of installers may be specified.

{
    "extra": {
        "installer-disable": [
            "cakephp",
            "drupal"
        ]
    }
}

Note: Using a global disable value (true, "all", or "*") will take precedence over individual installer names if used in an array. The example below will disable all installers.

{
    "extra": {
        "installer-disable": [
          "drupal",
          "all"
        ]
    }
}

Should we allow dynamic package types or paths? No.

What are they? The ability for a package author to determine where a package will be installed either through setting the path directly in their composer.json or through a dynamic package type: "type": "framework-install-here".

It has been proposed many times. Even implemented once early on and then removed. Installers won't do this because it would allow a single package author to wipe out entire folders without the user's consent. That user would then come here to yell at us.

Anyone still wanting this capability should consider requiring https://github.com/oomphinc/composer-installers-extender.