phix/contractlib

ContractLib 是一个轻量级的 PHP 库，旨在帮助您通过在代码中强制执行编程约定来编写更健壮的 PHP 组件。

维护者

详细信息

github.com/stuartherbert/ContractLib

主页

源代码

问题

安装: 31,916

依赖项: 2

建议者: 0

安全: 0

星标: 32

关注者: 5

分支: 2

开放问题: 0

2.1.4 2013-06-09 11:51 UTC

Requires

Requires (Dev)

BSD-3-Clause 93f7a623426063f3a13f17a3a940cb80cc9a05b4

This package is not auto-updated.

Last update: 2024-09-24 04:04:42 UTC

README

ContractLib 是一个简单易用的 PHP 组件，可以轻松地在您的 PHP 组件中强制执行编程约定。这些编程约定可以大大帮助您和您的组件用户开发更健壮的代码。

ContractLib 是受微软研究院对 .NET 的代码约定库 的工作的启发。

系统范围安装

应使用 PEAR 安装程序 安装 ContractLib。此安装程序是 PHP 社区安装 PHP 组件的事实标准。

sudo pear channel-discover pear.phix-project.org
sudo pear install --alldeps phix/ContractLib

作为组件的依赖项

如果您正在创建依赖 ContractLib 的组件，请确保将 LicenseLib 添加到您的组件的 package.xml 文件中。

<dependencies>
  <required>
    <package>
      <name>ContractLib</name>
      <channel>pear.phix-project.org</channel>
      <min>1.0.0</min>
      <max>1.999.9999</max>
    </package>
  </required>
</dependencies>

用法

ContractLib 最好的文档是其单元测试，这些测试包含在包中。您将在 PEAR 仓库中找到它们，在 Linux 系统上通常是 /usr/share/php/test。

您还可以在 GitHub 上找到它们：http://github.com/stuartherbert/ContractLib/

开发环境

如果您想修补或增强此组件，您需要创建一个合适的发展环境，通过 安装 phix。

然后，克隆 git 仓库

# ContractLib
git clone git@github.com:stuartherbert/ContractLib.git

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

# build vendor/ folder
phing build-vendor

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

在组件的最高级目录中运行命令 'phing' 以查看可用的所有自动化任务。

许可

有关完整的许可详情，请参阅 LICENSE.txt。