wassafr / utilphp
来自brandonwamboldt/utilphp的表单
Requires
- php: >=5.3.3
Requires (Dev)
- satooshi/php-coveralls: dev-master
README
UtilPHP(又名util.php)是一个集合,包含你每天可能需要或能够使用的有用函数和代码片段。它作为类实现,具有静态方法,以避免与现有代码库冲突。只需将其放入并立即开始使用。
包含55+个函数,使你能够更轻松、更高效地执行常见任务,无需再寻找php.net上的那个注释,知道已经完成。无需检查是否设置特定索引即可访问超全局变量并传递默认值,使用格式化的var dump,验证电子邮件,生成随机字符串,扁平化数组,从多维数组中提取单个列,等等。
尽管实现为一个巨大的类,但util.php具有广泛的文档和完整的单元测试套件,以避免无意中破坏向后兼容性。
发布信息
此存储库包含开发中的代码以及当前稳定分支的未来发布。开发代码包含在develop分支中。
变更日志和新功能
您可以在官方文档中找到每个版本的更改列表
安装
服务器要求
- PHP版本5.3.3或更高。
独立文件
只需将util.php
放入任何项目,并在您的项目中调用include 'util.php';
。然后您就可以访问Util
类。
Composer
将以下依赖项添加到您的composer.json中
"brandonwamboldt/utilphp": "1.0.*"
当与composer一起使用时,类的命名空间为\utilphp\util
,而不是仅仅是util
。
贡献
UtilPHP是一个社区驱动的项目,接受来自社区的代码和文档贡献。这些贡献以问题或拉取请求的形式提交到GitHub上的UtilityPHP存储库。
问题
- 没有已经打开的问题
- 该问题已经解决(检查develop分支或查看已关闭的问题)
- 这是一件非常明显的事情,你可以自己修复它吗?
报告问题是有帮助的,但更好的方法是发送一个拉取请求,这需要你“分支”主存储库并将其提交到自己的副本。这将需要你使用名为Git的版本控制系统。
指南
在了解如何之前,这里有指南。如果您的拉取请求无法通过这些指南,它将被拒绝,您需要在修改后重新提交。这可能听起来有点苛刻,但这是为了保持代码库的质量。
PHP样式
请确保所有新的贡献符合PSR-2编码风格指南。
文档
如果您更改了需要修改文档的内容,则必须添加它。新方法、参数、更改默认值、添加常量等都需要修改文档。变更日志也必须更新每次变更。此外,还必须维护PHPDoc块。
PHP版本兼容性
UtilityPHP与PHP 5.3.3兼容,因此所有提供的代码都必须遵守这一要求。
特别需要注意的是,避免使用如下简短数组表示法:
$var = [];
请使用旧表示法代替。
$var = array();
我知道它看起来更丑,但PHP 5.3虽然已经停止支持,但还不算特别老。
分支
一次只做一件事:拉取请求应仅包含一个更改。这并不意味着只有一个提交,而是一个更改——不管需要多少次提交。这样做的原因是,如果您同时更改X和Y并提交一个包含这两个更改的拉取请求,我们可能确实需要X,但对Y有异议,这意味着我们无法合并请求。使用Git-Flow分支模型,您可以创建用于这两个功能的分支并提交两个请求。
许可证
UtilPHP采用MIT许可证。