Composer

https://getcomposer.org/doc/
Admin
Composer is a dependency manager for PHP that allows developers to declare and manage project...
Tokens:106,209
Snippets:995
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Get help for a Composer command

Source: https://getcomposer.org/doc/03-cli.md

Displays help information for the Composer 'install' command.

```bash
php composer.phar help install
```

--------------------------------

### target-dir configuration example

Source: https://getcomposer.org/doc/04-schema.md

Sets the installation target for legacy PSR-0 autoloading. The example shows how to configure autoload and target-dir for a Symfony component so the autoloader can find it.

```json
{
    "autoload": {
        "psr-0": { "Symfony\\Component\\Yaml\\": "" }
    },
    "target-dir": "Symfony/Component/Yaml"
}
```

--------------------------------

### Run installer checks

Source: https://getcomposer.org/doc/articles/troubleshooting.md

Run the installer's checks via curl to ensure your setup has no problems.

```bash
curl -sS https://getcomposer.org/installer | php -- --check
```

--------------------------------

### Example composer.json for a template package using custom installer

Source: https://getcomposer.org/doc/articles/custom-installers.md

Defines a package with type 'phpdocumentor-template' and requires the installer plugin to ensure it is present during installation.

```json
{
    "name": "phpdocumentor/template-responsive",
    "type": "phpdocumentor-template",
    "require": {
        "phpdocumentor/template-installer-plugin": "*"
    }
}
```

--------------------------------

### suggest key example

Source: https://getcomposer.org/doc/04-schema.md

JSON example for the 'suggest' key, mapping package names to free-text descriptions. Values are informational and not version constraints.

```json
{
    "suggest": {
        "monolog/monolog": "Allows more advanced logging of the application flow",
        "ext-xml": "Needed to support XML format in class Foo"
    }
}
```

--------------------------------

### PSR-4 multiple directories example

Source: https://getcomposer.org/doc/04-schema.md

JSON example showing how to specify multiple directories for the same namespace prefix using an array.

```json
{
    "autoload": {
        "psr-4": { "Monolog\\": ["src/", "lib/"] }
    }
}
```

--------------------------------

### Install Composer locally with --install-dir and --filename

Source: https://getcomposer.org/doc/00-intro.md

Runs the Composer installer to place composer.phar in the bin directory and rename it to composer. Use this for a local installation within your project directory.

```bash
php composer-setup.php --install-dir=bin --filename=composer
```

--------------------------------

### depends command with example output

Source: https://getcomposer.org/doc/03-cli.md

Shows the command to list packages that depend on a given package, followed by its example output.

```bash
php composer.phar depends doctrine/lexer
```

```text
doctrine/annotations  1.13.3 requires doctrine/lexer (1.*)
doctrine/common       2.13.3 requires doctrine/lexer (^1.0)
```

--------------------------------

### Project requiring a package with vendor binaries

Source: https://getcomposer.org/doc/articles/vendor-binaries.md

Example composer.json for project my-vendor/project-b that requires my-vendor/project-a. Running composer install will install project-a's binaries to vendor/bin, making vendor/my-vendor/project-a/bin/project-a-bin available as vendor/bin/project-a-bin.

```json
{
    "name": "my-vendor/project-b",
    "require": {
        "my-vendor/project-a": "*"
    }
}
```

--------------------------------

### notify-batch field example

Source: https://getcomposer.org/doc/05-repositories.md

Specifies a URL to be called when a user installs a package. The URL can be absolute or fully qualified.

```json
{
    "notify-batch": "/downloads/"
}
```

--------------------------------

### PSR-4 fallback directory example

Source: https://getcomposer.org/doc/04-schema.md

JSON example using an empty prefix to define a fallback directory where any namespace will be looked for.

```json
{
    "autoload": {
        "psr-4": { "": "src/" }
    }
}
```

--------------------------------

### repo command examples

Source: https://getcomposer.org/doc/03-cli.md

