README

此文档是为 PHP 软件包作者编写的，以便在他们的 composer.json 文件中引用。它将神奇地将他们的软件包安装到基于指定软件包类型的正确位置。

当前支持的软件包类型:

• AGL agl-
• CakePHP 2+ cakephp-
• CodeIgniter codeigniter-
• Drupal drupal-
• FuelPHP fuelphp-
• Joomla joomla-
• Kohana kohana-
• Laravel laravel-
• Lithium lithium-
• Magento magento-
• Mako mako-
• MediaWiki mediawiki-
• phpBB phpbb-
• PPI ppi-
• SilverStripe silverstripe-
• Symfony1 symfony1-
• TYPO3 Flow typo3-flow-
• 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！

当前支持的类型

• AGL
  • agl-module
• 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
• TYPO3 Flow
  • typo3-flow-package
  • typo3-flow-framework
  • typo3-flow-plugin
  • typo3-flow-site
  • typo3-flow-build
  • typo3-flow-yourlib（将安装到 Packages/Yourlib/）
• 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}。

自定义安装名称

如果您是包作者，并且需要在安装时使用不同的名称，请考虑使用 installer-name 额外设置。

例如，您有一个名为 shama/cakephp-ftp 的包，类型为 cakephp-plugin。使用 composer/installers 安装时，将安装到路径 Plugin/CakephpFtp。由于严格的命名约定，您作为包作者实际上需要包被命名为并安装到 Plugin/Ftp。在您的 package composer.json 中使用以下配置将允许这样做：

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

请注意，输入到 installer-name 的名称将是最终的，并且不会被变形。

贡献！

• 进行分支操作，克隆.
• 运行命令 php composer.phar install --dev 以安装开发依赖项。参见 Composer。
• 使用命令 phpunit 运行测试。参见 PHPUnit。
• 创建分支，提交，推送并给我们发送一个 pull request。

为确保代码库的一致性，您应确保代码遵循我们借鉴自 Symfony 的 编码标准。

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