brandonwamboldt / utilphp
util.php 是一个收集了您每天需要或可能使用的有用函数和代码片段的集合,旨在避免与现有项目冲突
Requires
- php: >=5.3.3
Requires (Dev)
- satooshi/php-coveralls: dev-master
This package is not auto-updated.
Last update: 2024-09-11 11:54:07 UTC
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 是一个社区驱动的项目,接受来自社区的代码和文档贡献。这些贡献以 Issue 或拉取请求的形式提交到 GitHub 上的UtilityPHP 存储库。
问题
- 如果没有已经打开的问题
- 该问题已经修复(检查 develop 分支或查找已关闭的问题)
- 这是否是您自己可以修复的明显问题?
报告问题很有帮助,但更好的方法是发送一个拉取请求,这需要您通过“Fork”主存储库并将提交提交到自己的副本来完成。这需要您使用名为 Git 的版本控制系统。
指南
在我们了解如何做之前,这里有指南。如果您的拉取请求未通过这些指南,它将被拒绝,您需要在做出更改后重新提交。这可能听起来有点严格,但这是为了保持代码库的质量所必需的。
PHP 风格
请确保所有新的贡献都符合PSR-2编码风格指南。
文档
如果您更改了需要更新文档的内容,那么您需要添加相应的更新。新方法、参数、更改默认值、添加常量等,所有这些都需要更新文档。变更日志也必须为每次更改进行更新。此外,必须维护PHPDoc注释。
PHP版本兼容性
UtilityPHP与PHP 5.3.3兼容,因此所有提供的代码都必须满足此要求。
特别需要注意的是避免使用这种简短的数组表示法
$var = [];
请使用旧的表示法
$var = array();
我知道它看起来更丑,但PHP 5.3虽然已经EOL(不再维护),但还不算特别老。
分支
一次一件事:拉取请求应该只包含一个更改。这并不意味着只有一个提交,而是一个更改——不管需要多少个提交。这样做的原因是,如果您同时更改X和Y但发送一个包含两者的拉取请求,我们可能真的想要X,但不同意Y,这意味着我们不能合并请求。使用Git-Flow分支模型,您可以创建用于这两个功能的分支,并发送两个请求。
许可证
UtilPHP采用MIT许可证。