README

FlorianWolters\Component\Core\Comparable 是一个易于使用的 PHP 组件，它对对象施加全序。

简介

本组件受到以下三个 Java 编程语言元素的启发。

Java 平台标准版（SE）中的接口 java.lang.Comparable。
Java 平台 SE 中的接口 java.util.Comparator。
Apache Commons Lang API 中的方法 org.apache.commons.lang3.ObjectUtils.compare。

FlorianWolters\Component\Core\Comparable 由两个元素组成

接口 FlorianWolters\Component\Core\ComparableInterface：对每个实现它的类的对象施加全序。
静态类 FlorianWolters\Component\Core\ComparableUtils：提供对对象施加全序的比较操作。

特性

静态方法 FlorianWolters\Component\Core\ComparableUtils::compare 是 null-安全的。客户端可以确定是否将 null 视为大于非 null 值，或者将 null 视为小于非 null 值。
使用静态和动态测试程序测试了元素
- 使用 PHPUnit 实现的动态组件测试（单元测试）。
- 使用以下工具执行静态代码分析
  - PHP_CodeSniffer：样式检查器
  - PHP Mess Detector (PHPMD)：代码分析器
  - phpcpd：复制/粘贴检测器（CPD）
  - phpdcd：死代码检测器（DCD）
可以通过 Composer 或 PEAR 命令行安装程序安装。
- 提供了一个 Packagist 包，可以使用依赖管理器 Composer 安装。
  
  点击此处查看Packagist上的包。
- 提供了一个 PEAR 包，可以使用包管理器 PEAR 安装程序安装。
  
  点击此处查看PEAR频道。
提供使用文档生成器ApiGen生成的完整的应用程序编程接口（API）文档。

点击此处查看当前的API文档。
遵循PSR-0要求，实现自动加载器的互操作性。
遵循PSR-1基本编码风格指南。
遵循PSR-2编码风格指南。
遵循语义版本规范（SemVer）2.0.0-rc.1。

要求

PHP >= 5.4

用法

FlorianWolters\Component\Core\Comparable的最佳文档是其单元测试，这些测试包含在软件包中。您可以在您的PEAR仓库中找到它们，在Linux系统上通常是/usr/share/php/test。

安装

本地安装

FlorianWolters\Component\Core\Comparable应使用依赖管理器Composer进行安装。您可以使用PHP安装Composer。

php -r "eval('?>'.file_get_contents('http://getcomposer.org/installer'));"

这将只检查一些PHP设置，然后下载composer.phar到您的当前工作目录。此文件是Composer的二进制文件。它是一个PHAR（PHP存档），它是一种PHP存档格式，可以在命令行上运行，等等。

接下来，运行install命令以解决和下载依赖项

php composer.phar install

全局安装

FlorianWolters\Component\Core\Comparable应使用PEAR安装程序进行安装。此安装程序是PHP社区为安装PHP组件的事实标准。

pear channel-discover pear.florianwolters.de
pear install --alldeps fw/Comparable

作为组件的依赖项

Composer

如果您正在创建依赖于FlorianWolters\Component\Core\Comparable的组件，请确保将FlorianWolters\Component\Core\Comparable添加到您的组件的composer.json文件中。

{
    "require": {
        "florianwolters/component-core-comparable": "0.2.*"
    }
}

PEAR

如果您正在创建依赖于FlorianWolters\Component\Core\Comparable的组件，请确保将FlorianWolters\Component\Core\Comparable添加到您的组件的package.xml文件中。

<dependencies>
  <required>
    <package>
      <name>Comparable</name>
      <channel>pear.florianwolters.de</channel>
      <min>0.2.0</min>
      <max>0.2.99</max>
    </package>
  </required>
</dependencies>

开发环境

如果您想修改或增强此组件，您需要创建一个合适的发展环境。最简单的方法是安装phix4componentdev。

# phix4componentdev
pear channel-discover pear.phix-project.org
pear install phix/phix4componentdev

然后，您可以克隆Git仓库

# PHP-Component-Core-Comparable
git clone http://github.com/FlorianWolters/PHP-Component-Core-Comparable

然后，安装此组件依赖项的本地副本以完成开发环境

# build vendor/ folder
phing build-vendor

为了使您的生活更加轻松，使用phing自动化了常见任务（例如运行单元测试、生成代码审查分析和创建PEAR软件包）。您可以在组件提供的build.xml文件中找到自动化步骤。

在组件的顶层文件夹中运行命令phing以查看可用的完整自动化任务列表。

许可证

本程序是免费软件：您可以在自由软件基金会发布的GNU通用公共许可证（第3版或您选择的任何后续版本）的条款下重新分发和/或修改本程序。

本程序的分发是希望它对您有用，但没有任何保证；甚至不保证其适销性或特定用途的适用性。有关详细信息，请参阅GNU通用公共许可证。

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

florianwolters / component-core-comparable

维护者

详细信息