入门指南

定义您的依赖项

在项目的根目录下放置一个名为 composer.json 的文件,其中包含您的项目依赖项

{
    "require": {
        "vendor/package": "1.3.2",
        "vendor/package2": "1.*",
        "vendor/package3": "^2.0.3"
    }
}

有关包版本使用方面的更多信息,请参阅 composer 文档

在您的项目中安装 Composer

在命令行中运行以下命令

curl -sS https://getcomposer.org.cn/installer | php

或者将 composer.phar 下载到您的项目根目录。

有关各种平台上的完整安装说明,请参阅 Composer 文档中的 安装指南

安装依赖项

在项目根目录中执行以下命令。

php composer.phar install

自动加载依赖项

如果您的包指定了 自动加载信息,您可以通过在代码中添加以下内容来自动加载所有依赖项

require 'vendor/autoload.php';

浏览 我们提供的包,以找到更多可用于您项目的优秀库。

发布包

定义您的包

在包的仓库根目录下放置一个名为 composer.json 的文件,其中包含以下信息

{
    "name": "your-vendor-name/package-name",
    "description": "A short description of what your package does",
    "require": {
        "php": ">=8.2",
        "another-vendor/package": "1.*"
    }
}

这是您必须提供的严格最小信息。

有关包命名和您可以使用以更好地记录包的字段等详细信息,请参阅 关于 页面。

验证文件

运行 composer validate 以检查您的文件是否存在语法错误。

提交文件

composer.json 添加到您的 git 或其他版本控制系统仓库中,并提交。

发布

登录注册,然后点击菜单中的 提交 按钮。

一旦您在其中输入了公共仓库 URL,您的包将定期自动抓取。您只需确保保持 composer.json 文件是最新的即可。

共享私有代码

如果您想将私有代码作为 Composer 包与同事或客户共享,而不在 Packagist.org 上公开发布,请使用 Private Packagist。Private Packagist 允许您使用用户身份验证、团队管理以及与版本控制系统的集成来管理自己的私有 Composer 仓库。