README

此项目模板提供了使用 Composer 管理Mautic依赖项的入门套件。

用法

首先您需要 安装 composer 2。

注意：以下说明参考了 全局 composer 安装。根据您的配置，您可能需要将 composer 替换为 php composer.phar（或类似）。

之后您可以创建项目

composer create-project mautic/recommended-project:^5.0 some-dir --no-interaction

使用 composer require ... 您可以将新依赖项下载到您的安装中。

安装插件的示例

cd some-dir
composer require mautic/helloworld-bundle

composer create-project 命令将所有文件的拥有权传递给创建的项目。您应该创建一个新的 git 仓库，并提交所有由 .gitignore 文件排除的文件。

模板做了什么？

当安装给定的 composer.json 时，会处理一些任务

• Mautic 将安装在 docroot 目录中。
• 实现了自动加载器，使用 vendor/autoload.php 中的生成 composer 自动加载器，而不是 Mautic 提供的自动加载器（docroot/vendor/autoload.php）。
• 插件（类型为 mautic-plugin 的包）将放置在 docroot/plugins/
• 主题（类型为 mautic-theme 的包）将放置在 docroot/themes/
• 创建 docroot/media 目录。
• 根据您的 .env 文件创建环境变量。请参阅 .env.example。

Mautic 核心更新

此项目将尝试保持所有 Mautic 核心文件的最新状态；项目 mautic/core-composer-scaffold 用于确保每次 mautic/core 更新时，您的支架文件都会更新。如果您自定义了任何“支架”文件（通常是 .htaccess），在 Mautic 核心的新版本中更新您修改的文件时，您可能需要解决任何合并冲突。

按照以下步骤更新您的核心文件。

1. 运行 composer update mautic/core --with-dependencies 更新 Mautic 核心和其依赖项。
2. 运行 git diff 以确定是否有任何支架文件已更改。检查文件以确定更改，并将任何自定义修改恢复到 .htaccess 或其他文件。
3. 将所有内容作为一个单独的提交提交，这样在检出处或运行 git bisect 时，docroot 将与 core 保持同步。
4. 如果在第2步中出现非平凡的冲突，您可能希望在分支上执行以下步骤，并使用git merge将更新的核心文件与您的自定义文件合并。这有助于使用kdiff3之类的三路合并工具。如果您的更改很简单，则无需此设置；将所有修改保持在文件的开始或结尾是一个保持合并容易的好策略。

常见问题解答

我应该提交我下载的贡献插件吗？

Composer建议不要。他们提供反对的理由，但如果项目决定这样做，也提供了解决方案。

我应该提交脚手架文件吗？

Mautic Composer Scaffold插件可以将脚手架文件（如index.php、.htaccess等）下载到项目的docroot/目录。如果您没有自定义这些文件，可以选择不将它们检入您的版本控制系统（例如git）。如果您的项目是这样的，那么在每次安装或更新项目后自动运行mautic-scaffold插件可能很方便。您可以通过在composer.json中将@composer mautic:scaffold注册为post-install和post-update命令来实现。

"scripts": {
    "post-install-cmd": [
        "@composer mautic:scaffold",
        "..."
    ],
    "post-update-cmd": [
        "@composer mautic:scaffold",
        "..."
    ]
},

如何应用下载的插件的补丁？

如果您需要应用补丁（根据修改的项目，pull request通常是更好的解决方案），您可以使用composer-patches插件。

要将补丁添加到Mautic插件foobar，请将patches部分插入composer.json的extra部分

"extra": {
    "patches": {
        "mautic/foobar": {
            "Patch description": "URL or local path to patch"
        }
    }
}

如何指定PHP版本？

此项目支持PHP 7.4作为最低版本，但是，执行composer update可能会升级某些包，这将要求PHP 7+或8+。

为了防止这种情况，您可以在composer.json的config部分添加以下代码来指定您想要使用的PHP版本

"config": {
    "sort-packages": true,
    "platform": {
        "php": "7.4"
    }
},

如何使用除docroot之外的文件夹作为webroot？

默认情况下，composer.json文件配置为将所有Mautic核心、插件和主题文件放入docroot文件夹。
您可以将此文件夹更改为您自己的需求。

在以下示例中，我们将把docroot改为public。

新安装

• 运行不带安装的create-project命令

  composer create-project mautic/recommended-project:^4.0 some-dir --no-interaction --no-install

• 在composer.json文件中执行查找和替换，将docroot/改为public/。
• 检查composer.json文件中的更改，以确保没有意外的替换。
• 运行composer install以在正确位置安装所有依赖项。

现有安装

• 将docroot/移动到public/

  mv docroot public

• 在composer.json文件中执行查找和替换，将docroot/改为public/。
• 检查composer.json文件中的更改，以确保没有意外的替换。
• 运行composer update --lock以确保自动加载器了解已更改的文件夹。