eloquent/composer-config-reader

A light-weight component for reading Composer configuration files.

No longer maintained

This package is no longer maintained. See [this statement] for more info., _(*1)

[this statement]: https://gist.github.com/ezzatron/713a548735febe3d76f8ca831bc895c0# Phony for PHPUnit, _(*2)

Composer configuration reader

A light-weight component for reading Composer configuration files., _(*3)

![Current version image][version-image] ![Current coverage status image][coverage-image], _(*4)

Installation and documentation

• Available as Composer package eloquent/composer-config-reader.

Usage

Composer configuration reader is very simple to use, and a quick example should be self-explanatory:, _(*5)

$reader = new Eloquent\Composer\Configuration\ConfigurationReader;
$configuration = $reader->read('/path/to/composer.json');

echo $configuration->name(); // outputs the package name

Configuration objects

The following are the objects used to represent the configuration information. For a more detailed overview of the data available, simply look through the class definition (these classes are very simple)., _(*6)

The following classes all exist in the Eloquent\Composer\Configuration\Element namespace., _(*7)

Configuration

This is the main configuration object and has methods to access all the information available in the Composer schema., _(*8)

Example methods

• name(): The package name.
• description(): The package description.
• dependencies(): Equivalent to Composer require.
• devDependencies(): Equivalent to Composer require-dev.
• autoloadPSR0(): The autoload information for PSR-0 namespaces/paths.
• autoloadClassmap(): The autoload information for classmapped paths.

Helper methods

A number of helper methods exist on the main configuration object to simplify the process of extracting useful information:, _(*9)

• projectName(): The project name without the vendor prefix.
• vendorName(): The vendor name without the project suffix.
• allDependencies(): Combines require and require-dev into a single array.
• allPSR0SourcePaths(): A flat array of all PSR-0-compliant source paths.
• allSourcePaths(): A flat array of all source paths.

Repository, PackageRepository

These objects describe the package's defined repositories., _(*10)

All repositories are represented by the Repository class, except for package-type repositories which use the PackageRepository class., _(*11)

See Repositories., _(*12)

Example methods

• type(): The repository type.
• url(): The repository URL (not available for PackageRepository).

Stability

This object is an enumeration of package stabilities, with the following members:, _(*13)

• DEV
• ALPHA
• BETA
• RC
• STABLE

It is currently only used to represent the value of the minimum-stability option., _(*14)

Author

This object contains all information provided for a specific author., _(*15)

See authors., _(*16)

Example methods

• name(): The author's name.
• email(): The author's email address.

SupportInformation

This object describes the package's support contact information., _(*17)

See support., _(*18)

Example methods

• email(): The support email address.
• issues(): The URL of the issue tracking system.
• wiki(): The URL of the wiki system.

ProjectConfiguration

This object describes configuration options specific to end-projects, such as the target directories for various resources provided by Composer., _(*19)

See config., _(*20)

Example methods

• vendorDir(): The project's vendor directory path.
• binDir(): The project's binary directory path.

ScriptConfiguration

This object describes the Composer scripts defined by the package., _(*21)

See Scripts., _(*22)

Example methods

• preInstallCmd(): The pre-install scripts.
• postInstallCmd(): The post-install scripts.

ArchiveConfiguration

This object describes the settings for creating package archives., _(*23)

See archive., _(*24)

Example methods

• exclude(): A list of file exclusion patterns.