Composer

https://github.com/composer/composer
Admin
Composer is a dependency management tool for PHP that allows you to declare, manage, and install...
Tokens:403,249
Snippets:2,774
Trust Score:8.6
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Run composer install to install from composer.lock

Source: https://github.com/composer/composer/blob/main/doc/01-basic-usage.md

Use the `install` command when a `composer.lock` file is present to install dependencies at the exact versions listed in that file. This ensures consistent package versions across all environments and is recommended after fetching new changes from your VCS repository.

```shell
php composer.phar install
```

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

### Project requiring a package with vendor binaries (my-vendor/project-b)

Source: https://github.com/composer/composer/blob/main/doc/articles/vendor-binaries.md

Example 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://github.com/composer/composer/blob/main/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/"
}
```

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

### Get help for a command with `php composer.phar help install`

Source: https://github.com/composer/composer/blob/main/doc/03-cli.md

Use the `help` command to display detailed information about a specific Composer command, such as `install`. Run this in a terminal where `composer.phar` is available.

```shell
php composer.phar help install
```

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

### Run composer update to install dependencies

Source: https://github.com/composer/composer/blob/main/doc/01-basic-usage.md

Use the `update` command to resolve dependencies from `composer.json`, write exact versions to `composer.lock`, and then implicitly run `install` to download files into the `vendor` directory. Commit the `composer.lock` file to version control so all environments use the same dependency versions.

```shell
php composer.phar update
```

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

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

Source: https://github.com/composer/composer/blob/main/doc/articles/custom-installers.md

Example composer.json for a template package that uses a custom installer. The package type is set to 'phpdocumentor-template' and it requires the plugin package 'phpdocumentor/template-installer-plugin' to ensure the installer is present during installation.

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

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

### suggest example in composer.json

Source: https://github.com/composer/composer/blob/main/doc/04-schema.md

Shows the format for the 'suggest' key, where values are free text describing the suggested package.

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

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

### Package defining a vendor binary (my-vendor/project-a)

Source: https://github.com/composer/composer/blob/main/doc/articles/vendor-binaries.md

Example package my-vendor/project-a that defines a vendor binary. Running composer install for this package does not create any proxy files because it is the root package.

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

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

### Check Composer installer setup with curl

Source: https://github.com/composer/composer/blob/main/doc/articles/troubleshooting.md

Run the installer's checks to verify your setup has no problems. This command is part of the general troubleshooting steps before asking for help.

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

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

### Require vendor/autoload.php and use Monolog

Source: https://github.com/composer/composer/blob/main/doc/01-basic-usage.md

Include the Composer-generated autoloader to use classes from installed libraries without extra setup. This example creates a Monolog logger and writes a warning to a stream handler.

```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');
```

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

### Update a specific dependency

Source: https://github.com/composer/composer/blob/main/doc/01-basic-usage.md

Explicitly list one dependency as an argument to install, upgrade, or remove only that dependency. The `[...]` placeholder indicates additional arguments can be added.

```shell
php composer.phar update monolog/monolog [...]
```

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

### Install Composer with checksum verification

Source: https://github.com/composer/composer/blob/main/doc/faqs/how-to-install-composer-programmatically.md

A shell script that downloads the Composer installer, verifies its SHA-384 checksum against the official signature, installs Composer silently, and cleans up. Exits with 1 on checksum failure or 0 on success; prints an error message and removes the installer on failure.

```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 a specific Composer version from GitHub history

Source: https://github.com/composer/composer/blob/main/doc/faqs/how-to-install-composer-programmatically.md

Fetches a specific installer from GitHub history and pipes it to PHP with the quiet flag, avoiding the need for checksum verification. Replace the commit hash with the latest commit on the getcomposer.org repository.

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

