textpattern / installer
Textpattern 插件和主题安装程序
Requires
- php: >=5.5.38
- composer-plugin-api: ^1.0 || ^2.0
- textpattern/lock: >=4.4.1
Requires (Dev)
- composer/composer: ^1.6 || ^2.0
- squizlabs/php_codesniffer: ^3.6.2
This package is auto-updated.
Last update: 2024-09-19 18:27:10 UTC
README
使用 Composer 依赖管理器将插件和主题安装到 Textpattern CMS。
$ composer require rah/rah_replace
为什么选择 Composer?
通常安装 Textpattern 插件需要手动下载安装包,通过管理面板上传包,然后进行多步安装程序过程;每次需要更新时都重复此过程。
使用 Composer,所有操作都通过依赖管理器完成。任何主题或插件都可以使用单个命令进行安装、更新或卸载。这还带来了 Composer 的其他好处,例如可以在版本控制系统下提交您的包声明,所有项目团队成员都将同步相同的插件集,无需额外操作。
用户快速入门
在 Textpattern 安装的托管系统上安装 Composer 后,您可以从命令行开始将插件添加到 Textpattern。
首先,前往您的 Textpattern 安装位置,通过安装 textpattern/lock 元包来告诉 Composer 您的 Textpattern 安装版本
$ cd /path/to/your/textpattern/installation/root
$ composer require textpattern/lock:4.6.2
之后,您可以将任何插件和主题添加到您的 Textpattern 安装中,就像其他 Composer 包一样
$ composer require rah/rah_replace rah/rah_flat
始终在 Textpattern 安装目录或其直接上级目录中运行 Composer 命令;Composer 安装程序支持将 Textpattern 安装到子目录中,这将允许 Textpattern 在公共 HTTP 服务器根目录内,而 Composer 包可以位于其上方目录。
开发者快速入门
插件和主题就像任何其他正常 Composer 包一样,但在 composer.json 中有特殊 type 和匹配的安装程序要求。包应使用插件或主题命名。一个示例 composer.json
草稿如下所示
{ "name": "vendor/pfx_pluginname", "type": "textpattern-plugin", "require": { "textpattern/installer" : "*" } }
包类型
内部
安装程序通过扫描 composer.json
文件的同级和子目录来查找 Textpattern 安装。如果找到,它会将整个 Textpattern 应用程序注入到当前运行的 Composer 进程中。然后,它会从 Composer 包中收集任何插件和主题并安装它们,根据需要调用插件生命周期更新器和安装程序。此过程可以与任何插件或主题兼容并使用。
安装程序不需要最终用户或开发者进行任何额外配置。它只需要一个功能齐全的 Textpattern 安装,位于与 composer.json
文件相同的目录或子目录中。只需注意,运行 Composer 命令的系统需要有权访问数据库;如果您在虚拟容器外运行 composer 命令,请考虑这一点。
要求
- Composer 1.x, 2.x
- Textpattern CMS 4.4.1, 4.5.7, 4.6.x, 4.7.x, 4.8.x
- PHP >= 5.5.38
- PDO
开发
请参阅 CONTRIBUTING.md