README

这是为PHP包作者准备的，可以在他们的composer.json中要求使用。它将根据指定的包类型神奇地将他们的包安装到正确的位置。

当前支持的包类型:

• CakePHP 2+ cakephp-
• CodeIgniter codeigniter-
• Drupal drupal-
• FuelPHP fuelphp-
• Joomla joomla-
• Kohana kohana-
• Laravel laravel-
• Lithium lithium-
• Magento magento-
• Mako mako-
• MediaWiki mediawiki-
• PHPCSStandard `phpcsstandard-
• phpBB phpbb-
• PPI ppi-
• SilverStripe silverstripe-
• Symfony1 symfony1-
• WordPress wordpress-
• Zend zend-

原生支持的框架:

以下框架与Composer原生兼容，并将安装到默认的vendor目录。composer/installers不是安装这些框架的包所必需的

• Aura
• Symfony2

示例composer.json文件

这是一个针对CakePHP插件的示例。在您的composer.json文件中需要设置的最重要的部分是"type": "cakephp-plugin"，它描述了您的包是什么，以及"require": { "composer/installers": "*" }，它告诉Composer加载自定义安装程序。

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

这将使用户在运行php composer.phar install时，将您的包安装到CakePHP应用的app/Plugin/Ftp/目录。

因此，请将您的包提交到packagist.org！

当前支持的类型

• CakePHP
  • cakephp-plugin
• CodeIgniter
  • codeigniter-library
  • codeigniter-third-party
  • codeigniter-module
• Drupal
  • drupal-module
  • drupal-theme
  • drupal-profile
  • drupal-drush
• FuelPHP
  • fuelphp-module
• Joomla
  • joomla-component
  • joomla-module
  • joomla-template
  • joomla-plugin
  • joomla-library
• Kohana
  • kohana-module
• Laravel
  • laravel-library
• Lithium
  • lithium-library
  • lithium-source
• Magento
  • magento-library
  • magento-skin
  • magento-theme
• Mako
  • mako-package
• MediaWiki
  • mediawiki-extension
• phpBB
  • phpbb-extension
  • phpbb-style
  • phpbb-language
• PPI
  • ppi-module
• SilverStripe
  • silverstripe-module
  • silverstripe-theme
• symfony1
  • symfony1-plugin
• WordPress
  • wordpress-plugin
  • wordpress-theme
• Zend
  • zend-library
  • zend-extra

加粗的类型已被标记为稳定，您可以信赖这些安装路径不会改变。如果对安装路径有任何调整请求，必须创建一个新的类型。

自定义安装路径

如果您正在使用composer/installers的包，您可以使用以下额外的设置在您的composer.json中覆盖安装路径

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

这将使用您自定义的路径为列出的每个包。您可以在路径中使用以下变量：${name}、{$vendor}、{$type}。

贡献力量！

• 分支和克隆.
• 运行命令php composer.phar install --dev安装开发依赖项。请参阅Composer。
• 使用命令phpunit运行测试。请参阅PHPUnit。
• 创建一个分支，提交，推送并给我们发送一个拉取请求。

为确保代码库的一致性，请确保代码遵循我们借鉴自Symfony的编码规范。

如果您想帮忙，请查看问题列表。