```

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

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

Source: https://github.com/composer/composer/blob/main/doc/00-intro.md

Installs Composer locally into the bin directory with the filename composer. Use this command when following the Download page instructions to install Composer as part of your project.

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

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

### Support information with email and IRC

Source: https://github.com/composer/composer/blob/main/doc/04-schema.md

Provides support contact details. The example includes an email address and an IRC channel. Other supported keys include issues, forum, wiki, source, docs, rss, chat, and security.

```json
{
    "support": {
        "email": "support@example.org",
        "irc": "irc://irc.freenode.org/composer"
    }
}
```

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

### provider-includes and providers-url JSON example

Source: https://github.com/composer/composer/blob/main/doc/05-repositories.md

Lists provider files with sha256 hashes and a URL template for provider files. Must contain %package% and %hash% placeholders. Used by Composer v1 or when metadata-url is not set. Optional.

```json
{
    "provider-includes": {
        "providers-a.json": {
            "sha256": "f5b4bc0b354108ef08614e569c1ed01a2782e67641744864a74e788982886f4c"
        },
        "providers-b.json": {
            "sha256": "b38372163fac0573053536f5b8ef11b86f804ea8b016d239e706191203f6efac"
        }
    },
    "providers-url": "/p/%package%$%hash%.json"
}
```

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

### policy add-source examples

Source: https://github.com/composer/composer/blob/main/doc/03-cli.md

Example invocations of the policy add-source command, one using a URL and one using a JSON source definition. Both target the 'my-list' policy.

```shell
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"}'
```

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

### Get install path with getInstallPath

Source: https://github.com/composer/composer/blob/main/doc/07-runtime.md

Use \Composer\InstalledVersions::getInstallPath() to get the absolute install path of a package. Returns null if the package is provided/replaced or is a metapackage, or throws OutOfBoundsException if not installed. The path may contain ../ or symlinks; 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');
```

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

### Plugin class registering a custom installer

Source: https://github.com/composer/composer/blob/main/doc/articles/custom-installers.md

Implements Composer\Plugin\PluginInterface and registers a custom installer in the activate() method. The installer is added to the installation manager, enabling custom installation logic.

```php
<?php

namespace phpDocumentor\Composer;

use Composer\Composer;
use Composer\IO\IOInterface;
use Composer\Plugin\PluginInterface;

class TemplateInstallerPlugin implements PluginInterface
{
    public function activate(Composer $composer, IOInterface $io)
    {
        $installer = new TemplateInstaller($io, $composer);
        $composer->getInstallationManager()->addInstaller($installer);
    }
}
```

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

### Custom Installer Class extending LibraryInstaller

Source: https://github.com/composer/composer/blob/main/doc/articles/custom-installers.md

Extends Composer\Installer\LibraryInstaller to implement a custom installer for packages of type 'phpdocumentor-template'. The getInstallPath() method validates that the package name starts with 'phpdocumentor/template-' and returns an installation path under 'data/templates/' instead of '/vendor'. The supports() method returns true only when the package type matches 'phpdocumentor-template'.

```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;
    }
}
```

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

### metadata-url field example

Source: https://github.com/composer/composer/blob/main/doc/05-repositories.md

Provides a URL template for serving all packages in the repository. Must contain the %package% placeholder. New in Composer v2.

```json
{
    "metadata-url": "/p2/%package%.json"
}
```

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

### repo command examples

Source: https://github.com/composer/composer/blob/main/doc/03-cli.md

Practical invocations of the `repo` command. The `add` subcommand accepts either a repository type and URL or a JSON definition. Options like `--before` and `--after` control repository ordering.

```shell
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
```

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

### notify-batch POST request body

Source: https://github.com/composer/composer/blob/main/doc/05-repositories.md

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

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

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

### \Composer\InstalledVersions::getPrettyVersion

Source: https://github.com/composer/composer/blob/main/doc/07-runtime.md

Static method to get the original (pretty) version of an installed package. Returns null if the package is provided or replaced, and throws OutOfBoundsException if not installed.

```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
getPrettyVersion

### 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
```php
\Composer\InstalledVersions::getPrettyVersion('vendor/package');
```
```

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

### Configure composer.json bin-dir to scripts

Source: https://github.com/composer/composer/blob/main/doc/articles/vendor-binaries.md

Sets the bin-dir configuration in composer.json to install vendor binaries in the 'scripts' directory instead of the default 'vendor/bin'. Running composer install for this configuration will place all vendor binaries in 'scripts/'. Set bin-dir to './' to put binaries in the project root.

```json
{
    "config": {
        "bin-dir": "scripts"
    }
}
```

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

### repositories: Example with multiple repository types

Source: https://github.com/composer/composer/blob/main/doc/04-schema.md

Shows how to define custom repositories in composer.json using an array of repository objects. Order is significant; Composer searches from first to last and picks the first match, with Packagist added last by default so custom repositories can override it.

