PHP Dumper 镜像文档

1. 镜像概述和主要用途

PHP Dumper是一款PHP开发调试辅助工具，专注于捕获并格式化展示PHP中常用调试函数dd（dump and die）和dump的输出结果。通过提供清晰、结构化的调试信息展示，帮助开发者快速定位代码问题，简化调试流程，提升PHP开发效率。

2. 核心功能和特性

• 支持主流调试函数：原生兼容PHP生态中广泛使用的dd和dump调试函数，无需修改现有调试代码即可直接使用。
• 输出格式化展示：将原始调试输出转换为可读性更强的格式（如结构化列表、语法高亮、层级展开等），便于快速识别变量类型、数组结构及对象属性。
• 轻量易用：工具本身轻量无冗余依赖，部署和集成流程简单，可快速接入各类PHP项目。
• 开发环境友好：专注于开发阶段调试需求，不干扰生产环境代码运行，确保调试过程安全可控。

3. 使用场景和适用范围

• PHP开发环境：适用于本地开发环境或开发服务器，辅助开发者实时查看调试输出。
• 框架项目调试：特别适配使用dd/dump函数的主流PHP框架（如Laravel、Symfony等），无缝对接框架自带调试能力。
• 代码调试阶段：用于开发过程中变量值检查、数组/对象结构分析、函数返回值验证等调试场景。
• 学与教学场景**：帮助PHP初学者直观理解调试函数输出逻辑，辅助代码分析与学**。

4. 使用方法和配置说明

4.1 基础Docker部署（docker run）

通过以下命令快速启动PHP Dumper容器，挂载PHP项目目录以捕获调试输出：

docker run -d \
  --name php-dumper \
  -v /path/to/your/php/project:/app \  # 挂载本地PHP项目目录到容器内
  -p 8080:80 \  # 映射容器端口（默认80）到本地端口（如8080）
  php-dumper

启动后，访问http://localhost:8080即可查看调试输出界面。

4.2 Docker Compose集成

在现有PHP项目的docker-compose.yml中添加PHP Dumper服务，实现多容器协同调试：

version: '3'
services:
  # 现有PHP应用服务
  php-app:
    image: php:8.2-fpm
    volumes:
      - ./project:/app  # 项目目录挂载
    
  # PHP Dumper服务
  php-dumper:
    image: php-dumper
    ports:
      - "8080:80"
    volumes:
      - ./project:/app  # 共享项目目录以捕获调试输出
    depends_on:
      - php-app  # 确保在PHP应用启动后启动

启动服务：

docker-compose up -d

4.3 配置参数

PHP Dumper支持通过环境变量调整输出行为，常用配置如下：

示例：修改输出格式为纯文本

docker run -d \
  --name php-dumper \
  -v /path/to/your/php/project:/app \
  -e OUTPUT_FORMAT=plain \  # 设置纯文本输出
  -p 8080:80 \
  php-dumper

5. 注意事项

• 环境限制：仅用于开发环境，禁止部署到生产环境。
• 依赖检查：确保PHP项目中已正确调用dd或dump函数，工具将自动捕获其输出。
• 权限配置：容器挂载目录需确保读写权限，避免因权限问题导致输出捕获失败。
• 端口冲突：若本地8080端口被占用，可修改-p参数映射至其他空闲端口（如-p 8081:80）。