hxy / php-toolkit
PHP实用工具包
1.0.6
2025-12-30 01:36 UTC
Requires
- php: >=7.4.0
- ext-bcmath: *
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- ext-openssl: *
- ext-redis: *
Requires (Dev)
- phpunit/phpunit: ^9.6
This package is not auto-updated.
Last update: 2025-12-30 01:38:03 UTC
README
介绍
安装教程
php >=7.4.0composer require hxy/php-toolkit
使用说明
- 请参考各个子目录下的
readme.md文件,了解每个子目录的功能和使用方法。
附:目录结构及简单说明
核心目录
src/abstracts- 抽象类库目录(定义通用抽象基类)src/abstracts/AbstractDict.php- 字典抽象类,提供标准的字典实现模板src/abstracts/AbstractDtoEntity.php- 数据传输对象抽象类,继承自AbstractEntitysrc/abstracts/AbstractEntity.php- 实体抽象类,实现Entityable接口src/abstracts/AbstractJo.php- 简单对象抽象类src/abstracts/AbstractMapper.php- 映射器抽象类src/abstracts/AbstractUc.php- 单位换算抽象类src/abstracts/AbstractVoEntity.php- 视图对象实体抽象类src/abstracts/Singleton.php- 单例模式实现类src/abstracts/readme.md- 抽象类库说明文档
src/constant- 常量定义目录(系统常量配置)src/constant/CharConstants.php- 字符常量定义src/constant/HttpConstants.php- HTTP相关常量定义src/constant/TypeConstants.php- 类型常量定义src/constant/readme.md- 常量定义说明文档
src/contract- 接口/契约目录(定义组件交互规范)src/contract/Adapterable.php- 适配器接口src/contract/Arrayable.php- 数组化接口src/contract/Cacheable.php- 缓存接口src/contract/Checkable.php- 检查接口src/contract/Contextable.php- 上下文接口src/contract/Converterable.php- 转换器接口src/contract/Curdable.php- CRUD操作接口src/contract/Dictable.php- 字典接口src/contract/Entityable.php- 实体接口src/contract/Errorable.php- 异常接口src/contract/Eventable.php- 事件接口src/contract/Handlerable.php- 处理接口src/contract/Instanceable.php- 实例接口src/contract/Joable.php- 简单对象接口src/contract/Jsonable.php- JSON化接口src/contract/Listenable.php- 监听接口src/contract/Lockerable.php- 锁接口src/contract/Makeable.php- 工厂接口src/contract/Managerable.php- 管理器接口src/contract/Mapperable.php- 映射器接口src/contract/Notifiable.php- 通知接口src/contract/Payloadable.php- 载荷接口src/contract/Registryable.php- 注册接口src/contract/Singletonable.php- 单例接口src/contract/Stateable.php- 状态接口src/contract/Stdable.php- 标准接口src/contract/Strategyable.php- 策略接口src/contract/Ucable.php- 单位换算接口src/contract/Validatorable.php- 验证器接口src/contract/Verifyable.php- 验证接口src/contract/Vrable.php- 验证规则接口src/contract/readme.md- 接口契约说明文档
src/core- 核心组件目录(项目核心功能实现)src/core/struct/- 结构体子目录src/core/struct/CoordinateStruct.php- 经纬度结构体src/core/struct/SnowflakeStruct.php- 雪花算法结构体src/core/struct/SqlColumnsStruct.php- SQL列结构体src/core/struct/SqlTableColumnsStruct.php- SQL表列结构体
src/core/Curl.php- Curl请求类,提供HTTP请求功能封装src/core/Match.php- 匹配器类,实现模式匹配功能src/core/ObjectId.php- ObjectId生成器类,生成类似MongoDB风格的ObjectIdsrc/core/Snowflake.php- 雪花ID生成器类,实现Twitter雪花算法src/core/Std.php- 标准类,扩展标准stdClass类src/core/Vr.php- 验证规则类,提供灵活的验证规则定义和执行功能src/core/readme.md- 核心组件说明文档
src/dict- 字典定义目录(业务字典映射)src/dict/BoolDict.php- 布尔值字典src/dict/DeleteStateDict.php- 删除状态字典src/dict/EcDict.php- 错误码字典src/dict/EffectiveStateDict.php- 生效状态字典src/dict/EnvDict.php- 运行环境字典src/dict/OperatorDict.php- 运算符字典src/dict/PhpTypeDict.php- PHP数据类型字典src/dict/SexGbDict.php- 性别字典src/dict/StateDIct.php- 状态字典src/dict/StdDict.php- 标准字典src/dict/SwitchStateDict.php- 开关状态字典src/dict/SyncStateDict.php- 同步状态字典src/dict/readme.md- 字典定义说明文档
src/entity- 实体类目录(数据传输/展示模型)src/entity/AggregatePo.php- 聚合PO实体,用于存储聚合数据src/entity/ApiResponseVo.php- API响应数据VO实体,标准化的API响应数据视图对象src/entity/PageDto.php- 分页DTO实体,用于分页查询的数据传输对象src/entity/PageVo.php- 分页VO实体,分页结果的视图对象src/entity/RateLimiterDto.php- 限流器DTO实体src/entity/readme.md- 实体类说明文档
src/error- 异常处理目录(系统异常定义)src/error/AbsException.php- 抽象异常类src/error/BusinessException.php- 业务异常类src/error/CacheException.php- 缓存异常类src/error/DbException.php- 数据库异常类src/error/HttpException.php- HTTP异常类src/error/MacroException.php- 宏异常类src/error/RateLimitException.php- 限流异常类src/error/SystemException.php- 系统异常类src/error/ThirdException.php- 第三方服务异常类src/error/readme.md- 异常处理说明文档
src/stdlib- 标准库目录(基础数据结构实现)src/stdlib/HashMap.php- HashMap结构类,提供键值对映射的数据结构src/stdlib/HashMapGroup.php- HashMap分组结构类,提供基于指定键进行分组的HashMap结构src/stdlib/HashMapSet.php- HashMapSet结构类,提供键到唯一值集合的映射结构src/stdlib/readme.md- 标准库说明文档
src/support- 支持组件目录(业务支持工具)src/support/Counter.php- 计数器类,提供简单的计数功能src/support/HttpHeaders.php- HTTP头信息处理类src/support/LapTimer.php- 分阶段计时器类src/support/LengthUc.php- 长度单位换算工具类src/support/RateLimiter.php- 限流器类,基于Redis实现src/support/Timer.php- 计时器类src/support/Tree.php- 树形结构工具类,提供树形结构的生成、平铺和子节点查找功能src/support/Type.php- 类型转换工具类src/support/VolumeUc.php- 体积单位换算工具类src/support/WeightUc.php- 重量单位换算工具类src/support/readme.md- 支持组件说明文档
src/traits- 特性目录(可复用代码片段)src/traits/ErrorsTrait.php- 错误处理特性src/traits/InitTrait.php- 初始化特性src/traits/InstanceTrait.php- 实例特性src/traits/MacroTrait.php- 宏特性src/traits/PropertyTrait.php- 属性特性src/traits/ToArrayTrait.php- 转数组特性src/traits/ToJsonTrait.php- 转JSON特性src/traits/VrExecTrait.php- 验证规则执行特性src/traits/readme.md- 特性说明文档
src/utils- 工具类目录(通用工具函数)src/utils/Abort.php- 中止工具类src/utils/Arr.php- 数组工具类src/utils/Bean.php- Bean工具类src/utils/Closure.php- 闭包工具类src/utils/Crypt.php- 加密工具类src/utils/Datetime.php- 日期时间工具类src/utils/Dd.php- 调试工具类src/utils/Digit.php- 数字工具类src/utils/Encoding.php- 编码工具类src/utils/Extract.php- 提取工具类src/utils/File.php- 文件工具类src/utils/Fmt.php- 格式化工具类src/utils/Ident.php- 标识符工具类src/utils/Is.php- 类型判断工具类src/utils/Json.php- JSON工具类src/utils/LabelValue.php- 标签值工具类src/utils/Math.php- 数学工具类src/utils/Operator.php- 运算符工具类src/utils/Random.php- 随机数工具类src/utils/Ren.php- 命名转换工具类src/utils/Safe.php- 安全工具类src/utils/Sql.php- SQL工具类src/utils/Str.php- 字符串工具类src/utils/readme.md- 工具类说明文档
src/helper.php- 全局辅助函数文件