```json
{
    "repositories": [
        {
            "type": "composer",
            "url": "http://packages.example.com"
        },
        {
            "type": "composer",
            "url": "https://packages.example.com",
            "options": {
                "ssl": {
                    "verify_peer": "true"
                }
            }
        },
        {
            "type": "vcs",
            "url": "https://github.com/Seldaek/monolog"
        },
        {
            "type": "path",
            "url": "../packages/my-package"
        },
        {
            "type": "package",
            "package": {
                "name": "smarty/smarty",
                "version": "3.1.7",
                "dist": {
                    "url": "https://www.smarty.net/files/Smarty-3.1.7.zip",
                    "type": "zip"
                },
                "source": {
                    "url": "https://smarty-php.googlecode.com/svn/",
                    "type": "svn",
                    "reference": "tags/Smarty_3_1_7/distribution/"
                }
            }
        }
    ]
}
```

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

### Composer Version Constraint Summary (JSON)

Source: https://github.com/composer/composer/blob/main/doc/articles/versions.md

JSON example showing common Composer version constraint syntax in a require block: exact, bounds, wildcard, tilde, and caret operators with inline comments explaining each. Use in composer.json.

```jsonc
"require": {
    "vendor/package": "1.3.2", // exactly 1.3.2

    // >, <, >=, <= | specify upper / lower bounds
    "vendor/package": ">=1.3.2", // anything above or equal to 1.3.2
    "vendor/package": "<1.3.2", // anything below 1.3.2

    // * | wildcard
    "vendor/package": "1.3.*", // >=1.3.0 <1.4.0

    // ~ | allows last digit specified to go up
    "vendor/package": "~1.3.2", // >=1.3.2 <1.4.0
    "vendor/package": "~1.3", // >=1.3.0 <2.0.0

    // ^ | doesn't allow breaking changes (major version fixed - following semver)
    "vendor/package": "^1.3.2", // >=1.3.2 <2.0.0
    "vendor/package": "^0.3.2", // >=0.3.2 <0.4.0 // except if major version is 0
}
```

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

### Requiring PHP version and extensions (php, ext-*)

Source: https://github.com/composer/composer/blob/main/doc/04-schema.md

Shows how to declare required PHP versions and PHP extensions. Listing extensions is important because missing extensions can cause runtime failures after installation.

```json
{
    "require": {
        "php": ">=7.4",
        "ext-mbstring": "*"
    }
}
```

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

### Run composer init command

Source: https://github.com/composer/composer/blob/main/doc/03-cli.md

Starts the interactive composer.json creation wizard. The command prompts for package fields with smart defaults.

```shell
php composer.phar init
```

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

### acme/blog composer.json with VCS repository for acme/hello-world

Source: https://github.com/composer/composer/blob/main/doc/02-libraries.md

Adds a VCS package repository pointing to https://github.com/username/hello-world so Composer can find the acme/hello-world dependency. This is required before running composer install.

```json
{
    "name": "acme/blog",
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/username/hello-world"
        }
    ],
    "require": {
        "acme/hello-world": "dev-master"
    }
}
```

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

### Disjunctive license as an array

Source: https://github.com/composer/composer/blob/main/doc/04-schema.md

Specifies multiple licenses when there is a choice between them (disjunctive license). The example shows LGPL-2.1-only and GPL-3.0-or-later as alternatives.

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

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

### Verify Composer installation

Source: https://github.com/composer/composer/blob/main/doc/00-intro.md

Checks the installed Composer version after installation. Run in a new terminal to ensure the PATH is loaded.

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

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

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

### providers-api field JSON example

Source: https://github.com/composer/composer/blob/main/doc/05-repositories.md

Defines a URL template for packages that provide a given package name. Must contain the %package% placeholder. Optional field.

```json
{
    "providers-api": "https://packagist.org/providers/%package%.json",
}
```

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

### Complete plugin example implementing EventSubscriberInterface

Source: https://github.com/composer/composer/blob/main/doc/articles/plugins.md

A full Composer plugin class that implements PluginInterface and EventSubscriberInterface. It registers a handler for the PRE_FILE_DOWNLOAD event and checks if the URL protocol is 's3'.

