Модуль community.general.composer — менеджер зависимостей для PHP

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого модуля могут потребоваться дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.composer.

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры

Краткое описание

Composer — это инструмент управления зависимостями в PHP. Он позволяет указать библиотеки, от которых зависит ваш проект, и устанавливает их в проект.

Требования

На хосте, на котором выполняется этот модуль, необходимы перечисленные ниже компоненты.

php
composer, установленный в каталоге bin (рекомендуется /usr/local/bin) или указанный в composer_executable

Параметры

Параметр	Комментарии
apcu_autoloader boolean	Использует APCu для кэширования найденных и ненайденных классов. Варианты: `false` ← (по умолчанию) `true`
arguments string	Аргументы Composer, например обязательный пакет, версия и т. д. По умолчанию: `""`
classmap_authoritative boolean	Автозагрузка классов только из classmap. Неявно включает optimize_autoloader. Рекомендуется, особенно для production-среды, но выполнение может занять некоторое время. Варианты: `false` ← (по умолчанию) `true`
command string	Команда Composer, например `install`, `update` и т. д. По умолчанию: `"install"`
composer_executable path добавлен в community.general 3.2.0	Путь к исполняемому файлу composer на удалённом хосте, если composer отсутствует в `PATH` или требуется использовать пользовательскую версию composer.
executable псевдонимы: php_path path	Путь к исполняемому файлу PHP на удалённом хосте, если PHP отсутствует в `PATH`.
force boolean добавлен в community.general 12.6.0	Если `command` имеет значение `create-project`, модуль проверяет, существует ли `composer.json` в `working_dir`, и пропускает команду, если он существует, обеспечивая идемпотентность задачи. Установите значение `true`, чтобы всегда выполнять команду. Варианты: `false` ← (по умолчанию) `true`
global_command boolean	Выполняет указанную команду глобально. Варианты: `false` ← (по умолчанию) `true`
ignore_platform_reqs boolean	Игнорирует требования `php`, `hhvm`, `lib-` и `ext-` и принудительно выполняет установку, даже если локальная машина им не соответствует. Варианты: `false` ← (по умолчанию) `true`
no_dev boolean	Отключает установку пакетов require-dev (см. `--no-dev`). Варианты: `false` `true` ← (по умолчанию)
no_plugins boolean	Отключает все плагины (см. `--no-plugins`). Варианты: `false` ← (по умолчанию) `true`
no_scripts boolean	Пропускает выполнение всех скриптов, определённых в composer.json (см. `--no-scripts`). Варианты: `false` ← (по умолчанию) `true`
optimize_autoloader boolean	Оптимизирует автозагрузчик при создании дампа автозагрузчика (см. `--optimize-autoloader`). Преобразует автозагрузку PSR-0/4 в classmap для ускорения работы автозагрузчика. Рекомендуется, особенно для production-среды, но выполнение может занять некоторое время. Варианты: `false` `true` ← (по умолчанию)
prefer_dist boolean	Принудительно устанавливает пакет из dist, в том числе для dev-версий (см. `--prefer-dist`). Варианты: `false` ← (по умолчанию) `true`
prefer_source boolean	По возможности принудительно устанавливает пакет из исходного кода (см. `--prefer-source`). Варианты: `false` ← (по умолчанию) `true`
working_dir path	Каталог проекта (см. `--working-dir`). Этот параметр обязателен, если команда выполняется не глобально. Игнорируется, если задано `global_command=true`.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения статуса, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примечания

Примечание

Параметры по умолчанию, которые всегда добавляются при каждом выполнении: --no-ansi, --no-interaction и --no-progress, если они доступны.
Мы получали сообщения о проблемах в macOS, если composer был установлен с помощью Homebrew. Во избежание проблем используйте официальный способ установки.

Примеры

- name: Download and installs all libs and dependencies outlined in the /path/to/project/composer.lock
  community.general.composer:
    command: install
    working_dir: /path/to/project

- name: Install a new package
  community.general.composer:
    command: require
    arguments: my/package
    working_dir: /path/to/project

- name: Clone and install a project with all dependencies
  community.general.composer:
    command: create-project
    arguments: package/package /path/to/project ~1.0
    working_dir: /path/to/project
    prefer_dist: true

- name: Install a package globally
  community.general.composer:
    command: require
    global_command: true
    arguments: my/package

Авторы

Dimitrios Tydeas Mengidis (@dmtrs)
René Moser (@resmo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/composer_module.html