README

Component\Core\DebugPrint 是一个易于使用的 PHP 组件，它提供了一个 Debug Print 方法 实现模式，作为一个 接口 和一个 特性。

目录

• 介绍
• 功能
• 要求
• 使用
• 安装
• 测试
• 贡献
• 致谢
• 许可证

介绍

此组件受 Java 编程语言的 java.lang.Object.toString 方法的启发。

Component\Core\DebugPrint 由两个工件组成

1. 接口 FlorianWolters\Component\Core\DebugPrintInterface：表示实现该接口的类为对象提供了 Debug Print 方法。
2. 特性 FlorianWolters\Component\Core\DebugPrintTrait：为对象提供默认的 Debug Print 方法 实现。

功能

• 通过特性 FlorianWolters\Component\Core\DebugPrintTrait 的 toString 方法为对象提供默认的哈希码值实现。下面提供示例参考使用。
• 通过实现接口 FlorianWolters\Component\Core\DebugPrintInterface 创建自定义的哈希码值实现，更精确地说，是实现该接口的公共方法 toString。下面提供示例参考使用。
• 使用静态和动态测试程序测试了工件
  • 使用 PHPUnit 实现了动态组件测试（单元测试和集成测试）。
  • 使用以下工具执行静态代码分析
    • PHP_CodeSniffer：样式检查器
    • PHP Mess Detector (PHPMD)：代码分析器
    • PHP Depend：代码度量
    • phpcpd：复制/粘贴检测器（CPD）
    • phpdcd：死代码检测器（DCD）
    • SensioLabs Security Checker：安全检查器
  • 使用以下网络服务进行持续集成（CI）
    • Scrutinizer CI
    • SensioLabsInsight
    • Coveralls
    • VersionEye
    • 依赖
    • Waffle
• 提供由Packagist管理的软件包，可以使用Composer依赖管理工具进行安装。点击此处访问Packagist上的软件包。
• 提供由文档生成器Sami生成的完整应用程序编程接口（API）文档。点击此处查看API文档。
• 遵循PHP框架互操作性小组（FIG）的以下“标准”。PSR代表PHP标准推荐

  • PSR-0：自动加载标准

    旨在提供标准文件、类和命名空间的约定，以便实现即插即用的代码。

  • PSR-1：基本编码标准

    旨在确保共享PHP代码之间的高技术互操作性。

  • PSR-2：编码风格指南

    为寻求标准化代码的项目提供编码风格指南。

  • PSR-4：自动加载器

    对自动加载进行了更现代的改进，反映了生态系统的发展。

• 遵循语义版本控制（SemVer）规范的第2.0.0版本。

要求

生产

• PHP >= 5.4
• Composer

开发

• PHPUnit
• phpcpd
• phpdcd
• PHP_CodeSniffer
• PHP Mess Detector (PHPMD)
• Sami
• SensioLabs Security Checker
• php-coveralls

安装

Component\Core\DebugPrint应使用依赖管理器Composer进行安装。

Composer是PHP的依赖管理工具。它允许你声明项目需要的依赖库，并为你自动安装它们。

可以使用php下载Composer安装器。

php -r "readfile('https://getcomposer.org.cn/installer');" | php

这将仅检查一些PHP设置，然后将composer.phar下载到你的工作目录。此文件是Composer的二进制文件。它是一个PHAR（PHP存档），它是PHP的存档格式，可以用于命令行，以及其他用途。

要解决和下载依赖项，请运行install命令

php composer.phar install

如果你正在创建一个依赖于Component\Core\DebugPrint的组件，请确保将Component\Core\DebugPrint添加到组件的composer.json文件中

{
    "require": {
        "florianwolters/component-core-debugprint": "0.3.*"
    }
}

使用

\Component\Core\DebugPrint的最佳文档是其单元测试，这些测试包含在软件包中。

最重要的使用规则

如果使用DebugPrintTrait，请始终实现接口DebugPrintInterface，因为这样可以允许类型提示。

可以通过命令php resources/php/DebugPrintExample.php从项目的根目录运行类DebugPrintExample。

默认 调试打印方法

类 DebugPrintDefaultImpl 使用了特质的默认实现 DebugPrintTrait。

自定义 调试打印方法

类 DebugPrintCustomImpl 实现了一个自定义实现，该实现满足 值对象 的设计合同。

测试

phpunit

贡献

有关详细信息，请参阅 CONTRIBUTING。

致谢

• Florian Wolters
• 所有贡献者

许可证

本程序是自由软件：您可以在自由软件基金会发布的GNU较小通用公共许可证的条款下重新分发和/或修改它，许可证版本为3，或者（根据您的选择）任何较新版本。

本程序的分发是希望它会有用，但没有任何保证；甚至没有对适销性或特定用途适用性的暗示保证。有关更多信息，请参阅GNU较小通用公共许可证。

您应该已经随本程序一起收到GNU较小通用公共许可证的一个副本。如果没有，请参阅https://gnu.org/licenses/lgpl.txt。