Правильная конфигурация платформы в Composer

Расширенные примеры использования platform config

Пример 1: Точная настройка для продакшена с проверкой совместимости

Допустим, целевой сервер работает с PHP 8.1.6, установлены расширения mbstring и pdo. В localhost используется PHP 8.2.3. Чтобы избежать установки пакетов, требующих PHP 8.2, добавляем в composer.json:

{
    "config": {
        "platform": {
            "php": "8.1.6",
            "ext-mbstring": "*",
            "ext-pdo": "*"
        }
    }
}

Выполним установку:

composer install

Чтобы проверить, какую платформу использует Composer, выполним:

composer show -p

Результат (фрагмент):

platform packages:
  composer/semver                             3.3.2
  php                                         8.1.6 (настроено)
  ext-mbstring                                * (настроено)
  ext-pdo                                     * (настроено)

Видно, что Composer показывает настроенные версии, а не реальные.

Пример 2: Использование platform в CI (GitHub Actions)

В сценарии Continuous Integration часто требуется проверять совместимость с разными версиями PHP. Можно задать platform динамически через переменную окружения.

Пример файла .github/workflows/ci.yml:

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        php: [7.4, 8.0, 8.1]
    steps:
      - uses: actions/checkout@v3
      - uses: shivammathur/setup-php@v2
        with:
          php-version: ${{ matrix.php }}
      - name: Install dependencies with platform constraint
        run: |
          composer install --no-interaction --platform=php:${{ matrix.php }}
      - name: Run tests
        run: vendor/bin/phpunit

Здесь каждая версия PHP запускает установку с соответствующим platform. Результат: Composer не будет устанавливать пакеты, несовместимые с указанной версией, даже если в composer.json есть platform для другой версии.

Пример 3: Разные platform для разработки и продакшна через файлы конфигурации

Создадим два файла конфигурации: composer.local.json для локальной разработки и composer.prod.json для развертывания.

Содержимое composer.local.json:

{
    "config": {
        "platform": {
            "php": "8.2.0",
            "ext-xdebug": "*"
        }
    }
}

Содержимое composer.prod.json:

{
    "config": {
        "platform": {
            "php": "8.1.6"
        }
    }
}

При установке на локальной машине используем:

composer install --no-dev --config=composer.local.json

Или просто переименовываем файл перед выполнением. Для авторизации продакшна можно передать путь к конфигу через переменную COMPOSER.

Пример 4: Имитация отсутствующего расширения для установки пакета

Предположим, пакет vendor/package-a требует ext-imagick, которого нет локально. Мы хотим установить пакет для статического анализа, но не планируем запускать код, использующий Imagick.

Добавляем в composer.json:

{
    "config": {
        "platform": {
            "ext-imagick": "*"
        }
    }
}

Затем:

composer update vendor/package-a --no-dev

После установки проверяем:

composer show -p

Результат:

platform packages:
  php                                         8.3.3 (реальная версия)
  ext-imagick                                 * (настроено)

Composer считает, что ext-imagick доступен, и установка прошла успешно. Важно помнить, что реальный запуск кода вызовет фатальную ошибку, если расширение не установлено.

Пример 5: Установка с игнорированием части платформы

Флаг --ignore-platform-req позволяет проигнорировать только одно конкретное требование.

composer install --ignore-platform-req=ext-swoole

Это пропустит проверку наличия ext-swoole, но остальные требования (php, ext-json и т.д.) останутся активными. Полезно, когда одно расширение будет доустановлено позже.

Пример 6: Использование platform в библиотеке (composer.json для пакета)

Если вы разработчик библиотеки, можете указать минимальную версию PHP в секции require, но platform не влияет на установку вашего пакета у потребителя. Однако в процессе тестирования вашей библиотеки можно настроить platform в корневом composer.json тестового проекта.

{
    "require": {
        "php": "^8.0"
    },
    "config": {
        "platform": {
            "php": "8.0.0"
        }
    }
}

При запуске composer update будут применяться ограничения, как будто используется PHP 8.0.0, что позволяет проверить обратную совместимость.