```php
<?php

namespace Naderman\Composer\AWS;

use Composer\Composer;
use Composer\EventDispatcher\EventSubscriberInterface;
use Composer\IO\IOInterface;
use Composer\Plugin\PluginInterface;
use Composer\Plugin\PluginEvents;
use Composer\Plugin\PreFileDownloadEvent;

class AwsPlugin implements PluginInterface, EventSubscriberInterface
{
    protected $composer;
    protected $io;

    public function activate(Composer $composer, IOInterface $io)
    {
        $this->composer = $composer;
        $this->io = $io;
    }

    public function deactivate(Composer $composer, IOInterface $io)
    {
    }

    public function uninstall(Composer $composer, IOInterface $io)
    {
    }

    public static function getSubscribedEvents()
    {
        return [
            PluginEvents::PRE_FILE_DOWNLOAD => [
                ['onPreFileDownload', 0]
            ],
        ];
    }

    public function onPreFileDownload(PreFileDownloadEvent $event)
    {
        $protocol = parse_url($event->getProcessedUrl(), PHP_URL_SCHEME);

        if ($protocol === 's3') {
            // ...
        }
    }
}
```

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

### Show detailed changes with composer status -v

Source: https://github.com/composer/composer/blob/main/doc/03-cli.md

Use the --verbose option to get more information about what was changed. The output lists the dependency and the modified files, as shown in the example.

```shell
php composer.phar status -v
```

```text
You have changes in the following dependencies:
vendor/seld/jsonlint:
    M README.mdown
```

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

### List packages by type with getInstalledPackagesByType

Source: https://github.com/composer/composer/blob/main/doc/07-runtime.md

Use \Composer\InstalledVersions::getInstalledPackagesByType() to list installed packages of a given type (e.g. foo-plugin). Available as of Composer 2.1. Useful for finding plugins at runtime without custom installers.

```php
\Composer\InstalledVersions::getInstalledPackagesByType('foo-plugin');
```

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

### Repository options JSON example

Source: https://github.com/composer/composer/blob/main/doc/05-repositories.md

Sets extra options for repository access via cURL or PHP streams. For PHP streams, any valid stream context option can be set; for cURL, only a limited set of http and ssl options.

```json
{
    "repositories": [
        {
            "type": "composer",
            "url": "https://example.org",
            "options": {
                "http": {
                    "timeout": 60
                }
            }
        }
    ],
    "require": {
        "acme/package": "^1.0"
    }
}
```

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

### Provider file contents JSON example

Source: https://github.com/composer/composer/blob/main/doc/05-repositories.md

Lists package names and sha256 hashes to verify file integrity. The file above declares that acme/foo and acme/bar can be found in this repository by loading the file referenced by providers-url.

```json
{
    "providers": {
        "acme/foo": {
            "sha256": "38968de1305c2e17f4de33aea164515bc787c42c7e2d6e25948539a14268bb82"
        },
        "acme/bar": {
            "sha256": "4dd24c930bd6e1103251306d6336ac813b563a220d9ca14f4743c032fb047233"
        }
    }
}
```

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

### Dockerfile: Optimized layer reuse by copying composer.json and composer.lock first

Source: https://github.com/composer/composer/blob/main/doc/articles/caching.md

Copy only composer.json and composer.lock before installing to avoid rerunning the install when application source changes. Generate the autoloader in a separate step after copying the source, because it cannot be generated before the source is present. Every RUN step that calls composer needs the bind mount, since the Composer binary is only available while mounted. Do not disable scripts or plugins with --no-scripts or --no-plugins just for layer reuse, as the resulting vendor/ directory would miss what they generate.

```dockerfile
COPY composer.json composer.lock ./
RUN --mount=type=bind,from=composer/composer:2-bin,source=/composer,target=/usr/bin/composer \
    --mount=type=cache,target=/tmp/composer-cache \
    COMPOSER_CACHE_DIR=/tmp/composer-cache \
    composer install --no-interaction --prefer-dist --no-progress --no-autoloader
COPY . .
RUN --mount=type=bind,from=composer/composer:2-bin,source=/composer,target=/usr/bin/composer \
    composer dump-autoload --optimize
```

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

### Install a CLI tool globally with composer global require

Source: https://github.com/composer/composer/blob/main/doc/03-cli.md

Use `php composer.phar global require` to install a package into the global COMPOSER_HOME directory, making its binaries available system-wide. Ensure the global vendor binaries directory is in your `$PATH` to use the installed commands.

```shell
php composer.phar global require friendsofphp/php-cs-fixer
```

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

### WordPress theme composer.json with custom type and dependency on compposer/installers — package author example

Source: https://github.com/composer/composer/blob/main/doc/faqs/how-do-i-install-a-package-to-a-custom-path-for-my-framework.md

For package authors: this is an example of a `composer.json` for a WordPress theme that requires `comptioner/` +installers 

