phpBB API Documentation
Interface

phpbb\composer\manager_interface

interface manager_interface

Class to manage packages through composer.

Methods

install(array $packages, IOInterface $io = null)

Installs (if necessary) a set of packages

update(array $packages, IOInterface $io = null)

Updates or installs a set of packages

remove(array $packages, IOInterface $io = null)

Removes a set of packages

bool is_managed(string $packages)

Tells whether or not a package is managed by Composer.

array get_managed_packages()

Returns the list of managed packages for the current type

array get_all_managed_packages()

Returns the list of managed packages for all phpBB types

array get_available_packages()

Returns the list of available packages

reset_cache()

Reset the cache

start_managing(string $package, IOInterface $io)

Start managing a manually installed package

bool check_requirements()

Checks the requirements of the manager and returns true if it can be used.

Details

at line 33
public install(array $packages, IOInterface $io = null)

Installs (if necessary) a set of packages

Parameters

array $packages Packages to install. Each entry may be a name or an array associating a version constraint to a name
IOInterface $io IO object used for the output

Exceptions

runtime_exception

at line 44
public update(array $packages, IOInterface $io = null)

Updates or installs a set of packages

Parameters

array $packages Packages to update. Each entry may be a name or an array associating a version constraint to a name
IOInterface $io IO object used for the output

Exceptions

runtime_exception

at line 55
public remove(array $packages, IOInterface $io = null)

Removes a set of packages

Parameters

array $packages Packages to remove. Each entry may be a name or an array associating a version constraint to a name
IOInterface $io IO object used for the output

Exceptions

runtime_exception

at line 64
public bool is_managed(string $packages)

Tells whether or not a package is managed by Composer.

Parameters

string $packages Package name

Return Value

bool

at line 71
public array get_managed_packages()

Returns the list of managed packages for the current type

Return Value

array The managed packages associated to their version.

at line 78
public array get_all_managed_packages()

Returns the list of managed packages for all phpBB types

Return Value

array The managed packages associated to their version.

at line 85
public array get_available_packages()

Returns the list of available packages

Return Value

array The name of the available packages, associated to their definition. Ordered by name.

at line 90
public reset_cache()

Reset the cache

at line 102
public start_managing(string $package, IOInterface $io)

Start managing a manually installed package

Remove a package installed manually and reinstall it using composer.

Parameters

string $package Package to manage
IOInterface $io IO object used for the output

Exceptions

runtime_exception

at line 109
public bool check_requirements()

Checks the requirements of the manager and returns true if it can be used.

Return Value

bool