arpadhegedus / utility
日常PHP开发中的实用类
Requires (Dev)
- cvuorinen/phpdoc-markdown-public: 0.2.0
- phpdocumentor/phpdocumentor: 2.9
- phpunit/phpunit: ^8.3.3
README
目录
- 数组
- 链
- 收集
- 函数
- 地理
- 其他
- 数字
- 对象
- 字符串
- 遵守
- 遵守任何
- 添加
- dd
- 转储
- 合并
- 获取浅类型
- 一致
- 字母
- 字母数字
- 追加
- ASCII
- 在
- base64
- 介于
- 布尔
- 骆驼
- 字符
- 清理
- 折叠
- 公共
- 公共前缀
- 公共后缀
- 包含
- 包含所有
- 包含任何
- 计数
- 破折号
- 分隔符
- 以...结束
- 以...结束任何
- 确保左
- 确保右
- 文件大小
- 第一个
- HTML解码
- HTML编码
- 索引
- 索引
- 插入
- 字母
- 字母数字
- base64
- 空白
- 电子邮件
- 十六进制
- HTML
- IP
- JSON
- 小写
- 正则表达式
- 序列化
- 大写
- URL
- 最后一个
- 最后索引
- 长度
- 限制
- 限制单词
- 行
- 小写
- 小写首字母
- 匹配
- 归一化
- 序数
- 填充
- 两边填充
- 左填充
- 右填充
- 帕斯卡
- 预置
- 随机
- 正则表达式替换
- 移除
- 左移除
- 右移除
- 重复
- 替换
- 反转
- 洗牌
- 切片
- 短划线
- 短划线化
- 蛇形
- 空格转制表符
- 分割
- 以...开始
- 以...开始任何
- 字符串替换
- 删除空格
- 子串
- 制表符转空格
- 模板
- 次数包含
- 标题
- 大写化
- 修剪
- 左修剪
- 右修剪
- 下划线
- 大写
- 大写首字母
- 单词
- URL
数组
- 全名: \Utility\Arr
- 父类: \Utility\Collection
获取
通过分隔符表示法以默认值回退获取 $collection 的 $key 值。
Arr::get( array|object $collection, string $key = '', mixed $default = null, string $separator = '.' ): mixed
- 此方法为 静态。 参数:
分组
根据 $callback 的结果从 $collection 中分组值。
Arr::group( array|object $collection, callable $callback ): array
- 此方法为 静态。 参数:
键
从 $collection 中获取键。
Arr::keys( array|object $collection ): array
- 此方法为 静态。 参数:
移除
使用分隔符表示法从 $collection 中删除 $key 值。
Arr::remove( array|object $collection, string|array $key, string $separator = '.' ): array|object
- 此方法为 静态。 参数:
设置
使用分隔符表示法在 $collection 中设置 $value。
Arr::set( array|object $collection, string $key, mixed $value, string $separator = '.' ): array|object
- 此方法为 静态。 参数:
排序
按值、闭包或按属性 $sorter 在 $direction 上排序 $collection。
Arr::sort( array|object $collection, string $direction = 'ASC', null|callable|string $sorter = null ): array|object
- 此方法为 静态。 参数:
按键排序
按键或属性按 $direction 排序 $collection。
Arr::sortKeys( array|object $collection, string $direction = 'ASC' ): array|object
- 此方法为 静态。 参数:
值
从 $collection 中获取值。
Arr::values( array|object $collection ): array
- 此方法为 静态。 参数:
遵守
检查 $data 是否遵守 $rules 的数组。
Arr::abides( mixed $data, array|callable $rules = array() ): boolean
- 此方法为 静态。 参数:
遵守任何
检查 $data 是否遵守 $rules 的数组中的任何一项。
Arr::abidesAny( mixed $data, string|array|callable $rules = array() ): boolean
- 此方法为 静态。 参数:
添加
巧妙地将混合 $data 添加到其他混合数据中。
Arr::add( mixed $data ): mixed
- 此方法为 静态。 参数:
dd
输出 $data 并终止。
Arr::dd( mixed $data ): void
- 此方法为 静态。 参数:
转储
用于调试的干燥输出 $data。
Arr::dump( mixed $data ): void
- 此方法为 静态。 参数:
合并
巧妙地将混合 $data 合并到其他混合数据中。
Arr::merge( mixed $data ): mixed
- 此方法为 静态。 参数:
获取浅类型
获取变量的简化类型。
Arr::getShallowType( mixed $data ): string
返回值:字符串|数组|对象|数字|布尔值|未知
- 此方法为 静态。 参数:
追加
将 $value 追加到 $array 中。
Arr::append( array $array, mixed $value ): array
- 此方法为 静态。 参数:
平均
获取 $array 的平均值。
Arr::average( array $array, integer $decimals ): float
- 此方法为 静态。 参数:
蓝图
从 $ruleset 蓝图和回退 $defaults 构建数组。
Arr::blueprint( array $array, array $ruleset, array $defaults = array() ): array
- 此方法为 静态。 参数:
清理
从数组中清除所有假值。
Arr::clean( array $array, boolean $normalize = true ): array
- 此方法为 静态。 参数:
包含
检查 $value 是否在 $array 中。
Arr::contains( array $array, mixed $value ): boolean
- 此方法为 静态。 参数:
包含所有
检查 $array 是否包含所有 $values。
Arr::containsAll( array $array, array $values ): boolean
- 此方法为 静态。 参数:
包含任何
检查 $array 是否包含 $values 中的任何值。
Arr::containsAny( array $array, array $values ): boolean
- 此方法为 静态。 参数:
除以
将 $array 划分为两个数组,第一个包含键,第二个包含值。
Arr::divide( array $array ): array
- 此方法为 静态。 参数:
点
使用分隔符表示法展平多维 $array。
Arr::dot( array $array, string $separator = '.', null|string $parent = null ): array
- 此方法为 静态。 参数:
每个
遍历 $array 并通过 $callback 函数修改数组值。
Arr::each( array $array, callable $callback, boolean $passKey = false ): array
- 此方法为 静态。 参数:
过滤
查找 $array 中通过 $callback 真值测试的所有项目。
Arr::filter( array $array, callable $callback, string|integer $pass = 'value', boolean $normalize = false ): array
- 此方法为 静态。 参数:
找到
查找通过 $callback 真值测试的第一个 $array 项。
Arr::find( array $array, callable $callback, boolean $passKey = false ): void|mixed
- 此方法为 静态。 参数:
找到所有
查找 $array 中通过 $callback 真值测试的所有项目。
Arr::findAll( array $array, callable $callback, boolean $passKey ): array
- 此方法为 静态。 参数:
第一个
从 $array 中获取前 $number 个值。
Arr::first( array $array, integer $number = 1 ): mixed
- 此方法为 静态。 参数:
压平
将多维 $array 展平为一维数组。
Arr::flatten( array $array, boolean $preserveKeys = true ): array
- 此方法为 静态。 参数:
有
检查 $array 是否有 $key。
Arr::has( array $array, integer|string $key ): boolean
- 此方法为 静态。 参数:
有所有
检查 $array 是否有所有 $keys。
Arr::hasAll( array $array, array $keys ): boolean
- 此方法为 静态。 参数:
有任何
检查 $array 是否有任何 $keys。
Arr::hasAny( array $array, array $keys ): boolean
- 此方法为 静态。 参数:
连接
压缩 $array。
Arr::implode( array $array, string $glue = '' ): string
- 此方法为 静态。 参数:
初始
获取除了最后 $number 个项之外的所有项。
Arr::initial( array $array, integer $number = 1 ): mixed
- 此方法为 静态。 参数:
交集
返回 $a 和 $b 输入数组中找到的所有元素。
Arr::intersection( array $a, array $b ): array
- 此方法为 静态。 参数:
相交
返回 $a 和 $b 输入数组是否相交。
Arr::intersects( array $a, array $b ): boolean
- 此方法为 静态。 参数:
关联
检查 $array 是否是关联数组。
Arr::isAssoc( array $array ): boolean
- 此方法为 静态。 参数:
数字
检查 $array 是否只有数字键。
Arr::isNumeric( array $array ): boolean
- 此方法为 静态。 参数:
顺序
检查 $array 是否是数字顺序数组。
Arr::isSequential( array $array ): boolean
- 此方法为 静态。 参数:
最后一个
从 $array 中获取最后 $number 个值。
Arr::last( array $array, integer $number = 1 ): mixed
- 此方法为 静态。 参数:
映射
在 $array 的所有值上调用 $callback 函数。
Arr::map( array $array, callable $callback, array $arguments = array() ): array
- 此方法为 静态。 参数:
递归映射
递归地在 $array 的所有值上调用 $vallbackfunction。
Arr::mapRecursive( array $array, callable $callback ): array
- 此方法为 静态。 参数:
匹配
检查 $array 中的所有项是否匹配 $callback 真值测试。
Arr::matches( array $array, callable $callback ): boolean
- 此方法为 静态。 参数:
匹配任何
检查 $array 中的任何项是否匹配 $callback 真值测试。
Arr::matchesAny( array $array, callable $callback ): boolean
- 此方法为 静态。 参数:
最大
获取 $array 的最大值。
Arr::max( array $array, null|callable $callback = null ): mixed
- 此方法为 静态。 参数:
最小
获取 $array 的最小值。
Arr::min( array $array, null|callable $callback = null ): mixed
- 此方法为 静态。 参数:
归一化
通过排序和填充缺失的键来规范化 $array。
Arr::normalize( array $array ): array
- 此方法为 静态。 参数:
预置
使用 $value 预先设置 $array。
Arr::prepend( array $array, mixed $value ): array
- 此方法为 静态。 参数:
摘取
从关联数组数组中获取按 $key 的值。
Arr::pluck( array $array, mixed $key, boolean $preserveKeys = true, boolean $keepEmpty = false ): array
- 此方法为 静态。 参数:
随机
从 $array 中获取 $number 个随机值。
Arr::random( array $array, integer $number = 1 ): mixed
- 此方法为 静态。 参数:
范围
从 $base 到 $stop 生成一个数组,步长为 $step。
Arr::range( integer $base, integer $stop = null, integer $step = 1 ): array
- 此方法为 静态。 参数:
拒绝
返回 $array 中所有未通过 $callback 真值测试的项目。
Arr::reject( array $array, callable $callback, boolean $passKey = false, boolean $normalize = false ): array
- 此方法为 静态。 参数:
移除第一个
从 $array 中移除第一个项。
Arr::removeFirst( array $array ): array
- 此方法为 静态。 参数:
移除最后一个
从数组中移除最后一个项。
Arr::removeLast( array $array ): array
- 此方法为 静态。 参数:
移除值
从 $array 中移除 $value。
Arr::removeValue( array $array, mixed $value, boolean $normalize = true ): array
- 此方法为 静态。 参数:
重复
使用一些 $data 填充数组 $times 次。
Arr::repeat( mixed $data, integer $times ): array
- 此方法为 静态。 参数:
替换
在 $array 中将每个 $search 单词或模式替换为 $replacement。
Arr::replace( array $array, string $search, string $replacement ): array
- 此方法为 静态。 参数:
剩余
获取 $array 的最后 $number 个项。
Arr::rest( array $array, integer $number = 1 ): mixed
- 此方法为 静态。 参数:
反转
反转 $array。
Arr::reverse( array $array ): array
- 此方法为 静态。 参数:
搜索
在数组中搜索值的索引。
Arr::search( array $array, mixed $value ): array
- 此方法为 静态。 参数:
大小
获取数组的尺寸。
Arr::size( array $array ): integer
- 此方法为 静态。 参数:
点号
使用分隔符表示法取消展平之前展平的 $array。
Arr::undot( array $array, string $separator = '.' ): array
- 此方法为 静态。 参数:
唯一
从数组中删除重复项。
Arr::unique( array $array ): array
- 此方法为 静态。 参数:
无
返回一个不包含某些值的所有实例的数组。
Arr::without( array $array, mixed $values ): array
- 此方法为 静态。 参数:
链
- 全名:\Utility\Chain
__构造
开始一个新的链。
Chain::__construct( mixed $subject, string|object $class )
参数
中断
中断链并返回主题。
Chain::break( ): mixed
交换
沿着链路交换实用工具类
Chain::swap( string|object $class ): void
参数
__调用
将方法调用调度到实用工具类,并将主题作为第一个参数传递
Chain::__call( string $method, array $arguments ): void
参数
开始
开始一个新的链。
Chain::start( mixed $subject, string|object $class ): void
- 此方法为 静态。 参数:
收集
- 全名:\Utility\Collection
- 父类:\Utility\Misc
遵守
检查 $data 是否遵守 $rules 的数组。
Collection::abides( mixed $data, array|callable $rules = array() ): boolean
- 此方法为 静态。 参数:
遵守任何
检查 $data 是否遵守 $rules 的数组中的任何一项。
Collection::abidesAny( mixed $data, string|array|callable $rules = array() ): boolean
- 此方法为 静态。 参数:
添加
巧妙地将混合 $data 添加到其他混合数据中。
Collection::add( mixed $data ): mixed
- 此方法为 静态。 参数:
dd
输出 $data 并终止。
Collection::dd( mixed $data ): void
- 此方法为 静态。 参数:
转储
用于调试的干燥输出 $data。
Collection::dump( mixed $data ): void
- 此方法为 静态。 参数:
合并
巧妙地将混合 $data 合并到其他混合数据中。
Collection::merge( mixed $data ): mixed
- 此方法为 静态。 参数:
获取浅类型
获取变量的简化类型。
Collection::getShallowType( mixed $data ): string
返回值:字符串|数组|对象|数字|布尔值|未知
- 此方法为 静态。 参数:
获取
通过分隔符表示法以默认值回退获取 $collection 的 $key 值。
Collection::get( array|object $collection, string $key = '', mixed $default = null, string $separator = '.' ): mixed
- 此方法为 静态。 参数:
分组
根据 $callback 的结果从 $collection 中分组值。
Collection::group( array|object $collection, callable $callback ): array
- 此方法为 静态。 参数:
键
从 $collection 中获取键。
Collection::keys( array|object $collection ): array
- 此方法为 静态。 参数:
移除
使用分隔符表示法从 $collection 中删除 $key 值。
Collection::remove( array|object $collection, string|array $key, string $separator = '.' ): array|object
- 此方法为 静态。 参数:
设置
使用分隔符表示法在 $collection 中设置 $value。
Collection::set( array|object $collection, string $key, mixed $value, string $separator = '.' ): array|object
- 此方法为 静态。 参数:
排序
按值、闭包或按属性 $sorter 在 $direction 上排序 $collection。
Collection::sort( array|object $collection, string $direction = 'ASC', null|callable|string $sorter = null ): array|object
- 此方法为 静态。 参数:
按键排序
按键或属性按 $direction 排序 $collection。
Collection::sortKeys( array|object $collection, string $direction = 'ASC' ): array|object
- 此方法为 静态。 参数:
值
从 $collection 中获取值。
Collection::values( array|object $collection ): array
- 此方法为 静态。 参数:
函数
- 全名:\Utility\Func
缓存
缓存函数的返回值,并在后续调用中从缓存中返回值
Func::cache( callable $function ): void
- 此方法为 静态。 参数:
调用
调用带有$arguments的$function,无论它是引用数组、字符串还是匿名函数
Func::call( null|callable $function, array $arguments = array() ): mixed
- 此方法为 静态。 参数:
一次
限制$function只能调用一次
Func::once( callable $function, boolean $unique = false ): void
- 此方法为 静态。 参数:
仅
限制$function只能调用一定次数的$times
Func::only( callable $function, integer $times = 1, boolean $unique = false ): void
- 此方法为 静态。 参数:
节流
节流$function,使其在每$miliseconds只能调用一次
Func::throttle( callable $function, integer $miliseconds = 300 ): void
- 此方法为 静态。 参数:
地理
- 全名:\Utility\Geo
地址
从地址获取经纬度数据
Geo::address( string $address, array $apiParameters = array() ): null|string
- 此方法为 静态。 参数:
地址距离
计算两对经纬度值之间的距离
Geo::addressDistance( string $address1, string $address2, array $apiParameters = array(), string $unit = 'M' ): float
- 此方法为 静态。 参数:
距离
以不同的单位获取两对经纬度值之间的距离
Geo::distance( float $lat1, float $lng1, float $lat2, float $lng2, string $unit = 'M' ): null|string
- 此方法为 静态。 参数:
获取地址
从地址获取地理数据
Geo::getAddress( string $address, array $apiParameters = array() )
- 此方法为 静态。 参数:
获取距离
计算两对经纬度值之间的距离
Geo::getDistance( float $lat1, float $lng1, float $lat2, float $lng2 ): array
- 此方法为 静态。 参数:
其他
- 全名:\Utility\Misc
遵守
检查 $data 是否遵守 $rules 的数组。
Misc::abides( mixed $data, array|callable $rules = array() ): boolean
- 此方法为 静态。 参数:
遵守任何
检查 $data 是否遵守 $rules 的数组中的任何一项。
Misc::abidesAny( mixed $data, string|array|callable $rules = array() ): boolean
- 此方法为 静态。 参数:
添加
巧妙地将混合 $data 添加到其他混合数据中。
Misc::add( mixed $data ): mixed
- 此方法为 静态。 参数:
dd
输出 $data 并终止。
Misc::dd( mixed $data ): void
- 此方法为 静态。 参数:
转储
用于调试的干燥输出 $data。
Misc::dump( mixed $data ): void
- 此方法为 静态。 参数:
合并
巧妙地将混合 $data 合并到其他混合数据中。
Misc::merge( mixed $data ): mixed
- 此方法为 静态。 参数:
获取浅类型
获取变量的简化类型。
Misc::getShallowType( mixed $data ): string
返回值:字符串|数组|对象|数字|布尔值|未知
- 此方法为 静态。 参数:
数字
- 全名:\Utility\Num
- 父类:\Utility\Misc
遵守
检查 $data 是否遵守 $rules 的数组。
Num::abides( mixed $data, array|callable $rules = array() ): boolean
- 此方法为 静态。 参数:
遵守任何
检查 $data 是否遵守 $rules 的数组中的任何一项。
Num::abidesAny( mixed $data, string|array|callable $rules = array() ): boolean
- 此方法为 静态。 参数:
添加
巧妙地将混合 $data 添加到其他混合数据中。
Num::add( mixed $data ): mixed
- 此方法为 静态。 参数:
dd
输出 $data 并终止。
Num::dd( mixed $data ): void
- 此方法为 静态。 参数:
转储
用于调试的干燥输出 $data。
Num::dump( mixed $data ): void
- 此方法为 静态。 参数:
合并
巧妙地将混合 $data 合并到其他混合数据中。
Num::merge( mixed $data ): mixed
- 此方法为 静态。 参数:
获取浅类型
获取变量的简化类型。
Num::getShallowType( mixed $data ): string
返回值:字符串|数组|对象|数字|布尔值|未知
- 此方法为 静态。 参数:
一致
解析$number的$plural或$singular或$none模板
Num::accord( float $number, string $plural, string $singular, string $none = '' ): string
- 此方法为 静态。 参数:
文件大小
从$bytes获取文件大小
Num::fileSize( float $bytes, integer $decimals ): string
- 此方法为 静态。 参数:
格式
格式化$number
Num::format( float $number, integer $decimals, \Utility\string $decimalPoint = '.', \Utility\string $thousandSeparator = ',' ): string
- 此方法为 静态。 参数:
介于
检查$number是否在$min和$max之间
Num::isBetween( float $number, float $min, float $max = 1 ): boolean
- 此方法为 静态。 参数:
偶数
检查一个$number是否为偶数
Num::isEven( float $number ): boolean
- 此方法为 静态。 参数:
负数
检查一个$number是否为负数
Num::isNegative( float $number ): boolean
- 此方法为 静态。 参数:
奇数
检查一个$number是否为奇数
Num::isOdd( float $number ): boolean
- 此方法为 静态。 参数:
外部
检查一个$number是否在$min和$max之外
Num::isOutside( float $number, float $min, float $max = 1 ): boolean
- 此方法为 静态。 参数:
正数
检查一个$number是否为正数
Num::isPositive( float $number, boolean $zeroIncluded = false ): boolean
- 此方法为 静态。 参数:
限制
限制$number在$min和$max值之间
Num::limit( float $number, float $min, float $max = 1 ): float
- 此方法为 静态。 参数:
最大
限制$number在$max值之间
Num::max( float $number, float $max ): float
- 此方法为 静态。 参数:
最小
限制$number在$min值之间
Num::min( float $number, float $min ): float
- 此方法为 静态。 参数:
序数
使用$template获取$number的序数形式
Num::ordinal( float $number, string $template = '%number<sup>%ordinal</sup>' ): string
- 此方法为 静态。 参数:
填充
使用$pad从$direction将$number填充到$length
Num::pad( float $number, integer $length, string $pad = '0', string $direction = 'left' ): string
- 此方法为 静态。 参数:
百分比
检查$number相对于$normal的百分比
Num::percentOf( float $number, float $normal = 100 ): float
- 此方法为 静态。 参数:
对象
- 全名:\Utility\Obj
- 父类: \Utility\Collection
获取
通过分隔符表示法以默认值回退获取 $collection 的 $key 值。
Obj::get( array|object $collection, string $key = '', mixed $default = null, string $separator = '.' ): mixed
- 此方法为 静态。 参数:
分组
根据 $callback 的结果从 $collection 中分组值。
Obj::group( array|object $collection, callable $callback ): array
- 此方法为 静态。 参数:
键
从 $collection 中获取键。
Obj::keys( array|object $collection ): array
- 此方法为 静态。 参数:
移除
使用分隔符表示法从 $collection 中删除 $key 值。
Obj::remove( array|object $collection, string|array $key, string $separator = '.' ): array|object
- 此方法为 静态。 参数:
设置
使用分隔符表示法在 $collection 中设置 $value。
Obj::set( array|object $collection, string $key, mixed $value, string $separator = '.' ): array|object
- 此方法为 静态。 参数:
排序
按值、闭包或按属性 $sorter 在 $direction 上排序 $collection。
Obj::sort( array|object $collection, string $direction = 'ASC', null|callable|string $sorter = null ): array|object
- 此方法为 静态。 参数:
按键排序
按键或属性按 $direction 排序 $collection。
Obj::sortKeys( array|object $collection, string $direction = 'ASC' ): array|object
- 此方法为 静态。 参数:
值
从 $collection 中获取值。
Obj::values( array|object $collection ): array
- 此方法为 静态。 参数:
遵守
检查 $data 是否遵守 $rules 的数组。
Obj::abides( mixed $data, array|callable $rules = array() ): boolean
- 此方法为 静态。 参数:
遵守任何
检查 $data 是否遵守 $rules 的数组中的任何一项。
Obj::abidesAny( mixed $data, string|array|callable $rules = array() ): boolean
- 此方法为 静态。 参数:
添加
巧妙地将混合 $data 添加到其他混合数据中。
Obj::add( mixed $data ): mixed
- 此方法为 静态。 参数:
dd
输出 $data 并终止。
Obj::dd( mixed $data ): void
- 此方法为 静态。 参数:
转储
用于调试的干燥输出 $data。
Obj::dump( mixed $data ): void
- 此方法为 静态。 参数:
合并
巧妙地将混合 $data 合并到其他混合数据中。
Obj::merge( mixed $data ): mixed
- 此方法为 静态。 参数:
获取浅类型
获取变量的简化类型。
Obj::getShallowType( mixed $data ): string
返回值:字符串|数组|对象|数字|布尔值|未知
- 此方法为 静态。 参数:
有
检查$object是否有$键(属性或方法)
Obj::has( $object, string $key ): boolean
- 此方法为 静态。 参数:
属性
从$object获取所有属性
Obj::properties( object $object ): array
- 此方法为 静态。 参数:
方法
从$object获取所有方法
Obj::methods( object $object ): null|array
- 此方法为 静态。 参数:
解包
从$object中解包$属性
Obj::unpack( object $data, null|string $attribute = null ): object
- 此方法为 静态。 参数:
字符串
- 全名:\Utility\Str
- 父类:\Utility\Misc
遵守
检查 $data 是否遵守 $rules 的数组。
Str::abides( mixed $data, array|callable $rules = array() ): boolean
- 此方法为 静态。 参数:
遵守任何
检查 $data 是否遵守 $rules 的数组中的任何一项。
Str::abidesAny( mixed $data, string|array|callable $rules = array() ): boolean
- 此方法为 静态。 参数:
添加
巧妙地将混合 $data 添加到其他混合数据中。
Str::add( mixed $data ): mixed
- 此方法为 静态。 参数:
dd
输出 $data 并终止。
Str::dd( mixed $data ): void
- 此方法为 静态。 参数:
转储
用于调试的干燥输出 $data。
Str::dump( mixed $data ): void
- 此方法为 静态。 参数:
合并
巧妙地将混合 $data 合并到其他混合数据中。
Str::merge( mixed $data ): mixed
- 此方法为 静态。 参数:
获取浅类型
获取变量的简化类型。
Str::getShallowType( mixed $data ): string
返回值:字符串|数组|对象|数字|布尔值|未知
- 此方法为 静态。 参数:
一致
根据$number获取复数或单数字符串
Str::accord( string|float $number, string $plural, string $singular, string $none = '' ): string
- 此方法为 静态。 参数:
字母
将字符串转换为alpha
Str::alpha( string $string ): string
- 此方法为 静态。 参数:
字母数字
将字符串转换为alpha numeric
Str::alphaNumeric( string $string ): string
- 此方法为 静态。 参数:
追加
将$append添加到字符串的末尾
Str::append( string $string, string $append ): string
- 此方法为 静态。 参数:
ASCII
将字符串转换为ASCII,删除所有重音符号
Str::ascii( string $string, string $language = 'en', boolean $removeUnsupported = true ): string
- 此方法为 静态。 参数:
在
从字符串中获取指定$index位置的字符
Str::at( string $string, integer $index, null|string $encoding = null ): string
- 此方法为 静态。 参数:
base64
对字符串进行Base 64编码
Str::base64( string $string ): string
- 此方法为 静态。 参数:
介于
获取字符串中位于$start和$end子字符串之间的部分
Str::between( string $string, string $start, string $end, integer $offset, null|string $encoding = null ): string
- 此方法为 静态。 参数:
布尔
将字符串转换为bool
Str::bool( string $string, array $trueValues = array(), array $falseValues = array() ): boolean
- 此方法为 静态。 参数:
骆驼
使用特定$language将字符串转换为camelCase
Str::camel( string $string, string $language = '' ): string
- 此方法为 静态。 参数:
字符
将字符串的所有不同字符作为数组获取
Str::chars( string $string, null|string $encoding = null ): array
- 此方法为 静态。 参数:
清理
规范和修剪字符串
Str::clean( string $string ): string
- 此方法为 静态。 参数:
折叠
确保字符串中的所有空白字符只出现一次
Str::collapse( string $string ): string
- 此方法为 静态。 参数:
公共
从字符串和$otherString中找到一个共同子字符串
Str::common( string $string, string $otherString, null|string $encoding = null ): string
- 此方法为 静态。 参数:
公共前缀
从字符串和$otherString中找到一个共同前缀
Str::commonPrefix( string $string, string $otherString, null|string $encoding = null ): string
- 此方法为 静态。 参数:
公共后缀
从字符串和$otherString中找到一个共同后缀
Str::commonSuffix( string $string, string $otherString, null|string $encoding = null ): string
- 此方法为 静态。 参数:
包含
检查字符串是否包含$needle
Str::contains( string $string, string $needle, boolean $caseSensitive = false, null|string $encoding = null ): boolean
- 此方法为 静态。 参数:
包含所有
检查字符串是否包含数组中的所有子字符串$needles
Str::containsAll( string $string, array $needles, boolean $caseSensitive = false, null|string $encoding = null ): boolean
- 此方法为 静态。 参数:
包含任何
检查字符串是否包含数组中的任何子字符串$needles
Str::containsAny( string $string, array $needles, boolean $caseSensitive = false, null|string $encoding = null ): boolean
- 此方法为 静态。 参数:
计数
计算字符串中的字符数
Str::count( string $string, null|string $encoding = null ): integer
- 此方法为 静态。 参数:
破折号
使用破折号而不是空格划分字符串
Str::dashed( string $string ): string
- 此方法为 静态。 参数:
分隔符
在字符串中使用$delimiter而不是空格连接单词
Str::delimit( string $string, string $delimiter, null|string $encoding = null ): string
- 此方法为 静态。 参数:
以...结束
检查字符串是否以$needle结尾
Str::endsWith( string $string, string $needle, boolean $caseSensitive = false, null|string $encoding = null ): boolean
- 此方法为 静态。 参数:
以...结束任何
检查字符串是否以任何$needles结尾
Str::endsWithAny( string $string, array $needles, boolean $caseSensitive = false, null|string $encoding = null ): boolean
- 此方法为 静态。 参数:
确保左
确保字符串以$ensure开始
Str::ensureLeft( string $string, string $ensure ): string
- 此方法为 静态。 参数:
确保右
确保字符串以$ensure结束
Str::ensureRight( string $string, string $ensure ): string
- 此方法为 静态。 参数:
文件大小
从$bytes返回格式化的文件大小
Str::fileSize( float|string $bytes, integer $decimals ): string
- 此方法为 静态。 参数:
第一个
从字符串中获取前$number个字符
Str::first( string $string, integer $number = 1, null|string $encoding = null ): string
- 此方法为 静态。 参数:
HTML解码
HTML解码字符串
Str::htmlDecode( string $string, string $flags = ENT_COMPAT, null|string $encoding = null ): string
- 此方法为 静态。 参数:
HTML编码
HTML编码字符串
Str::htmlEncode( string $string, string $flags = ENT_COMPAT, null|string $encoding = null ): string
- 此方法为 静态。 参数:
索引
获取$needle在字符串中的位置
Str::index( string $string, string $needle, integer $offset, null|string $encoding = null ): integer
- 此方法为 静态。 参数:
索引
获取字符串中$needle的所有位置
Str::indexes( string $string, string $needle, null|string $encoding = null ): array
- 此方法为 静态。 参数:
插入
在字符串的$index字符位置插入$insert
Str::insert( string $string, string $insert, integer $index, null|string $encoding = null ): string
- 此方法为 静态。 参数:
字母
检查字符串是否为alpha
Str::isAlpha( string $string ): boolean
- 此方法为 静态。 参数:
字母数字
检查字符串是否为alpha numeric
Str::isAlphanumeric( string $string ): boolean
- 此方法为 静态。 参数:
base64
检查字符串是否为Base 64编码
Str::isBase64( string $string ): boolean
- 此方法为 静态。 参数:
空白
检查字符串是否为空或只包含空白
Str::isBlank( string $string ): boolean
- 此方法为 静态。 参数:
电子邮件
检查字符串是否为有效的电子邮件
Str::isEmail( string $string ): boolean
- 此方法为 静态。 参数:
十六进制
检查字符串是否为十六进制
Str::isHexadecimal( string $string ): boolean
- 此方法为 静态。 参数:
HTML
检查字符串是否包含HTML代码
Str::isHTML( string $string ): boolean
- 此方法为 静态。 参数:
IP
检查字符串是否为有效的IP地址
Str::isIP( string $string ): boolean
- 此方法为 静态。 参数:
JSON
检查字符串是否为有效的JSON
Str::isJSON( string $string ): boolean
- 此方法为 静态。 参数:
小写
检查字符串是否为小写
Str::isLower( string $string ): boolean
- 此方法为 静态。 参数:
正则表达式
检查 $string 是否为有效的正则表达式
Str::isRegex( string $pattern ): boolean
- 此方法为 静态。 参数:
序列化
检查 $string 是否已序列化
Str::isSerialized( string $string ): boolean
- 此方法为 静态。 参数:
大写
检查 $string 是否为大写字母
Str::isUpper( string $string ): boolean
- 此方法为 静态。 参数:
URL
检查 $string 是否为有效的 URL
Str::isURL( string $string ): boolean
- 此方法为 静态。 参数:
最后一个
获取 $string 的最后 $number 个字符
Str::last( string $string, integer $number = 1, null|string $encoding = null ): string
- 此方法为 静态。 参数:
最后索引
获取 $needle 在 $string 中的最后位置
Str::lastIndex( string $string, string $needle, integer $offset, null|string $encoding = null ): integer
- 此方法为 静态。 参数:
长度
计算 $string 的长度
Str::length( string $string, null|string $encoding = null ): integer
- 此方法为 静态。 参数:
限制
安全地将 $string 截断到 $length
Str::limit( string $string, integer $length, string $append = '...', null|string $encoding = null ): string
- 此方法为 静态。 参数:
限制单词
限制 $string 中的单词数到 $limit
Str::limitWords( string $string, integer $length, \Utility\string $append = '...' ): string
- 此方法为 静态。 参数:
行
获取 $string 中的行数组
Str::lines( string $string, boolean $trimEachLine = false ): array
- 此方法为 静态。 参数:
小写
将 $string 转换为小写
Str::lower( string $string, null|string $encoding = null ): string
- 此方法为 静态。 参数:
小写首字母
将 $string 中每个单词的首字母转换为小写
Str::lowerFirst( string $string, null|string $encoding = null ): string
- 此方法为 静态。 参数:
匹配
检查 $string 是否与 $pattern 匹配
Str::matches( string $string, string $pattern ): boolean
- 此方法为 静态。 参数:
归一化
将标点符号字符转换为标准化的、更简单的版本
Str::normalize( string $string ): string
- 此方法为 静态。 参数:
序数
根据 $template 将 $number 转换为序数形式
Str::ordinal( string|float $number, string $template = '%number<sup>%ordinal</sup>' ): string
- 此方法为 静态。 参数:
填充
将 $pad 添加到 $string,直到其长度达到 $length
Str::pad( string $string, integer $length, string $pad = ' ', string $direction = 'right', null|string $encoding = null ): string
- 此方法为 静态。 参数:
两边填充
将 $pad 添加到 $string 的两端,直到其长度达到 $length
Str::padBoth( string $string, integer $length, string $pad = ' ', null|string $encoding = null ): string
- 此方法为 静态。 参数:
左填充
将 $pad 添加到 $string 的左侧,直到其长度达到 $length
Str::padLeft( string $string, integer $length, string $pad = ' ', null|string $encoding = null ): string
- 此方法为 静态。 参数:
右填充
将 $pad 添加到 $string 的右侧,直到其长度达到 $length
Str::padRight( string $string, integer $length, string $pad = ' ', null|string $encoding = null ): string
- 此方法为 静态。 参数:
帕斯卡
将 $string 转换为 PascalCase
Str::pascal( string $string ): string
- 此方法为 静态。 参数:
预置
在 $string 的开头添加 $prepend
Str::prepend( string $string, string $prepend ): string
- 此方法为 静态。 参数:
随机
生成随机或可读的随机字符串,长度为 $length
Str::random( integer $length = 10, boolean $readable = true ): string
- 此方法为 静态。 参数:
正则表达式替换
在 $string 中将 $pattern 替换为 $replacement
Str::regexReplace( string $string, string|array $pattern, string|array $replacement ): string
- 此方法为 静态。 参数:
移除
从 $string 中移除 $search 模式
Str::remove( string $string, string $search ): string
- 此方法为 静态。 参数:
左移除
从 $string 的开头移除 $needle
Str::removeLeft( string $string, string $needle, boolean $caseSensitive = false, null|string $encoding = null ): string
- 此方法为 静态。 参数:
右移除
从 $string 的末尾移除 $needle
Str::removeRight( string $string, string $needle, boolean $caseSensitive = false, null|string $encoding = null ): string
- 此方法为 静态。 参数:
重复
重复 $string $次
Str::repeat( string $string, \Utility\int $times ): string
- 此方法为 静态。 参数:
替换
在 $string 中将 $search 字符串替换为 $replacement
Str::replace( string $string, string $search, string $replacement ): string
- 此方法为 静态。 参数:
反转
反转 $string 中的字符
Str::reverse( string $string, null|string $encoding = null ): string
- 此方法为 静态。 参数:
洗牌
随机打乱 $string 中的字符
Str::shuffle( string $string, null|string $encoding = null ): string
- 此方法为 静态。 参数:
切片
从 $start 到 $end 切割 $string
Str::slice( string $string, integer $start, null|integer $end = null, null|string $encoding = null ): string
- 此方法为 静态。 参数:
短划线
将 $string 转换为 slug-case
Str::slug( string $string, string $language = 'en' ): string
- 此方法为 静态。 参数:
短划线化
从 $string 中移除特殊字符,并用 $delimiter 替换空白字符
Str::slugify( string $string, string $delimiter = '-', string $language = 'en' ): string
- 此方法为 静态。 参数:
蛇形
将 $string 转换为 snake_case
Str::snake( string $string, string $language = 'en' ): string
- 此方法为 静态。 参数:
空格转制表符
在 $string 中将空格转换为制表符
Str::spacesToTabs( string $string, integer $tabLength = 4 ): string
- 此方法为 静态。 参数:
分割
在 $pattern 处分割 $string
Str::split( string $string, string $pattern = '', null|integer $limit = null ): array
- 此方法为 静态。 参数:
以...开始
检查 $string 是否以 $needle 开头
Str::startsWith( string $string, string $needle, boolean $caseSensitive = false, null|string $encoding = null ): boolean
- 此方法为 静态。 参数:
以...开始任何
检查 $string 是否以任何 $needles 开头
Str::startsWithAny( string $string, array $needles, boolean $caseSensitive = false, null|string $encoding = null ): boolean
- 此方法为 静态。 参数:
字符串替换
在 $string 中将 $search 替换为 $replacement
Str::stringReplace( string $string, string $search, string $replacement ): string
- 此方法为 静态。 参数:
删除空格
从 $string 中移除所有空白字符
Str::stripWhitespace( string $string ): string
- 此方法为 静态。 参数:
子串
从 $start 到特定长度切割 $string
Str::sub( string $string, integer $start, null|integer $length = null, null|string $encoding = null ): string
- 此方法为 静态。 参数:
制表符转空格
在 $string 中将制表符转换为空格
Str::tabsToSpaces( string $string, $tabLength = 4 ): array
- 此方法为 静态。 参数:
模板
根据关联的 $data 数组在 $string 中替换模板变量
Str::template( string $string, array $data = array(), string $varSymbol = '%' ): string
- 此方法为 静态。 参数:
次数包含
计算 $string 中包含 $needle 的次数
Str::timesContains( string $string, string $needle, boolean $caseSensitive = false, null|string $encoding = null ): integer
- 此方法为 静态。 参数:
标题
将 $string 转换为 Title Case
Str::title( string $string, null|string $encoding = null ): string
- 此方法为 静态。 参数:
大写化
将 $string 转换为 Title Case,同时忽略不会转换为大写的单词列表 $ignore
Str::titlize( string $string, array $ignore = array(), null|string $encoding = null ): string
- 此方法为 静态。 参数:
修剪
从 $string 的两端修剪 $characters
Str::trim( string $string, string $characters = ' ' ): string
- 此方法为 静态。 参数:
左修剪
从 $string 的左侧修剪 $characters
Str::trimLeft( string $string, string $characters = ' ' ): string
- 此方法为 静态。 参数:
右修剪
从 $string 的右侧修剪 $characters
Str::trimRight( string $string, string $characters = ' ' ): string
- 此方法为 静态。 参数:
下划线
在 $string 中将空格替换为 _ (下划线)
Str::underscored( string $string ): string
- 此方法为 静态。 参数:
大写
将字符串转换为 UPPER CASE
Str::upper( string $string, null|string $encoding = null ): string
- 此方法为 静态。 参数:
大写首字母
将 $string 中每个单词的首字母转换为大写
Str::upperFirst( string $string, null|string $encoding = null ): string
- 此方法为 静态。 参数:
单词
从 $string 中获取单词数组
Str::words( string $string, boolean $unique = true ): array
- 此方法为 静态。 参数:
URL
- 全名:\Utility\URL
认证
将 $user 和 $pass 添加到 $url
URL::auth( null|string|array $url, string $user, null|string $pass = null ): string
- 此方法为 静态。 参数:
构建
从解析的数组构建 URL
URL::build( array $url ): string
- 此方法为 静态。 参数:
当前
获取当前 URL 或其 $parts
URL::current( array $parts = array() ): string
- 此方法为 静态。 参数:
片段
获取或设置 $url 的片段
URL::fragment( null|string|array $url, null|string $set = null ): string
- 此方法为 静态。 参数:
片段设置
设置 $url 的片段部分
URL::fragmentSet( null|string|array $url, string $fragment ): string
- 此方法为 静态。 参数:
主机
获取或设置 $url 的主机
URL::host( null|string|array $url, null|string $set = null ): string
- 此方法为 静态。 参数:
主机设置
设置 $url 的主机部分
URL::hostSet( null|string|array $url, string $host ): string
- 此方法为 静态。 参数:
解析
一致地解析 $url
URL::parse( string $url ): array
- 此方法为 静态。 参数:
部分
获取 $url 的部分
URL::parts( null|string|array $url, $parts = array('scheme', 'host', 'path') ): string
- 此方法为 静态。 参数:
密码
获取 $url 的密码部分
URL::pass( null|string|array $url ): string
- 此方法为 静态。 参数:
路径
获取或设置 $url 的路径
URL::path( null|string|array $url, null|string $set = null ): string
- 此方法为 静态。 参数:
路径移除
从 $url 路径中移除 $search 字符串或模式
URL::pathRemove( null|string|array $url, \Utility\string $search ): string
- 此方法为 静态。 参数:
路径设置
设置 $url 的路径部分
URL::pathSet( null|string|array $url, null|string $path ): string
- 此方法为 静态。 参数:
端口
获取或设置 $url 的端口号
URL::port( null|string|array $url, boolean $set = false ): string
- 此方法为 静态。 参数:
端口设置
设置 $url 的端口号部分
URL::portSet( null|string|array $url, string|integer $port ): string
- 此方法为 静态。 参数:
查询
获取或设置 $url 的查询
URL::query( null|string|array $url, boolean $set = false ): string
- 此方法为 静态。 参数:
查询添加
将参数 $key 和 $value 添加到 $url 的查询中
URL::queryAdd( null|string|array $url, string $key, mixed $value ): string
- 此方法为 静态。 参数:
查询数组
从 $url 中获取查询参数数组
URL::queryArray( null|string|array $url ): array
- 此方法为 静态。 参数:
查询获取
从 URL 中获取查询参数
URL::queryGet( null|string|array $url, string $parameter ): string|null
- 此方法为 静态。 参数:
查询移除
通过 $key 从 $url 查询中移除参数
URL::queryRemove( null|string|array $url, $keys ): string
- 此方法为 静态。 参数:
查询设置
将 $url 路径部分设置为 $data
URL::querySet( null|string|array $url, string|array $data ): string
- 此方法为 静态。 参数:
方案
获取或设置 $url 的方案
URL::scheme( null|string|array $url, null|string $set = null ): string
- 此方法为 静态。 参数:
方案设置
设置 $url 的方案部分
URL::schemeSet( null|string|array $url, null|string $scheme ): string
- 此方法为 静态。 参数:
用户
获取 $url 的用户部分
URL::user( null|string|array $url, null|string $set = null ): string
- 此方法为 静态。 参数:
本文件于2019-08-07自动从源代码注释生成,使用了phpDocumentor和cvuorinen/phpdoc-markdown-public