README

用于读取 Composer 配置文件的轻量级组件。

安装和文档

• 作为 Composer 包 eloquent/composer-config-reader 可用。

使用方法

Composer 配置读取器非常简单易用，以下快速示例应该可以自我解释。

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

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

配置对象

以下是用作表示配置信息的对象。要获取数据的更详细概述，请查看类定义（这些类非常简单）。

以下类都存在于 Eloquent\Composer\Configuration\Element 命名空间中。

配置

这是主要的配置对象，具有访问所有在 Composer 架构 中可用的信息的各种方法。

示例方法

• name(): 包名。
• description(): 包描述。
• dependencies(): 等同于 Composer require。
• devDependencies(): 等同于 Composer require-dev。
• autoloadPSR0(): PSR-0 命名空间/路径的自动加载信息。
• autoloadClassmap(): 类映射路径的自动加载信息。

辅助方法

主配置对象上存在一些辅助方法，可以简化提取有用信息的过程

• projectName(): 不带供应商前缀的项目名称。
• vendorName(): 不带项目后缀的供应商名称。
• allDependencies(): 将 require 和 require-dev 合并成一个数组。
• allPSR0SourcePaths(): 所有 PSR-0 兼容源路径的平面数组。
• allSourcePaths(): 所有源路径的平面数组。

Repository, PackageRepository

这些对象描述了包定义的仓库。

所有仓库都由 Repository 类表示，除了包类型仓库，它使用 PackageRepository 类。

参见 仓库。

示例方法

• type(): 仓库类型。
• url(): 仓库 URL（对于 PackageRepository 不可用）。

稳定性

这是一个表示包稳定性的枚举对象，具有以下成员

• DEV
• ALPHA
• BETA
• RC
• STABLE

它目前仅用于表示 minimum-stability 选项的值。

作者

此对象包含针对特定作者提供的信息。

参见 作者。

示例方法

• name(): 作者的姓名。
• email(): 作者的电子邮件地址。

支持信息

此对象描述了包的支持联系信息。

参见 支持。

示例方法

• email(): 支持电子邮件地址。
• issues(): 问题跟踪系统的 URL。
• wiki()：维基系统的URL。

项目配置

此对象描述了针对端项目特定的配置选项，例如Composer提供各种资源的目标目录。

参见 配置。

示例方法

• vendorDir()：项目的供应商目录路径。
• binDir()：项目的二进制目录路径。

脚本配置

此对象描述了由包定义的Composer脚本。

参见 脚本。

示例方法

• preInstallCmd()：安装前的脚本。
• postInstallCmd()：安装后的脚本。

归档配置

此对象描述了创建包归档的设置。

参见 归档。

示例方法

• exclude()：文件排除模式的列表。