Example invocations of the repo command. The add subcommand accepts either a URL or a JSON repository definition. The --before and --after options insert the new repository relative to an existing repository name.

```bash
php composer.phar repo list
php composer.phar repo add foo vcs https://github.com/acme/foo
php composer.phar repo add bar composer https://repo.packagist.com/bar
php composer.phar repo add zips '{"type":"artifact","url":"/path/to/dir/with/zips"}'
php composer.phar repo add baz vcs https://example.org --before foo
php composer.phar repo add qux vcs https://example.org --after bar
php composer.phar repo remove foo
php composer.phar repo set-url foo https://git.example.org/acme/foo
php composer.phar repo get-url foo
php composer.phar repo disable packagist.org
php composer.phar repo enable packagist.org
```

--------------------------------

### Require vendor/autoload.php and use a library

Source: https://getcomposer.org/doc/01-basic-usage.md

Include the Composer-generated autoloader and use a library class without extra setup. The example creates a Monolog logger and writes a warning to app.log.

```php
require __DIR__ . '/vendor/autoload.php';

$log = new Monolog\Logger('name');
$log->pushHandler(new Monolog\Handler\StreamHandler('app.log', Monolog\Logger::WARNING));
$log->warning('Foo');
```

--------------------------------

### depends command with --tree flag and example output

Source: https://getcomposer.org/doc/03-cli.md

Shows the command to display a recursive tree of why a package is depended upon, followed by its example output.

```bash
php composer.phar depends psr/log -t
```

```text
psr/log 1.1.4 Common interface for logging libraries
├──composer/composer 2.4.x-dev (requires psr/log ^1.0 || ^2.0 || ^3.0)
├──composer/composer dev-main (requires psr/log ^1.0 || ^2.0 || ^3.0)
├──composer/xdebug-handler 3.0.3 (requires psr/log ^1 || ^2 || ^3)
│  ├──composer/composer 2.4.x-dev (requires composer/xdebug-handler ^2.0.2 || ^3.0.3)
│  └──composer/composer dev-main (requires composer/xdebug-handler ^2.0.2 || ^3.0.3)
└──symfony/console v5.4.11 (conflicts psr/log >=3) (circular dependency aborted here)
```

--------------------------------

### PSR-4 autoload mapping example

Source: https://getcomposer.org/doc/04-schema.md

JSON example for the 'autoload' key with a 'psr-4' mapping from namespaces to paths. Namespace prefixes must end in '\\' to avoid conflicts.

```json
{
    "autoload": {
        "psr-4": {
            "Monolog\\": "src/",
            "Vendor\\Namespace\\": ""
        }
    }
}
```

--------------------------------

### Install Composer with checksum verification

Source: https://getcomposer.org/doc/faqs/how-to-install-composer-programmatically.md

A UNIX shell script that downloads the Composer installer, verifies its SHA384 checksum against the signature from composer.github.io, and runs the installer. Exits with 1 on checksum failure or 0 on success; quiet unless an error occurs.

```shell
#!/bin/sh

EXPECTED_CHECKSUM="$(php -r 'copy("https://composer.github.io/installer.sig", "php://stdout");')"
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
ACTUAL_CHECKSUM="$(php -r "echo hash_file('sha384', 'composer-setup.php');")"

if [ "$EXPECTED_CHECKSUM" != "$ACTUAL_CHECKSUM" ]
then
    >&2 echo 'ERROR: Invalid installer checksum'
    rm composer-setup.php
    exit 1
fi

php composer-setup.php --quiet
RESULT=$?
rm composer-setup.php
exit $RESULT
```

--------------------------------

### Install Composer from GitHub history with wget

Source: https://getcomposer.org/doc/faqs/how-to-install-composer-programmatically.md

Downloads a specific version of the Composer installer from GitHub history and pipes it directly to PHP. Replace the commit hash with the latest commit on the getcomposer.org repository for an exact copy.

