README

此 Composer 插件将安装扩展到您的 Joomla 安装中。

使用方法

定义一个包

开始使用最简单的方法是在您的 composer.json 文件中定义一个自定义包。您只需要安装您想要安装的扩展的包文件。（例如，您从供应商网站上下载的安装文件）

通过添加以下属性来更新您的 Joomla 安装根目录中的 composer.json 文件

{
    	"repositories": [
        	{
            	"type": "package",
            	"package": {
                	"name": "vendor/extension",
                	"type": "joomlatools-extension",
                	"version": "1.0.0",
                	"dist": {
                    	"url": "file:////Users/johndoe/Downloads/com_extension.1.0.0.tar.gz",
                    	"type": "tar"
                	},
                	"require": {
                    	"joomlatools/composer": "*"
                	}
            	}
        	}
    	],

        ...

    	"require": {
	        ...
    		"vendor/extension": "1.0.0"
    	}
}

使用此 JSON 文件，我们已经定义了自己的自定义包。请注意以下设置

• type 必须设置为 joomlatools-extension
• 确保 url 指令指向安装包的位置。

执行 composer install 将现在获取 joomlatools/composer 插件并使用它将包安装到您的 Joomla 安装中。

有关为不支持 Composer 的项目创建这些自定义包的更多信息，请参阅 Composer 文档。

创建自定义包

要使用 Composer 的所有功能，例如升级到较新版本，您最好创建一个使用您扩展的源代码的包。

包定义应包含以下基本信息，以便可以将其安装到 Joomla 中

{
    	"name": "vendor/my-extension",
		"type": "joomlatools-extension",
    	"require": {
        	"joomlatools/composer": "*"
    	}
}

如果您想从 Github 或其他版本控制系统直接提供您的扩展，请确保您的存储库中的文件布局与您的安装包相似。

如果您想在运行安装之前将主要的 Joomla 安装器清单移动到存储库根目录，请在您的 composer.json 文件中提供以下信息

{
	"extra": {
    	"manifest": "path/to/manifest/joomlatools.xml"
	}
}

如果您为 Joomlatools 框架的可重用组件创建包，请在您的 composer.json 文件中提供以下信息

{
	"extra": {
    	"joomlatools-component": "component-name"
	}
}

您现在可以在 Packagist 上发布您的扩展，或使用您自己的 Satis 存储库 提供它。

有关创建自定义包的更多信息，请参阅 Composer 文档。

更多信息

有关更多信息、常见问题解答和示例，请参阅我们的 开发者文档。

开发

有关如何为此存储库设置本地开发环境的说明，请参阅 wiki。

调试

遇到问题？您可以增加 Composer 的详细设置（-v|vv|vvv）以收集更多信息。增加 Composer 的详细设置也将启用 Joomla 的日志消息。

要求

• Composer
• Joomla 版本 3.6+

贡献

joomlatools/composer 插件是一个开源的、社区驱动的项目。我们欢迎每个人提供贡献。我们有一份 贡献指南，以帮助您开始。

贡献者

请参阅 贡献者 列表。

许可

joomlatools/composer 插件是免费且开源的软件，许可协议为 GPLv3 许可协议。

社区

关注开发动态和社区新闻。

• 关注 @joomlatoolsdev 在 Twitter 上的动态
• 加入 joomlatools/dev 在 Gitter 上的讨论
• 阅读 Joomlatools 开发者博客
• 订阅 Joomlatools 开发者通讯