README

实现了在管理包含任何版本文档的 Magento 2 的 Composer 项目时有用的常用功能。

特性

• 在运行 composer install 后自动创建数据库并安装 Magento 2

支持

• Magento 2.0
• Magento 2.1
• Magento 2.2
• Magento 2.3
• Magento 2.4（最高到 2.4.6-p5，与最新的 3.0 版本兼容）

使用方法

通过调用以下命令将 vaimo/magento-composer-plugin 添加到您的 Magento 2 项目中：

composer require vaimo/magento-composer-plugin

示例 composer.json

#!json

    {
        ...

        "require": {
            "magento/product-community-edition": "~2.0",
            "vaimo/magento-composer-plugin": "~2.1"
        }

        ...
    }
    

Magento 管理员用户登录凭证

• 用户名：admin
• 密码：test123

注意

插件将使用在 ~/.my.cnf 中找到的数据库凭证，因此我建议您除非您知道自己在做什么，否则不要使用插件安装生产站点。

使用的插件事件

• post-install-cmd：自动创建数据库并安装 Magento 2。

配置

可以通过使用环境变量和/或在 composer.json 中的 extra 部分设置值来配置插件。

环境变量

所有环境变量都应该是大写，以 MCP_ 为前缀，以 - 替换为 _。例如

MCP_DB_NAME=project_database
MCP_USE_REWRITES=0

composer.json - extra 部分

要在 Composer 项目中配置插件，请在 magento-composer-plugin 部分内部指定配置值。例如

#!json
    
    {
        "extra": {
            "magento-composer-plugin": {
                "db-name": "project_database"
                ...
            }
        }
    }
    

可用的配置

(值) = 默认值

一般配置

• 'install-magento' (true)。如果应该安装 Magento
• 'cleanup-database' (false)。在安装前清理数据库
• 'deploy-mode' (default)。安装后设置部署模式。可用模式是 'developer' 和 'production'

如果您想禁用交互，请使用 Composer 的 --no-interaction / COMPOSER_NO_INTERACTION。

安装器数据

• 'fqdn' (从 hostname --fqdn 获取)
• 'base-url'
• 'backend-frontname' (admin)
• 'session-save' (files)
• 'db-host' (localhost)
• 'db-name' (项目目录)
• 'db-user' (random)
• 'db-password' (random)
• 'db-model' (mysql4)
• 'db-engine' (innodb)
• 'db-prefix' ('')
• 'db-init-statements' (SET NAMES utf8;)
• 'admin-firstname' (Magento)
• 'admin-lastname' (User)
• 'admin-email' (user@example.com)
• 'admin-user' (admin)
• 'admin-password' (test123)
• 'language' => (en_US)
• 'currency' => (USD)
• 'timezone' => (America/Chicago)
• 'use-rewrites' => (true)

开发

测试命令

要手动测试包含的命令，最简单的方法是在项目中安装插件并使用 Composer 的 run-script 命令。要测试 post-install-cmd

composer run-script post-install-cmd

运行测试

make test