该事件仅在composer从源安装包时触发,发生在克隆、检出或解压前,用于动态修改源信息、预检依赖兼容性及动态生成源码内容。

这个事件在 Composer 安装或更新包之前触发,但仅限于从源(source)安装时,也就是当包被克隆、检出或解压前执行。它不适用于从 dist(压缩包)安装的场景,这点很关键。
控制源码获取行为
比如你想统一修改某个包的 git 仓库地址、切换分支、或跳过某些子模块拉取,可以在该事件里动态调整 $Event->getOperation()->getPackage() 返回的包对象的 source 信息(如 url、reference、type)。
- 重写私有镜像 URL:把 packagist.org 的源替换成公司内网 Git 地址
- 强制固定 commit:把 dev-master 替换成具体 hash,避免意外更新
- 禁用子模块:设置
"no-dev": true或手动清除source['options']['submodules']
预检依赖兼容性
在真正拉代码前检查当前环境是否满足该包的构建前提,比如 php 扩展、系统命令或最低 Git 版本。
- 检测是否安装了
protoc,否则提前报错,避免下载完再失败 - 验证 PHP 的
mbstring是否启用,不满足就中断安装并提示 - 读取包的
extra.pre-install-check配置,执行自定义校验逻辑
动态生成或替换源码内容
适用于需要在检出前注入配置、打补丁、或替换占位符的场景(注意:不能改 dist 包)。
- 把模板文件里的
{{app_ENV}}替换为当前环境变量值 - 根据
composer.json中的extra.patch-on-source自动应用本地 patch - 生成
VERSION文件,内容来自当前 Git tag 或 CI 变量
基本上就这些。它不是万能钩子,用对时机才能起效——核心记住两点:只作用于 source 安装;发生在任何文件写入磁盘之前。
以上就是Composer 的 pre-package-install 事件可以用来做什么?的详细内容,更多请关注php中文网其它相关文章!