robotdance/php-arguments

方法参数验证的实用工具类。

v0.0.4 2016-06-01 16:45 UTC

This package is not auto-updated.

Last update: 2024-09-14 19:26:00 UTC


README

Code Climate Test Coverage Issue Count

以前是 monochromist/php-arguments

PHP-Arguments 是一个用于参数验证代码的实用工具类。这里没有什么特别之处,只是为需要强制执行参数验证并向使用库的开发者提供更好错误信息的库提供了一些实用方法。

示例

use robotdance/Arguments;
...
public function doSomething($arg1, $arg2, $arg3, $arg4) {
  // string or boolean required
  Arguments::validate($arg1, ['string', 'boolean'];
  // integer required
  Arguments::validate($arg2, ['integer']);
  // not null required
  Arguments::notNull($arg3);
  // check if $arg4 is a string=>any associative array
  Arguments::validateAssociativeArray($arg4);
}

设置

PHP-Arguments 使用 Composer 作为依赖管理器。

$ composer install

您还可以生成文档

$ ./bin/phpdoc -d ./src/ -t ./docs/

测试

$ ./bin/phpunit

贡献

简单地分支,编写您的测试和修改,写一个良好的提交信息,并提交一个拉取请求。所有测试必须通过,覆盖率必须保持在 100%。

参考

PHP 正确的方式