redhataccess/composer-api

Pack of functions for interfacing with composer

2.0.0-alpha1 2022-05-23 21:58 UTC

Requires

• php: ^7.4 || ^8.0
• composer/composer: ^2.0

Requires (Dev)

• drupal/coder: ^8.3

Replaces

• bookin/composer-api: *

MIT

• Anton Mikhailov
• Alex McCabe

README

• Introduction
• Requirements
• Installation
• Configuration
• Usage
  • Example

INTRODUCTION

The Composer API package provides utilities for using Composer from PHP scripts.

REQUIREMENTS

This package has no requirements outside of Composer.

INSTALLATION

• Install as you would normally install a Composer package. Visit https://getcomposer.org/doc/00-intro.md for further information.

CONFIGURATION

The package has no configurable settings. Installing or uninstalling it should have no side effects.

USAGE

Initialization:

$composer = Composer::getInstance('path/to/root/composer.json', 'path/to/root');

Returns Composer\Composer object:

$composer::getComposer();

Returns array with PackageInterface objects (array with all installed packages, without bower, npm, etc from fxp/composer-asset-plugin):

$composer::getLocalPackages();

Find package by full name and version:

$composer::findPackage($name, $version);

Find package by string:

$composer::searchPackage($query);

Update package by name or all packages with console options:

$composer::updatePackage($name, $options);
$composer::updateAllPackages($options);

Delete package by name or all packages with console options:

$composer::deletePackage($name, $options);
$composer::deleteAllPackages($options);

Run any composer commands:

$composer::runCommand($command, $options);

Example

You can see the work of the component on the example of yii2 module - bookin/yii2-composer-gui