\Module_ComposerAPI

__construct()

__construct(  $path_to_composer_json) 

Parameters

get_path_to_composer_json()

get_path_to_composer_json() 

set_path_to_composer_json()

set_path_to_composer_json(  $value) 

Parameters

get_path_to_composer_home()

get_path_to_composer_home() : string|\unknown

Returns

set_path_to_composer_home()

set_path_to_composer_home(\unknown  $value) : \axenox\PackageManager\ComposerApi

Parameters

Returns

get_proxy_http()

get_proxy_http() : \unknown

Returns

set_proxy()

set_proxy(\unknown  $http_proxy = null, \unknown  $https_proxy = null) : \axenox\PackageManager\ComposerApi

Parameters

Returns

get_proxy_https()

get_proxy_https() : string

Returns

get_composer_application()

get_composer_application() : \Composer\Console\Application

Returns

install()

install(array  $options = null, \Symfony\Component\Console\Output\OutputInterface  $output = null) : \Symfony\Component\Console\Output\OutputInterface

Reads the composer.json file from the current directory, resolves the dependencies, and installs them: see https://getcomposer.org/doc/03-cli.md#install

Parameters

Returns

update()

update(array  $package_names = null, array  $options = null, \Symfony\Component\Console\Output\OutputInterface  $output = null) : \Symfony\Component\Console\Output\OutputInterface

Updates dependencies to the latest possible version and updates the composer.lock file: see https://getcomposer.org/doc/03-cli.md#update E.g.

$composer->update() will update all dependencies while $composer->update(array('symfony/css-crawler'), array('--optimize-autoloader')) will update only the CSS crawler symfony component optimizing the autoloader afterwards.

Parameters

Returns

requirePackage()

requirePackage(array  $package_names, array  $options = null, \Symfony\Component\Console\Output\OutputInterface  $output = null) : \Symfony\Component\Console\Output\OutputInterface

Installes one or more packages: see https://getcomposer.org/doc/03-cli.md#require.

E.g. $composer->require(array('monolog/monolog:~1.16', 'slim/slim')) will install monolog in version 1.16 or later and the Slim framework in the latest available version.

Parameters

Returns

remove()

remove(array  $package_names, array  $options = null, \Symfony\Component\Console\Output\OutputInterface  $output = null) : \Symfony\Component\Console\Output\OutputInterface

Uninstalles one or more packages: see https://getcomposer.org/doc/03-cli.md#remove.

E.g. $composer->remove(array('monolog/monolog', 'slim/slim')) will uninstall monolog in version 1.16 or later and the Slim framework in the latest available version.

Parameters

Returns

search()

search(array  $search_terms, array  $options = null, \Symfony\Component\Console\Output\OutputInterface  $output = null) : \Symfony\Component\Console\Output\OutputInterface

Search through the current project's package repositories: see https://getcomposer.org/doc/03-cli.md#search

Parameters

Returns

show()

show(array  $options = null, \Symfony\Component\Console\Output\OutputInterface  $output = null) : \Symfony\Component\Console\Output\OutputInterface

Lists all installed packages: see https://getcomposer.org/doc/03-cli.md#show.

E.g. $composer->show(array('--latest')) will show all packages with the respective latest version available

Parameters

Returns

outdated()

outdated(array  $options = null, \Symfony\Component\Console\Output\OutputInterface  $output = null) : \Symfony\Component\Console\Output\OutputInterface

Shows a list of installed packages that have updates available, including their current and latest versions: see https://getcomposer.org/doc/03-cli.md#outdated E.g.

$composer->outdated() will list only outdated packages while $composer->outdated(array('--all')) will list alle packages installed with the respective latest versions.

Parameters

Returns

suggests()

suggests(array  $package_names = null, array  $options = null, \Symfony\Component\Console\Output\OutputInterface  $output = null) : \Symfony\Component\Console\Output\OutputInterface

Lists all packages suggested by currently installed set of packages: see https://getcomposer.org/doc/03-cli.md#suggests.

E.g. $composer->suggests(array('monolog/monolog', 'slim/slim'), array('--by-package')) will show packages suggested by monolog and Slim grouped by package

Parameters

Returns

depends()

depends(string  $package_name,   $version = null, array  $options = null, \Symfony\Component\Console\Output\OutputInterface  $output = null) : \Symfony\Component\Console\Output\OutputInterface

Tells you which other packages depend on a certain package: see https://getcomposer.org/doc/03-cli.md#depends.

E.g. $composer->depends('doctrine/lexer', array('--tree')) will show packages, that require the doctrine lexer with all subrequirements in the form of a tree.

Parameters

Returns

prohibits()

prohibits(string  $package_name,   $version = null, array  $options = null, \Symfony\Component\Console\Output\OutputInterface  $output = null) : \Symfony\Component\Console\Output\OutputInterface

Tells you which packages are blocking a given package from being installed: see https://getcomposer.org/doc/03-cli.md#prohibits.

E.g. $composer->prohibits('symfony/symfony', '3.1', array('--tree')) will show packages in your current project, that would prevent the installation of Symfony 3.1 with all their subrequirements in the form of a tree.

Parameters

Returns

validate()

validate(array  $options = null, \Symfony\Component\Console\Output\OutputInterface  $output = null) : \Symfony\Component\Console\Output\OutputInterface

Validates the composer.json file: see https://getcomposer.org/doc/03-cli.md#validate

Parameters

Returns

config()

config(string  $setting_key, array  $setting_values, array  $options = null, \Symfony\Component\Console\Output\OutputInterface  $output = null) : \Symfony\Component\Console\Output\OutputInterface

Edits config settings and repositories in either the composer.json file: see https://getcomposer.org/doc/03-cli.md#config

Parameters

Throws

\InvalidArgumentException

Returns

register_proxy()

register_proxy() : \axenox\PackageManager\ComposerApi

Returns

get_default_output_container()

get_default_output_container() 

call_command()

call_command(  $command, array  $arguments = null, \Symfony\Component\Console\Output\OutputInterface  $output = null) 

Parameters

prepare_array_input_args()

prepare_array_input_args(array  $arguments = null) : array

Parameters

Returns