```shell
wget https://raw.githubusercontent.com/composer/getcomposer.org/f3108f64b4e1c1ce6eb462b159956461592b3e3e/web/installer -O - -q | php -- --quiet
```

--------------------------------

### policy add-source examples

Source: https://getcomposer.org/doc/03-cli.md

Example invocations of the policy add-source command. The first uses the url source-type, the second uses a JSON source definition. Both add a source for the 'my-list' policy.

```bash
php composer.phar policy add-source my-list url https://example.org/list.json
php composer.phar policy add-source my-list '{"type":"url","url":"https://example.org/list.json"}'
```

--------------------------------

### Verify Composer installation on Windows

Source: https://getcomposer.org/doc/00-intro.md

Checks the installed Composer version from a new terminal after installation. The PATH is only loaded when the terminal starts, so close your current terminal and open a new one.

```batch
C:\Users\username>composer -V
```

```text
Composer version 2.4.0 2022-08-16 16:10:48
```

--------------------------------

### Satis configuration with require-all

Source: https://getcomposer.org/doc/articles/handling-private-packages.md

Example Satis configuration that includes all packages from the listed VCS repositories using the "require-all": true setting.

```json
{
    "name": "my/repository",
    "homepage": "http://packages.example.org",
    "repositories": [
        { "type": "vcs", "url": "https://github.com/mycompany/privaterepo" },
        { "type": "vcs", "url": "http://svn.example.org/private/repo" },
        { "type": "vcs", "url": "https://github.com/mycompany/privaterepo2" }
    ],
    "require-all": true
}
```

--------------------------------

### Run composer init

Source: https://getcomposer.org/doc/03-cli.md

Run the init command to interactively create a composer.json file with smart defaults.

```bash
php composer.phar init
```

--------------------------------

### \Composer\InstalledVersions::getInstallPath

Source: https://getcomposer.org/doc/07-runtime.md

Static method to get the absolute install path of a package.

```APIDOC
## \Composer\InstalledVersions::getInstallPath

### Description
Returns the absolute install path of a package. Returns null if the package is provided/replaced or is a metapackage, and throws OutOfBoundsException if the package is not installed at all. Available as of Composer 2.1 (composer-runtime-api ^2.1).

### Method
Static method

### Signature
\Composer\InstalledVersions::getInstallPath(string $packageName): ?string

### Parameters
- **packageName** (string) - Required - The package name (e.g. 'vendor/package').

### Return Value
- **?string** - The absolute path to the package installation location if installed, null if provided/replaced or metapackage, or throws OutOfBoundsException if not installed.

### Example
\Composer\InstalledVersions::getInstallPath('vendor/package');
```

--------------------------------

### Create a project with composer create-project

Source: https://getcomposer.org/doc/03-cli.md

Creates a new project from the composer/hello-world package in the my-project directory. The directory is created if it does not exist, and the latest version is used unless a version is provided as a third argument.

```bash
php composer.phar create-project composer/hello-world my-project
```

--------------------------------

### \Composer\InstalledVersions::getVersion

Source: https://getcomposer.org/doc/07-runtime.md

Static method to get the normalized version of an installed package.

```APIDOC
## \Composer\InstalledVersions::getVersion

### Description
Returns the normalized version of a package if it is installed. Returns null if the package is provided or replaced by another package, and throws OutOfBoundsException if the package is not installed at all.

### Method
Static method

### Signature
\Composer\InstalledVersions::getVersion(string $packageName): ?string

### Parameters
- **packageName** (string) - Required - The package name (e.g. 'vendor/package').

### Return Value
- **?string** - The normalized version (e.g. 1.2.3.0) if installed, null if provided/replaced, or throws OutOfBoundsException if not installed.

### Example
\Composer\InstalledVersions::getVersion('vendor/package');
```

--------------------------------

### Get pretty version with InstalledVersions::getPrettyVersion

