README

This project template provides a starter kit for managing your Mautic dependencies with Composer.

Usage

Note: The instructions below refer to the global composer installation. You might need to replace composer with php composer.phar (or similar) for your setup.

After that you can create the project:

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

With composer require ... you can download new dependencies to your installation.

Example of installing a plugin:

cd some-dir
composer require mautic/helloworld-bundle

The composer create-project command passes ownership of all files to the project that is created. You should create a new git repository, and commit all files not excluded by the .gitignore file.

What does the template do?

When installing the given composer.json some tasks are taken care of:

Mautic will be installed in the docroot-directory.
Autoloader is implemented to use the generated composer autoloader in vendor/autoload.php, instead of the one provided by Mautic (docroot/vendor/autoload.php).
Plugins (packages of type mautic-plugin) will be placed in docroot/plugins/
Themes (packages of type mautic-theme) will be placed in docroot/themes/
Creates docroot/media-directory.
Creates environment variables based on your .env file. See .env.example.

Updating Mautic Core

This project will attempt to keep all of your Mautic Core files up-to-date; the project mautic/core-composer-scaffold is used to ensure that your scaffold files are updated every time mautic/core is updated. If you customize any of the "scaffolding" files (commonly .htaccess), you may need to merge conflicts if any of your modified files are updated in a new release of Mautic core.

Follow the steps below to update your core files.

Run composer update mautic/core --with-dependencies to update Mautic Core and its dependencies.
Run git diff to determine if any of the scaffolding files have changed. Review the files for any changes and restore any customizations to .htaccess or others.
Commit everything all together in a single commit, so docroot will remain in sync with the core when checking out branches or running git bisect.
In the event that there are non-trivial conflicts in step 2, you may wish to perform these steps on a branch, and use git merge to combine the updated core files with your customized files. This facilitates the use of a three-way merge tool such as kdiff3. This setup is not necessary if your changes are simple; keeping all of your modifications at the beginning or end of the file is a good strategy to keep merges easy.

FAQ

Should I commit the contributed plugins I download?

Composer recommends no. They provide argumentation against but also workrounds if a project decides to do it anyway.

Should I commit the scaffolding files?

The Mautic Composer Scaffold plugin can download the scaffold files (like index.php, .htaccess, …) to the docroot/ directory of your project. If you have not customized those files you could choose to not check them into your version control system (e.g. git). If that is the case for your project it might be convenient to automatically run the mautic-scaffold plugin after every install or update of your project. You can achieve that by registering @composer mautic:scaffold as post-install and post-update command in your composer.json:

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

How can I apply patches to downloaded plugins?

If you need to apply patches (depending on the project being modified, a pull request is often a better solution), you can do so with the composer-patches plugin.

To add a patch to Mautic plugin foobar insert the patches section in the extra section of composer.json:

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

How do I specify a PHP version ?

This project supports PHP 7.4 as minimum version, however it's possible that a composer update will upgrade some package that will then require PHP 7+ or 8+.

To prevent this you can add this code to specify the PHP version you want to use in the config section of composer.json:

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

How do I use another folder than docroot as webroot

By default the composer.json file is configures to put all Mautic core, plugin and theme files in the docroot folder.
It is possible to change this folder to your own needs.

In following examples, we will change docroot into public.

New installations

Run the create-project command without installing

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

Do a find and replace in the composer.json file to change docroot/ into public/.
Review the changes in the composer.json file to ensure there are no unintentional replacements.
Run composer install to install all dependencies in the correct location.

Existing installations

move the docroot/ to public/
```
mv docroot public
```
Do a find and replace in the composer.json file to change docroot/ into public/.
review the changes in the composer.json file to ensure there are no unintentional replacements.
run composer update --lock to ensure the autoloader is aware of the changed folder.

mautic / recommended-project

Maintainers

Details