README

此 Composer 插件将处理与 Nooku 相关的包。以下包类型受支持

• joomla-extension
• nooku-component
• nooku-framework

Joomla 扩展

如果您将 Composer 包的类型设置为 joomla-extension，则此插件将尝试将其作为常规扩展安装到您的 Joomla 安装中。

为了使您的扩展可以通过 Composer 安装，请添加一个包含以下至少配置值的 composer.json 文件

{
    "name": "vendor/com_name",
    "type": "joomla-extension",
    "require": {
        "nooku/nooku-framework": "2.*"
    }
}

注意：对 nooku/nooku-framework 框架的要求也会安装此安装程序插件。如果您没有在 Nooku 框架 上构建您的包，您可以简单地要求此插件： "nooku/installer": "1.*"。

仓库布局

为了成功将您的扩展安装到 Joomla，您需要确保您的仓库布局类似于可安装的 Joomla 包。这意味着，如果您创建了一个包含仓库内容的存档，则可以使用 Joomla 扩展管理器安装该存档。

这意味着您需要在根目录添加一个有效的 XML 清单文件，并确保它指向正确的路径。对于示例，您始终可以参考我们的 todo 示例组件！

发布

您现在可以在 Packagist 上发布您的组件或将您的自己的仓库添加到您的 Joomla 的 composer.json 文件中。然后，您可以使用 composer install 命令安装您的组件。

Nooku 组件

使用 nooku-component 类型将可重用的 Nooku 组件安装到您的 Joomla 设置或 Nooku 平台 应用程序中。Composer 安装程序将您的代码放入 /vendor 目录。对于 Joomla 3.4 及以上版本，它将安装到 /libraries/vendor 文件夹。

您的包的 composer.json 文件应包含以下指令

{
    "name": "vendor/name-component",
    "type": "nooku-component",
    "license": "GPLv3",
    "require": {
        "nooku/installer": "1.*"
    },
    "autoload": {
        "files": ["autoload.php"]
    }
}

将此 composer.json 文件放在组件仓库的根目录。

以下设置是使您的组件可通过 Composer 安装所必需的

• 必须将 type 指令设置为 nooku-component。
• 您必须确保要求 nooku/installer 包，以便 Composer 知道如何处理您的包。
• 每个 Nooku 组件都应该包含一个 koowa-component.xml 清单文件。您可以从我们的 activities 组件 获取示例。
• 您必须包含 autoload 指令。然而，您不需要自己包含 autoload.php 文件。如果它在存储库中找不到，插件会自动为您生成。

您现在可以在 Packagist 上发布您的组件或将您的自己的仓库添加到您的 Joomla 的 composer.json 文件中。然后，您可以使用 composer install 命令安装您的组件。

Nooku 框架

此类型仅适用于 Nooku 框架。此类型将由 Composer 插件安装框架到您的 Joomla 设置并启用它。

要安装框架，在您的 Joomla 安装根目录中创建一个 composer.json 清单文件，并添加以下内容

{
    "require": {        
        "nooku/nooku-framework": "2.*"
    },
    "minimum-stability": "dev"
}

现在执行 composer install 来安装框架。

要求

• Composer
• Joomla 版本 2.5.0 及以上。

贡献

Nooku 安装程序是一个开源的、社区驱动的项目。欢迎来自所有人的贡献。我们有 贡献指南 帮助您开始。

贡献者

查看 贡献者列表。

许可证

nooku-installer 插件是免费的开源软件，根据 GPLv3 许可证 授予许可。

社区

跟踪开发和社区新闻。

• 关注 @joomlatoolsdev 在推特上
• 加入 joomlatools/dev 在 Gitter 上
• 阅读 Joomlatools 开发者博客
• 订阅 Joomlatools 开发者通讯