Source: https://getcomposer.org/doc/07-runtime.md

Returns the original version (e.g. v1.2.3) of an installed package. Returns null if the package is provided or replaced, and throws OutOfBoundsException if not installed at all.

```php
// returns the original version (e.g. v1.2.3) if vendor/package is installed,
// or null if it is provided/replaced,
// or throws OutOfBoundsException if the package is not installed at all
\Composer\InstalledVersions::getPrettyVersion('vendor/package');
```

--------------------------------

### Directory structure example

Source: https://getcomposer.org/doc/05-repositories.md

Shows the directory structure of a monolithic repository with apps and packages.

```text
...
├── apps
│   └── my-app
│       └── composer.json
├── packages
│   └── my-package
│       └── composer.json
...
```

--------------------------------

### Get normalized version with InstalledVersions::getVersion

Source: https://getcomposer.org/doc/07-runtime.md

Returns the normalized version (e.g. 1.2.3.0) of an installed package. Returns null if the package is provided or replaced, and throws OutOfBoundsException if not installed at all.

```php
// returns a normalized version (e.g. 1.2.3.0) if vendor/package is installed,
// or null if it is provided/replaced,
// or throws OutOfBoundsException if the package is not installed at all
\Composer\InstalledVersions::getVersion('vendor/package');
```

--------------------------------

### Add a repository with config repositories.foo

Source: https://getcomposer.org/doc/03-cli.md

Adds or modifies a repository in the repositories section. The repository is prepended (highest priority) by default; use --append to add it with lowest priority.

```bash
php composer.phar config repositories.foo vcs https://github.com/foo/bar
```

--------------------------------

### \Composer\InstalledVersions::getReference

Source: https://getcomposer.org/doc/07-runtime.md

Static method to get the source or dist reference of an installed package.

```APIDOC
## \Composer\InstalledVersions::getReference

### Description
Returns the package dist or source reference (e.g. a git commit hash) if the package is installed. Returns null if the package is provided or replaced by another package, and throws OutOfBoundsException if the package is not installed at all.

### Method
Static method

### Signature
\Composer\InstalledVersions::getReference(string $packageName): ?string

### Parameters
- **packageName** (string) - Required - The package name (e.g. 'vendor/package').

### Return Value
- **?string** - The reference (e.g. a git commit hash) if installed, null if provided/replaced, or throws OutOfBoundsException if not installed.

### Example
\Composer\InstalledVersions::getReference('vendor/package');
```

--------------------------------

### \Composer\InstalledVersions::getPrettyVersion

Source: https://getcomposer.org/doc/07-runtime.md

Static method to get the original version string of an installed package.

```APIDOC
## \Composer\InstalledVersions::getPrettyVersion

### Description
Returns the original (pretty) version of a package if it is installed. Returns null if the package is provided or replaced by another package, and throws OutOfBoundsException if the package is not installed at all.

### Method
Static method

### Signature
\Composer\InstalledVersions::getPrettyVersion(string $packageName): ?string

### Parameters
- **packageName** (string) - Required - The package name (e.g. 'vendor/package').

### Return Value
- **?string** - The original version (e.g. v1.2.3) if installed, null if provided/replaced, or throws OutOfBoundsException if not installed.

### Example
\Composer\InstalledVersions::getPrettyVersion('vendor/package');
```

--------------------------------

### Get install path with InstalledVersions::getInstallPath

Source: https://getcomposer.org/doc/07-runtime.md

Returns the absolute install path of a package. Returns null if the package is provided/replaced or is a metapackage, and throws OutOfBoundsException if not installed. The path may contain ../ or symlinks, so run realpath if needed. Available as of Composer 2.1.

```php
// returns an absolute path to the package installation location if vendor/package is installed,
// or null if it is provided/replaced, or the package is a metapackage
// or throws OutOfBoundsException if the package is not installed at all
\Composer\InstalledVersions::getInstallPath('vendor/package');
```