```json
{
 "name": "you/themenary
```

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

### Create a new project with composer create-project

Source: https://github.com/composer/composer/blob/main/doc/03-cli.md

Use the create-project command to clone a package and install its dependencies. Pass the package name and target directory; optionally provide a version as the third argument. The directory is created if it does not exist.

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

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

### \Composer\InstalledVersions::getInstallPath

Source: https://github.com/composer/composer/blob/main/doc/07-runtime.md

Static method to retrieve a package's absolute install path. Available as of Composer 2.1 (composer-runtime-api ^2.1).

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

### Description
Returns the absolute install path of a package. The path may contain `../` or symlinks and is not guaranteed to be equivalent to a realpath. Returns null if the package is provided or replaced, or if it is a metapackage, and throws OutOfBoundsException if the package is not installed at all.

### Method
getInstallPath

### 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
```php
\Composer\InstalledVersions::getInstallPath('vendor/package');
```
```

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

### preferred-install configuration with package patterns

Source: https://github.com/composer/composer/blob/main/doc/06-config.md

Configures preferred install method per package pattern. Order matters: more specific patterns should be earlier. The string notation is translated to a '*' pattern when mixing with hash config.

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

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

### list field response JSON example

Source: https://github.com/composer/composer/blob/main/doc/05-repositories.md

Returns an array of package names matching an optional filter. Replace/provide rules are not considered. Optional field.

```json
{
    "packageNames": [
        "a/b",
        "c/d"
    ]
}
```

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

### Get original version with getPrettyVersion

Source: https://github.com/composer/composer/blob/main/doc/07-runtime.md

Use \Composer\InstalledVersions::getPrettyVersion() to get the original version (e.g. v1.2.3) for an installed package. Returns null if the package is provided/replaced, or 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');
```

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

### \Composer\InstalledVersions::isInstalled

Source: https://github.com/composer/composer/blob/main/doc/07-runtime.md

Static method to check if a package or virtual package is installed. Optionally can check if it was installed via require-dev.

```APIDOC
## \Composer\InstalledVersions::isInstalled

### Description
Checks whether a package (or virtual package) is installed. As of Composer 2.1, you can also check if the package was installed via require-dev or not by passing false as the second argument.

### Method
isInstalled

### Signature
\Composer\InstalledVersions::isInstalled(string $packageName, bool $includeDevRequirements = true): bool

### Parameters
- **packageName** (string) - Required - The package name (e.g. 'vendor/package') or virtual package name (e.g. 'psr/log-implementation').
- **includeDevRequirements** (bool) - Optional - When false, returns true only if the package is in require, false if in require-dev. Defaults to true.

### Return Value
- **bool** - True if the package is installed, false otherwise.

### Example
```php
\Composer\InstalledVersions::isInstalled('vendor/package'); // returns bool
\Composer\InstalledVersions::isInstalled('psr/log-implementation'); // returns bool
\Composer\InstalledVersions::isInstalled('vendor/package', false); // returns true if in require, false if in require-dev
```
```

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

### Get normalized version with getVersion

Source: https://github.com/composer/composer/blob/main/doc/07-runtime.md

Use \Composer\InstalledVersions::getVersion() to get a normalized version (e.g. 1.2.3.0) for an installed package. Returns null if the package is provided/replaced, or 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');
```

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

### \Composer\InstalledVersions::satisfies

Source: https://github.com/composer/composer/blob/main/doc/07-runtime.md

Static method to check if a package is installed in a version that satisfies a given constraint. Requires composer/semver ^3.0.

```APIDOC
## \Composer\InstalledVersions::satisfies

### Description
Checks whether a package is installed in a version that satisfies a given version constraint. This also returns true if the package name is replaced or provided by another package.

### Method
satisfies

### Signature
\Composer\InstalledVersions::satisfies(\Composer\Semver\VersionParser $versionParser, string $packageName, string $constraint): bool

### Parameters
- **versionParser** (\Composer\Semver\VersionParser) - Required - An instance of the Composer Semver VersionParser.
- **packageName** (string) - Required - The package name (e.g. 'vendor/package') or virtual package name.
- **constraint** (string) - Required - The version constraint (e.g. '2.0.*' or '^1.0').

### Return Value
- **bool** - True if the package is installed in a version matching the constraint, false otherwise.

