1drop/php-utils

镜像概述

本Docker镜像集成了PHP开发全流程所需的多种工具，旨在提供一站式的开发、测试及质量保障环境。通过预装各类工具，简化开发配置流程，确保团队成员及CI/CD系统使用统一工具版本，有效提升PHP项目开发效率与代码质量。

核心功能与特性

包含工具及用途

• phpmd：PHP代码混乱度检测器，识别代码中的不良设计模式与潜在问题
• php-cs-fixer：代码风格自动修复工具，支持PSR标准等主流编码规范
• phpunit：PHP单元测试框架，用于编写和执行单元测试用例
• phpcpd：代码重复检测工具，扫描项目中重复代码片段
• phpstan：静态类型分析工具，在运行前检测类型错误、未定义变量等问题
• phpcs：代码规范检查工具，验证代码是否符合指定编码标准
• xmllint：XML文件验证工具，检查XML语法正确性
• security-checker：依赖安全扫描工具，检测项目依赖中的已知漏洞
• docker：容器化工具客户端，支持在容器内操作Docker服务
• git-lfs：Git大文件存储支持，管理项目中的大型二进制文件

关键特性

• 工具版本统一，避免环境差异导致的兼容性问题
• 轻量级设计，基于官方PHP镜像构建，减少资源占用
• 支持多平台架构，适配主流开发与部署环境

使用场景

适用范围

• 本地开发：快速进行代码质量检查、测试与风格修复，无需本地安装多工具
• CI/CD流程：集成到Jenkins、GitLab CI等系统，自动化执行测试、质量检查与安全扫描
• 团队协作：统一开发工具链，确保代码风格与质量标准一致性

使用方法与配置说明

基本使用命令

1. 执行单元测试（phpunit）

bash
docker run --rm -v $(pwd):/app my-php-tools phpunit /app/tests

• --rm：容器退出后自动清理
• -v $(pwd):/app：挂载当前项目目录到容器内/app目录
• phpunit /app/tests：执行/tests目录下的测试用例

2. 修复代码风格（php-cs-fixer）

bash
docker run --rm -v $(pwd):/app my-php-tools php-cs-fixer fix /app/src --rules=@PSR12

• fix /app/src：修复/src目录代码
• --rules=@PSR12：使用PSR-12编码规范

3. 静态分析（phpstan）

bash
docker run --rm -v $(pwd):/app my-php-tools phpstan analyse /app/src --level=7

• analyse /app/src：分析/src目录代码
• --level=7：设置分析严格级别（1-9，级别越高检查越全面）

4. 代码规范检查（phpcs）

bash
docker run --rm -v $(pwd):/app my-php-tools phpcs /app/src --standard=PSR2

• --standard=PSR2：指定使用PSR-2标准检查

工具配置文件

工具支持通过项目根目录配置文件自定义规则：

• phpcs：phpcs.xml 或 ruleset.xml
• php-cs-fixer：.php-cs-fixer.php 或 .php-cs-fixer.dist.php
• phpstan：phpstan.neon 或 phpstan.neon.dist
• phpunit：phpunit.xml 或 phpunit.xml.dist

配置文件需放置在项目根目录，挂载后工具将自动识别并应用配置。

docker-compose集成示例

yaml
version: '3.8'
services:
  php-tools:
    image: my-php-tools
    volumes:
      - .:/app
      - /var/run/docker.sock:/var/run/docker.sock  # 如需使用docker命令
    working_dir: /app
    command: phpstan analyse src --level=8

注意事项

• 必须挂载项目目录（-v $(pwd):/app）以确保工具访问项目文件
• Windows系统路径需调整为：-v /c/项目路径:/app
• 部分工具（如security-checker）需网络连接获取最新漏洞数据库
• 工具配置文件需与项目代码一同挂载到容器内

典型应用示例

CI/CD集成（GitLab CI）

在.gitlab-ci.yml中添加质量检查阶段：

yaml
code_quality:
  image: my-php-tools
  script:
    - phpcs src --standard=PSR12
    - phpstan analyse src --level=7
    - phpmd src text cleancode,codesize,controversial,design,naming,unusedcode
  artifacts:
    reports:
      codequality: phpcs.xml

本地开发环境配置

创建项目快捷脚本（php-tools.sh）：

bash
#!/bin/bash
docker run --rm -v $(pwd):/app my-php-tools "$@"

赋予执行权限后即可简化命令：

bash
./php-tools.sh php-cs-fixer fix src
./php-tools.sh phpunit tests