--------------------------------

### composer.json for a WordPress theme with custom type

Source: https://getcomposer.org/doc/faqs/how-do-i-install-a-package-to-a-custom-path-for-my-framework.md

For package authors: require composer/installers and set the package type to override the default installer path. This example uses type 'wordpress-theme' so the package installs into wp-content/themes/themename/.

```json
{
    "name": "you/themename",
    "type": "wordpress-theme",
    "require": {
        "composer/installers": "~1.0"
    }
}
```

--------------------------------

### Configure preferred-install with package patterns

Source: https://getcomposer.org/doc/06-config.md

Configures preferred-install with package name patterns for granular install method preferences. Order matters: more specific patterns should be earlier than more relaxed patterns. When mixing string notation with hash configuration, the string notation is translated to a '*' package pattern.

```json
{
    "config": {
        "preferred-install": {
            "my-organization/stable-package": "dist",
            "my-organization/*": "source",
            "partner-organization/*": "auto",
            "*": "dist"
        }
    }
}
```

--------------------------------

### List tags in sample library

Source: https://getcomposer.org/doc/articles/versions.md

Shows the git tag command output for the sample library repository, listing tags from v1.0 to v2.0.2.

```bash
~/my-library$ git tag

```

```bash
v1.0
v1.0.1
v1.0.2
v1.1-BETA
v1.1-RC1
v1.1-RC2
v1.1
v1.1.1
v2.0-BETA
v2.0-RC1
v2.0
v2.0.1
v2.0.2

```

--------------------------------

### Satis configuration with explicit require

Source: https://getcomposer.org/doc/articles/handling-private-packages.md

Example Satis configuration that cherry-picks specific packages using the classic composer require key with constraints.

```json
{
    "repositories": [
        { "type": "vcs", "url": "https://github.com/mycompany/privaterepo" },
        { "type": "vcs", "url": "http://svn.example.org/private/repo" },
        { "type": "vcs", "url": "https://github.com/mycompany/privaterepo2" }
    ],
    "require": {
        "company/package": "*",
        "company/package2": "*",
        "company/package3": "2.0.0"
    }
}
```

--------------------------------

### Get package reference with InstalledVersions::getReference

Source: https://getcomposer.org/doc/07-runtime.md

Returns the package dist or source reference (e.g. a git commit hash) of an installed package. Returns null if the package is provided or replaced, and throws OutOfBoundsException if not installed at all.

```php
// returns the package dist or source reference (e.g. a git commit hash) if vendor/package is installed,
// or null if it is provided/replaced,
// or throws OutOfBoundsException if the package is not installed at all
\Composer\InstalledVersions::getReference('vendor/package');
```

--------------------------------

### Configure http-basic credentials via command line

Source: https://getcomposer.org/doc/articles/authentication-for-private-packages.md

Sets http-basic credentials for a repository host via the command line. The config key http-basic.repo.example.org combines the authentication method http-basic with the repository host name repo.example.org, which should be replaced with your repository's host name.

```bash
php composer.phar config [--global] http-basic.repo.example.org username password
```

--------------------------------

### notify-batch POST request body

Source: https://getcomposer.org/doc/05-repositories.md

Example JSON request body sent to the notify-batch URL when a package is installed. The version is normalized.

```json
{
    "downloads": [
        {"name": "monolog/monolog", "version": "1.2.1.0"}
    ]
}
```

--------------------------------

### Package defining a vendor binary

Source: https://getcomposer.org/doc/articles/vendor-binaries.md

Example composer.json for package my-vendor/project-a that defines a vendor binary. Running composer install on this package alone does nothing with the binary.

```json
{
    "name": "my-vendor/project-a",
    "bin": ["bin/project-a-bin"]
}
```

--------------------------------

### Configure inline http-basic repository via command line

Source: https://getcomposer.org/doc/articles/authentication-for-private-packages.md