### Example
```php
use Composer\Semver\VersionParser;

\Composer\InstalledVersions::satisfies(new VersionParser, 'vendor/package', '2.0.*');
\Composer\InstalledVersions::satisfies(new VersionParser, 'psr/log-implementation', '^1.0');
```
```

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

### Add name and require to composer.json

Source: https://github.com/composer/composer/blob/main/doc/02-libraries.md

Adds a name (vendor/package) and a require dependency to make a directory a named, installable package. The vendor name is mandatory; package names must be lowercase and conventionally use dashes.

```json
{
    "name": "acme/hello-world",
    "require": {
        "monolog/monolog": "1.0.*"
    }
}
```

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

### Use ramsey/composer-install for default caching

Source: https://github.com/composer/composer/blob/main/doc/articles/caching.md

Simplest option for most workflows. Runs composer install and persists the Composer cache directory in the CI cache by default, so no separate caching step or custom COMPOSER_CACHE_DIR is needed.

```yaml
- uses: shivammathur/setup-php@v2
  with:
    php-version: ${{ matrix.php }}

- uses: ramsey/composer-install@v4
```

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

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

Source: https://github.com/composer/composer/blob/main/doc/articles/authentication-for-private-packages.md

Sets a Composer repository with inline credentials in the repository URL. The username and password must be percent-encoded per RFC 3986 (e.g., an email address as name%40example.com). Use --global to store in global configuration.

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

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

### Check if a package satisfies a version constraint with satisfies

Source: https://github.com/composer/composer/blob/main/doc/07-runtime.md

Use \Composer\InstalledVersions::satisfies() to check if a package is installed in a version matching a constraint. Requires composer/semver ^3.0. Returns true if the package is installed, replaced, or provided by another package.

```php
use Composer\Semver\VersionParser;

\Composer\InstalledVersions::satisfies(new VersionParser, 'vendor/package', '2.0.*');
\Composer\InstalledVersions::satisfies(new VersionParser, 'psr/log-implementation', '^1.0');
```

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

### PSR-4 autoload mapping example

Source: https://github.com/composer/composer/blob/main/doc/04-schema.md

Defines a PSR-4 mapping from namespaces to paths. The prefix must end in '\\' to avoid conflicts. The mapping is combined into vendor/composer/autoload_psr4.php.

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

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

### dist url with placeholders

Source: https://github.com/composer/composer/blob/main/doc/04-schema.md

Shows how dist url can contain placeholders so one URL serves every version. Placeholders are expanded when the package is downloaded. %version% and %reference% are hashed (MD5) under certain conditions to avoid path segments or URL escaping. Placeholders are expanded in dist only, not in source.

```json
{
    "dist": {
        "type": "zip",
        "url": "https://example.org/dist/%package%/%prettyVersion%.zip"
    }
}
```

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

### Get package reference with getReference

Source: https://github.com/composer/composer/blob/main/doc/07-runtime.md

Use \Composer\InstalledVersions::getReference() to get the package dist or source reference (e.g. a git commit hash) for an installed package. Returns null if the package is provided/replaced, or 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');
```

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

### PHP: Get bin directory with fallback

Source: https://github.com/composer/composer/blob/main/doc/articles/vendor-binaries.md

Uses $_composer_bin_dir if defined, otherwise falls back to __DIR__ . '/../vendor/bin'. Requires composer-runtime-api ^2.2.2.

```php
<?php

$binDir = $_composer_bin_dir ?? __DIR__ . '/../vendor/bin';

```

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

### \Composer\InstalledVersions::getVersion

Source: https://github.com/composer/composer/blob/main/doc/07-runtime.md

Static method to get the normalized version of an installed package. Returns null if the package is provided or replaced, and throws OutOfBoundsException if not installed.

```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
getVersion

### 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
```php
\Composer\InstalledVersions::getVersion('vendor/package');
```
```

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

### Dockerfile: BuildKit cache mount for Composer cache

Source: https://github.com/composer/composer/blob/main/doc/articles/caching.md

Use a BuildKit cache mount to persist the Composer cache between builds without copying it into the image. Install in the application image itself and mount the Composer binary from composer/composer:2-bin only for the install step. Do not use the full composer or composer/composer images because they ship the latest PHP with few extensions, which can fail platform checks or produce a vendor/ directory for a different PHP environment. Cache mounts are not included in exported build caches like --cache-to, so on fresh CI runners they are empty unless using a persistent builder or a tool like buildkit-cache-dance. Exclude vendor/ and any Composer cache directory in .dockerignore.

