ronanchilvers / utility
PHP项目的实用工具类
Requires
- php: ^8.0
Requires (Dev)
README
该包旨在提供一组类和方法,帮助处理PHP项目中常见的任务。
安装
composer require ronanchilvers/utility
用法
Str
- 字符串处理
Str
类提供了一些处理字符串的有用方法。
Str::plural($string, $count = 1, $plural = false)
将字符串转换为复数形式。提供一个单数词和计数,plural()
会在适当的情况下将其转换为复数。如果是一个不容易复数的奇数词,您可以提供一个作为第三个参数的复数。
Str::singular($string, $count = 1, $singular = false)
将复数字符串转换为单数形式。提供一个复数词和可选计数,singular()
将尽力将其转换为单数。如果转换错误,您可以传递一个显式的单数作为第三个参数。
Str::pascal($string, $allowed = [])
将字符串转换为PascalCase。默认情况下,该方法将移除除a-z和0-9之外的所有字符。如果您想保留其他字符,请将它们作为字符串数组传递给$allowed
参数。
Str::camel($string, $allowed = [])
将字符串转换为camelCase。此方法返回的结果与pascal()
相同,但返回字符串的第一个字符是小写的。
Str::snake($string, $allowed = [])
将字符串转换为snake_case。与pascal()
一样,此方法移除除a-z和0-9之外的所有字符。您可以使用第二个参数$allowed
传递一个要保留的额外字符数组。
Str::truncate($string, $length, $suffix = '...', $words = false)
将字符串截断到指定长度。默认情况下,字符串后跟省略号(…
),但您可以通过传递一个后缀字符串来更改此操作($suffix
)。此外,truncate()
将忽略单词边界来分割字符串。如果您想尊重单词,请将true
作为第四个参数$words
传递。
Str::token($length = 64)
生成指定长度的随机字符串令牌。
Str::bool($string)
确定字符串表示的是真还是假。
测试
实用工具类非常简单,因此有100%的测试覆盖率。您可以通过以下方式运行测试:
./vendor/bin/phpunit
默认的phpunit.xml.dist文件在build/coverage子目录中创建覆盖率信息。
贡献
如果您有任何要贡献的补丁,我将非常乐意审查它们。请发起一个PR。您应该
- 遵循PSR2
- 保持100%的测试覆盖率或给出您不这样做的原因
- 遵循每个pull request一个功能的规则
许可
本软件采用MIT许可。有关更多信息,请参阅许可文件。