Composer/en

Composer is a dependency manager for PHP libraries. In addition, it can be used to manage the installation of MediaWiki extensions (available since MediaWiki 1.22 ). Starting with MediaWiki 1.25 , MediaWiki core's external library dependencies are being managed with Composer.

Installing Composer

There are multiple ways to install Composer:

To grab the latest snapshot:

wget https://getcomposer.org/composer.phar

That downloads a snapshot of the current master and will expire in 30 days. There are also phars for the alpha "releases" such as 1.0.0-alpha.

For users on OS X, you can use Homebrew to install composer:

brew install composer

If that doesn't work, or you do not have Homebrew installed, you can try:

php -r "readfile('https://getcomposer.org/installer');" | php

Jenkins and the extension distributor use the copy of composer contained in the "integration/composer" git repo.

Once composer is installed, you can run commands via the downloaded phar:

php composer.phar someCommand

You may want to move the phar into your path so it can be used as a normal executable:

mv composer.phar /usr/local/bin/composer
composer someCommand

If the mv command fails due to permissions, execute it again with sudo.

Usage in MediaWiki core

MediaWiki 1.25+ depends on some external libraries which are managed with Composer. Composer creates an autoloader at vendor/autoload.php, which is included by WebStart.php.

Composer managed dependencies are bundled into tarball distributions of MediaWiki and extensions so system administrators do not need to use composer directly. When installing MediaWiki using Git, dependencies declared in $IP/composer.json can either be installed locally by running composer update or the mediawiki/vendor.git repository can be cloned to provide the same libraries used on the Wikimedia production cluster.

Using composer-merge-plugin

MediaWiki core "owns" $IP/composer.json and will change the contents of that file in both tarball and Git managed updates. In order to allow local installs to use Composer to load optional libraries and/or manage extensions with Composer, a special plugin for Composer named composer-merge-plugin was developed. This plugin and the MediaWiki core composer.json configuration allow a local deployment to add required extensions and libraries to a file composer.local.json inside the root MediaWiki directory.

composer.local.json can also be used to install Composer managed libraries that are needed by extensions that are not installed using Composer themselves. This is only needed when the extensions are not installed from tarballs generated by Extension Distributor.

To enable Composer to discover and process the composer.json files that may be included in any and all of your locally installed extensions, add something like this to $IP/composer.local.json:

{
    "extra": {
        "merge-plugin": {
            "include": [
                "extensions/*/composer.json",
                "skins/*/composer.json"
            ]
        }
    }
}

Resources

• How to install extensions through Composer
  • Extension:Extension Installer - must be used for MediaWiki ≤ 1.21.x to install extensions with Composer
  • List of extensions that can or must be installed with Composer
  • Category:Extensions supporting Composer
• How to add external libraries to MediaWiki core or extensions
• Best practices when creating a composer.json
• Information about adding packages to packagist.org

References

[[Category:MediaWiki developmentTemplate:Translation]] [[Category:ComposerTemplate:Translation]]