bobmulder/composer-ui

Composer tools and UI for Composer

composer-ui

ComposerUI for Composer, _(*1)

Note: This is just a try for composer, and should be considered as experimental., _(*2)

Strategy

Via this issue at Composer, we started with the idea to build a general UI for composer. However, the UI couldn't exist without a helper to create and execute commands., _(*3)

At the moment we are working on the helper. The goal is that the helper can be used in future without the UI. The UI will be the second part., _(*4)

Installation

You can install this package via... Yeah... Composer:, _(*5)

composer require bobmulder/composer-ui:dev-master

Usage

The following commands are supported for now: - composer - install - archive - update - require - remove, _(*6)

The ComposerHelper Class

You can start using composer by creating an instance of the ComposerUI/ComposerHelper-class:, _(*7)

$composer = new ComposerHelper();

You can configure the working path via:, _(*8)

$composer = new ComposerHelper('/custom/path');

Now you are ready to go!, _(*9)

Options

On every command you can use every option that is available at composer., _(*10)

Note: Read this to get a list of commands and options: https://getcomposer.org/doc/03-cli.md, _(*11)

Note: Need a specific command? Open up an issue or better a pull request!, _(*12)

Composer

Just initializes composer. Nothing special., _(*13)

$composer->composer();

Install

The install command reads the composer.json file from the current directory, resolves the dependencies, and installs them into vendor., _(*14)

$composer->install();

Archive

This command is used to generate a zip/tar archive for your entire project., _(*15)

$composer->archive();

Note: Composer itself supports to archive specific packages, but this library doesn't support that yet..., _(*16)

Update

In order to get the latest versions of the dependencies and to update the composer.lock file, you should use the update command., _(*17)

$composer->update();

Require

The require command adds new packages to the composer.json file from the current directory. If no file exists one will be created on the fly., _(*18)

$composer->requirePackages([
    'vendor/package' => '2.x',
    'vendor/secondpackage' => 'dev-master',
    'vendor/thirthpackage',
]);

Remove

The remove command removes packages from the composer.json file from the current directory., _(*19)

$composer->removePackages([ 'vendor/package' => '2.x', 'vendor/secondpackage' => 'dev-master', 'vendor/thirthpackage', ]);, _(*20)

Next

We would like to refer you to the composer docs itself: https://getcomposer.org/doc/03-cli.md, _(*21)

If you need help, don't fear to get in touch via gitter: https://gitter.im/bobmulder/composer-ui, _(*22)

[] (https://gitter.im/bobmulder/composer-ui?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge), _(*23)