nickveenhof / mautic-project
Mautic 3 项目的 composer 项目模板
Requires
- php: >=7.3 <7.5
- composer/installers: ^1.9
- cweagans/composer-patches: ^1.6.5
- mautic/core: ^3.3
- nickveenhof/mautic-core-composer-scaffold: ^0.1
- nickveenhof/mautic-finder: ^0.1
- vlucas/phpdotenv: ^4.0
- webmozart/path-util: ^2.3
- wikimedia/composer-merge-plugin: ^1.4
This package is auto-updated.
Last update: 2024-09-09 18:49:00 UTC
README
此项目模板提供了一套启动工具,用于使用 Composer 管理您的网站依赖。
用法
首先您需要 安装 composer。
注意:以下说明针对 全局 composer 安装。根据您的配置,您可能需要将
composer
替换为php composer.phar
(或类似)。
之后您就可以创建项目
composer create-project nickveenhof/mautic-project:3.x-dev some-dir --no-interaction
使用 composer require ...
您可以将新的依赖项下载到您的安装中。
cd some-dir
composer require mautic/mautic-saelos-bundle:~2.0
composer create-project
命令将所有文件的所有权转移给创建的项目。您应该创建一个新的 git 仓库,并将所有未被 .gitignore 文件排除的文件提交。
模板做了什么?
在安装给定的 composer.json
时,会处理一些任务
- Mautic 将安装在
public
目录下。 - 实现了自动加载器,以使用
vendor/autoload.php
中的生成的 composer 自动加载器,而不是 Mautic 提供的自动加载器(public/vendor/autoload.php
)。 - 模块(类型为
mautic-plugin
的包)将放置在public/plugins/
。 - 主题(类型为
mautic-theme
的包)将放置在public/themes/
。 - 创建了默认可写的
settings.php
和services.yml
版本。 - 创建了
public/media
目录。 - 基于您的 .env 文件创建了环境变量。请参阅 .env.example。
更新 Mautic 核心
该项目将尝试保持所有 Mautic 核心文件的最新状态;使用 nickveenhof/mautic-core-composer-scaffold 项目确保每次 mautic/core 更新时,您的框架文件都会更新。如果您自定义了任何“框架”文件(通常是 .htaccess),那么在 Mautic 核心新版本中更新了您的修改文件时,您可能需要解决合并冲突。
按照以下步骤更新您的核心文件。
- 运行
composer update mautic/core --with-dependencies
更新 Mautic 核心和其依赖项。 - 运行
git diff
确定是否有任何框架文件已更改。检查文件以查看任何更改,并将任何自定义修改恢复到.htaccess
或robots.txt
。 - 将所有内容合并到单个提交中,这样在检出分支或运行
git bisect
时,public
将与core
保持同步。 - 如果在第 2 步中存在非平凡的冲突,您可能需要在分支上执行这些步骤,并使用
git merge
将更新的核心文件与您的自定义文件合并。这有助于使用 如 kdiff3 的三向合并工具。如果您的更改简单,则不需要此设置;将所有修改保留在文件的开始或结尾处是保持合并简单的好策略。
常见问题解答
我应该提交下载的 contrib 模块吗?
Composer建议不要这么做。他们提供了反对的理由,以及如果项目决定这么做时的解决方案。
我应该提交脚手架文件吗?
Mautic Composer Scaffold插件可以将脚手架文件(如index.php、update.php等)下载到项目的public/目录。如果您没有自定义这些文件,可以选择不将它们提交到您的版本控制系统(例如git)。如果您的项目符合这种情况,那么在项目安装或更新后自动运行mautic-scaffold插件可能很方便。您可以通过在composer.json中注册@composer mautic:scaffold
作为安装后和更新后的命令来实现这一点。
"scripts": { "post-install-cmd": [ "@composer mautic:scaffold", "..." ], "post-update-cmd": [ "@composer mautic:scaffold", "..." ] },
我如何应用下载的模块的补丁?
如果您需要应用补丁(根据修改的项目,pull request通常是一个更好的解决方案),您可以使用composer-patches插件。
要将补丁添加到名为foobar的mautic模块中,请将patches部分插入composer.json的extra部分。
"extra": { "patches": { "mautic/foobar": { "Patch description": "URL or local path to patch" } } }
我如何指定PHP版本?
本项目支持PHP 7.2.21作为最低版本,然而,执行composer update
可能会升级某些包,从而导致需要PHP 7+。
为了防止这种情况,您可以在composer.json的config
部分添加以下代码来指定您想要使用的PHP版本。
"config": { "sort-packages": true, "platform": { "php": "7.2.21" } },