```dockerfile
# syntax=docker/dockerfile:1
FROM php:8.4-cli
RUN apt-get update && apt-get install -y --no-install-recommends git unzip \
    && rm -rf /var/lib/apt/lists/*
WORKDIR /app
COPY . .
RUN --mount=type=bind,from=composer/composer:2-bin,source=/composer,target=/usr/bin/composer \
    --mount=type=cache,target=/tmp/composer-cache \
    COMPOSER_CACHE_DIR=/tmp/composer-cache \
    composer install --no-interaction --prefer-dist --no-progress
```

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

### acme/blog composer.json with dependency on acme/hello-world

Source: https://github.com/composer/composer/blob/main/doc/02-libraries.md

Initial composer.json for a local project named acme/blog that requires the acme/hello-world package at dev-master. The name field is optional for a non-published project but clarifies which composer.json is described.

```json
{
    "name": "acme/blog",
    "require": {
        "acme/hello-world": "dev-master"
    }
}
```

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

### .gitattributes export-ignore rules

Source: https://github.com/composer/composer/blob/main/doc/02-libraries.md

Use .gitattributes to exclude files like /demo, phpunit.xml.dist, /.github/, and /composer.lock from distribution zip packages. Files remain tracked by git but are not included in dist packages installed from tagged releases on GitHub, GitLab, or Bitbucket.

```text
// .gitattributes
/demo export-ignore
phpunit.xml.dist export-ignore
/.github/ export-ignore
/composer.lock export-ignore
```

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

### \Composer\InstalledVersions::getReference

Source: https://github.com/composer/composer/blob/main/doc/07-runtime.md

Static method to get 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.

```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
getReference

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

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

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

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

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

### archive-dir configuration example

Source: https://github.com/composer/composer/blob/main/doc/06-config.md

Sets the default destination directory for archives created by the archive command. The default is `.`.

```json
{
    "config": {
        "archive-dir": "/home/user/.composer/repo"
    }
}
```

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

### Modify a repository with JSON configuration

Source: https://github.com/composer/composer/blob/main/doc/03-cli.md

Passes a JSON representation for a repository that requires more configuration options. The example sets repositories.foo with type, url, and trunk-path.

```shell
php composer.phar config repositories.foo '{"type": "vcs", "url": "http://svn.example.org/my-project/", "trunk-path": "master"}'
```

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

### Set http-basic credentials via composer config command

Source: https://github.com/composer/composer/blob/main/doc/articles/authentication-for-private-packages.md

Use this command to set HTTP basic authentication credentials for a repository host. Replace `repo.example.org` with your repository host name. The `--global` flag applies the configuration globally; without it, the configuration is project-specific.

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

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

### Build Satis repository

Source: https://github.com/composer/composer/blob/main/doc/articles/handling-private-packages.md

Runs the Satis build command with a configuration file and build directory.

```shell
php bin/satis build <configuration file> <build dir>
```

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

### Modify a repository with config command

Source: https://github.com/composer/composer/blob/main/doc/03-cli.md

Adds or modifies a repository in the repositories section. The example sets repositories.foo to a VCS repository with the given URL.

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

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

### git archive to inspect zip distribution

Source: https://github.com/composer/composer/blob/main/doc/02-libraries.md

Generate a zip file manually to test which files are excluded by .gitattributes. Replace branchName with the branch or tag to archive.

```shell
git archive branchName --format zip -o file.zip
```

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

### Configure HTTP Bearer authentication via command line

Source: https://github.com/composer/composer/blob/main/doc/articles/authentication-for-private-packages.md

Sets a bearer token for a repository host. The config key 'bearer.repo.example.org' combines the 'bearer' method with the repository host name; replace 'repo.example.org' with your host.

```shell
php composer.phar config [--global] bearer.repo.example.org token
```

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

### Reinstall all packages of a type with --type

Source: https://github.com/composer/composer/blob/main/doc/03-cli.md

Reinstalls every installed package of the given type. The type must match exactly; wildcards are not supported, and it cannot be combined with package names.

```shell
php composer.phar reinstall --type=composer-plugin
```

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

### \Composer\InstalledVersions::getInstalledPackagesByType

Source: https://github.com/composer/composer/blob/main/doc/07-runtime.md

Static method to get a list of installed packages of a given type. Available as of Composer 2.1 (composer-runtime-api ^2.1).

```APIDOC
## \Composer\InstalledVersions::getInstalledPackagesByType