Sets an inline http-basic repository definition with credentials embedded in the URL. The username and password must be percent-encoded according to RFC 3986, e.g., an email address as name%40example.com.

```bash
php composer.phar config [--global] repositories.unique-name composer https://username:password@repo.example.org
```

--------------------------------

### Check blocking packages with composer prohibits

Source: https://getcomposer.org/doc/03-cli.md

Shows the command to check which packages block installing symfony/symfony 3.1, followed by the example output listing the blocking package and its requirement.

```shell
php composer.phar prohibits symfony/symfony 3.1
```

```text
laravel/framework v5.2.16 requires symfony/var-dumper (2.8.*|3.0.*)
```

--------------------------------

### List branches in sample library

Source: https://getcomposer.org/doc/articles/versions.md

Shows the git branch command output for the sample library repository, listing branches v1, v2, my-feature, and another-feature.

```bash
~/my-library$ git branch

```

```bash
v1
v2
my-feature
another-feature

```

--------------------------------

### composer.json extra.installer-paths for Drupal multisite

Source: https://getcomposer.org/doc/faqs/how-do-i-install-a-package-to-a-custom-path-for-my-framework.md

For package consumers: override install paths using the 'installer-paths' extra. This example maps a specific module to sites/example.com/modules/{$name} and all drupal-theme packages to sites/example.com/themes/{$name}. Note that installer-paths is order-dependent and only applies to packages that require composer/installers.

```json
{
    "extra": {
        "installer-paths": {
            "sites/example.com/modules/{$name}": ["vendor/package"],
            "sites/example.com/themes/{$name}": ["type:drupal-theme"]
        }
    }
}
```

--------------------------------

### include-path configuration example

Source: https://getcomposer.org/doc/04-schema.md

Defines a list of paths appended to PHP's include_path. Deprecated for legacy projects; new code should use autoloading.

```json
{
    "include-path": ["lib/"]
}
```

--------------------------------

### List all packages with composer show

Source: https://getcomposer.org/doc/03-cli.md

Lists all available packages in the current project's repositories.

```bash
php composer.phar show
```

--------------------------------

### Disjunctive license example

Source: https://getcomposer.org/doc/04-schema.md

Shows multiple licenses as an array for a choice between licenses.

```json
{
    "license": [
        "LGPL-2.1-only",
        "GPL-3.0-or-later"
    ]
}
```

--------------------------------

### Custom installer class extending LibraryInstaller

Source: https://getcomposer.org/doc/articles/custom-installers.md

Extends Composer\Installer\LibraryInstaller to implement a custom installer. getInstallPath() strips the 'phpdocumentor/template-' prefix and returns 'data/templates/<stripped name>', so packages are installed outside /vendor. supports() returns true only for the 'phpdocumentor-template' package type.

```php
<?php

namespace phpDocumentor\Composer;

use Composer\Package\PackageInterface;
use Composer\Installer\LibraryInstaller;

class TemplateInstaller extends LibraryInstaller
{
    /**
     * @inheritDoc
     */
    public function getInstallPath(PackageInterface $package)
    {
        $prefix = substr($package->getPrettyName(), 0, 23);
        if ('phpdocumentor/template-' !== $prefix) {
            throw new \InvalidArgumentException(
                'Unable to install template, phpdocumentor templates '
                .'should always start their package name with '
                .'"phpdocumentor/template-"'
            );
        }

        return 'data/templates/'.substr($package->getPrettyName(), 23);
    }

    /**
     * @inheritDoc
     */
    public function supports($packageType)
    {
        return 'phpdocumentor-template' === $packageType;
    }
}
```

--------------------------------

### Source field example

Source: https://getcomposer.org/doc/04-schema.md

Shows source information with type, url, and reference.

```json
{
    "source": {
        "type": "git",
        "url": "https://github.com/composer/composer.git",
        "reference": "2.8.0"
    }
}
```
Tokens:
Raw