class manager implements manager_interface

Class to manage packages through composer.

Properties

protected installer $installer
protected driver_interface $cache
protected string $package_type
protected string $exception_prefix

Methods

__construct(installer $installer, driver_interface $cache, string $package_type, string $exception_prefix)

No description

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

Installs (if necessary) a set of packages

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

Hook called before installing the packages

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

Hook called after installing the packages

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

Updates or installs a set of packages

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

Hook called before updating the packages

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

Hook called after updating the packages

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

Removes a set of packages

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

Hook called before removing the packages

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

Hook called after removing the packages

bool
is_managed($package)

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.

array
normalize_version(array $packages)

Normalize a packages/version array. Every entry can have 3 different forms:

  • $package => $version
  • $indice => $package:$version
  • $indice => $package They are converted to he form:
  • $package => $version ($version is set to '*' for the third form)

Details

at line 66
__construct(installer $installer, driver_interface $cache, string $package_type, string $exception_prefix)

No description

Parameters

installer $installer

Installer object

driver_interface $cache

Cache object

string $package_type

Composer type of managed packages

string $exception_prefix

Exception prefix to use

at line 77
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 106
protected pre_install(array $packages, IOInterface $io = null)

Hook called before installing the 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

at line 117
protected post_install(array $packages, IOInterface $io = null)

Hook called after installing the 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

at line 124
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 151
protected pre_update(array $packages, IOInterface $io = null)

Hook called before updating the 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

at line 162
protected post_update(array $packages, IOInterface $io = null)

Hook called after updating the 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

at line 169
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 198
protected pre_remove(array $packages, IOInterface $io = null)

Hook called before removing the 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

at line 209
protected post_remove(array $packages, IOInterface $io = null)

Hook called after removing the 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

at line 216
bool is_managed($package)

Tells whether or not a package is managed by Composer.

Parameters

$package

Return Value

bool

at line 224
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 237
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 250
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 269
reset_cache()

Reset the cache

at line 281
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 289
bool check_requirements()

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

Return Value

bool

at line 306
protected array normalize_version(array $packages)

Normalize a packages/version array. Every entry can have 3 different forms:

  • $package => $version
  • $indice => $package:$version
  • $indice => $package They are converted to he form:
  • $package => $version ($version is set to '*' for the third form)

Parameters

array $packages

Return Value

array