### Description
Lists the packages of a given type that are installed. This can be used to find plugins or other packages of a specific type at runtime.

### Method
getInstalledPackagesByType

### Signature
\Composer\InstalledVersions::getInstalledPackagesByType(string $type): array

### Parameters
- **type** (string) - Required - The package type (e.g. 'foo-plugin').

### Return Value
- **array** - An array of package names of the given type that are installed.

### Example
```php
\Composer\InstalledVersions::getInstalledPackagesByType('foo-plugin');
```
```

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

### Satis configuration with require constraints

Source: https://github.com/composer/composer/blob/main/doc/articles/handling-private-packages.md

Selects specific packages using the `require` key with constraints like `"*"` or exact versions.

```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"
    }
}
```

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

### composer.json for a custom installer plugin

Source: https://github.com/composer/composer/blob/main/doc/articles/custom-installers.md

Defines a Composer plugin package with type 'composer-plugin' and an 'extra.class' entry pointing to the plugin class. Includes 'composer-plugin-api' in require and Composer itself in require-dev for testing.

```json
{
    "name": "phpdocumentor/template-installer-plugin",
    "type": "composer-plugin",
    "license": "MIT",
    "autoload": {
        "psr-0": {"phpDocumentor\\Composer": "src/"}
    },
    "extra": {
        "class": "phpDocumentor\\Composer\\TemplateInstallerPlugin"
    },
    "require": {
        "composer-plugin-api": "^1.0"
    },
    "require-dev": {
        "composer/composer": "^1.3"
    }
}
```

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

### target-dir with PSR-0 autoloading

Source: https://github.com/composer/composer/blob/main/doc/04-schema.md

Deprecated: defines the installation target for legacy PSR-0 autoloading. Used when the package root is below the namespace declaration, as in Symfony components, to ensure proper autoloading.

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

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

### Filter packages with wildcard mask

Source: https://github.com/composer/composer/blob/main/doc/03-cli.md

Filters the package list using a wildcard mask. The example shows the output for 'monolog/*', displaying the package name, version, and description.

```shell
php composer.phar show "monolog/*"
```

```text
monolog/monolog 2.4.0 Sends your logs to files, sockets, inboxes, databases and various web services
```

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

### Update Composer to a specific release with self-update

Source: https://github.com/composer/composer/blob/main/doc/03-cli.md

Specify a release version to update to, for example 2.4.0-RC1. This command is not available if Composer was not installed as a PHAR.

```shell
php composer.phar self-update 2.4.0-RC1
```

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

### source field with git type

Source: https://github.com/composer/composer/blob/main/doc/04-schema.md

Defines where package sources live for installing from source. Requires type, url, and reference; mirrors is optional. For git, reference is a commit id, branch, or tag name. Normally provided by the repository, but written by hand in a package repository.

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

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

### Enable swap file with dd, mkswap, chmod, swapon

Source: https://github.com/composer/composer/blob/main/doc/articles/troubleshooting.md

Use these commands to create and enable a swap file. The commands create a 1GB swap file at /var/swap.1, format it, set permissions, and activate it. This can resolve proc_open() fork failed errors caused by insufficient memory.

```shell
/bin/dd if=/dev/zero of=/var/swap.1 bs=1M count=1024
/sbin/mkswap /var/swap.1
/bin/chmod 0600 /var/swap.1
/sbin/swapon /var/swap.1
```

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

### Store autoloader instance and add PSR-4 namespace

Source: https://github.com/composer/composer/blob/main/doc/01-basic-usage.md

The include call returns the autoloader instance, allowing you to add more namespaces at runtime. This is useful for autoloading classes in a test suite.

```php
$loader = require __DIR__ . '/vendor/autoload.php';
$loader->addPsr4('Acme\\Test\\', __DIR__);
```

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

### Interactive package search with require

Source: https://github.com/composer/composer/blob/main/doc/03-cli.md

Run without arguments to prompt for a package search and select matches to require. Adds packages to composer.json and installs or updates them.

```shell
php composer.phar require
```

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

### List Git branches in sample library

Source: https://github.com/composer/composer/blob/main/doc/articles/versions.md

Shows the output of `git branch` for the sample library repository, listing branches `v1`, `v2`, `my-feature`, and `another-feature`. Used to illustrate how Composer handles branches.

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

```text
v1
v2
my-feature
another-feature
```
Tokens:
Raw