PHPackages hehex/hehep-hformat - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. hehex/hehep-hformat ActiveLibrary[Utility & Helpers](/categories/utility) hehex/hehep-hformat =================== hehep-hformat 是一个PHP格式器基础组件,对数据列的集中处理,减少foreach 循环的编写,可通过自定义方法,满足不同场景以及业务需求,比如状态id转对应名称,http 的转换,统计量,json 字符串转数组等等,重用代码，并节省大量遍历处理的时间,支持多个格式器,支持直接使用格式器,支持添加自定义格式器 v1.0.0(1y ago)07Apache-2.0PHPPHP >=7.1 Since Aug 31Pushed 10mo ago1 watchersCompare [ Source](https://github.com/chinahehex/hehep-hformat)[ Packagist](https://packagist.org/packages/hehex/hehep-hformat)[ RSS](/packages/hehex-hehep-hformat/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependenciesVersions (2)Used By (0) hehep-hformat ============= [](#hehep-hformat) 介绍 -- [](#介绍) > hehep-hformat 是一个PHP 格式器工具组件,对数据列的集中处理,减少foreach 循环的编写,可通过自定义方法,满足不同场景以及业务需求 > 比如状态id转对应名称,http 的转换,统计量,json 字符串转数组等等,重用代码，并节省大量遍历处理的时间 > 支持多个格式器 > 支持直接使用格式器 > 支持添加自定义格式器 概念理解 ---- [](#概念理解) > 格式器: 将数据格式化成指定的格式 > 格式器集合器: 将多个格式器组合成一个集合,方便使用 > 格式化规则：将数据列与格式器关联起来，形成固定的格式 > 格式管理器:对外提供格式化相关功能，比如:创建格式器,注册格式器,注册格式化集合器,数据格式化 > 字典数据源: 二维数组或数据库数据,如:\[ \['id'=>1,'name'=>'正常'\] \] 安装 -- [](#安装) - **gitee下载**: ``` git clone git@gitee.com:chinahehex/hehep-hformat.git ``` - **github下载**: ``` git clone git@github.com:chinahehex/hehep-hformat.git ``` - 命令安装： ``` composer require hehex/hehep-hformat ``` 组件配置 ---- [](#组件配置) ``` $config = [ // 自定义格式器集合 'formatCollectors'=>[ // 加载组件默认格式器集合 'hehe\core\hformat\formators\CommonFormator', // 加载框架默认格式器集合 'hehe\extend\formators\CommonFormator', ], ]; ``` 基本示例 ---- [](#基本示例) ### 格式化规则格式 [](#格式化规则格式) > \['规则名称',\[\['格式器1','格式器1属性1'=>'','格式1属性2'=>''\],\['格式器2','格式器2属性1'=>'','格式器2属性2'=>''\] \],'格式规则属性1'=>'','格式规则属性2'=>''\], > 比如:\['ctime',\[\['date','params'=>\['Y年m月d日 H:i'\]\],\['trim'\],'alias'=>'created\_time' \]\] > 格式化规则属性: > name:规则名称 > alias:别名,即新的键名,指定新键名,"status\_xxxx\_name",":\_text2" 冒号表示原始键名,比如"status\_text2" > defval:如格式器无对应值,则为默认值 > dataid:数据id键名,如未设置,则默认读取"规则名称"name - 定义字典数据源 ``` // 数据源定义 class UserData { public static function showStatus():array { return [ ['id'=>1,'name'=>'正常'], ['id'=>2,'name'=>'禁用'], ['id'=>3,'name'=>'注销'], ]; } public function totalAdminNewsNum(array $ids) { return [ ['id'=>1,'hit_num'=>10,'buy_num'=>20], ['id'=>2,'hit_num'=>10,'buy_num'=>25], ['id'=>3,'hit_num'=>11,'buy_num'=>21], ]; } public function getRoles(array $ids) { return [ ['id'=>1,'roleName'=>'超级管理员'], ['id'=>2,'roleName'=>'管理员'], ['id'=>3,'roleName'=>'普通用户'], ]; } } ``` ### 格式化示例 [](#格式化示例) ``` use hehe\core\hformat\Formation; use UserData; // 数据定义,一般从数据库获取 $users = [ ['id'=>1,'name'=>'hehe1','status'=>1,'ctime'=>'2018-01-01 12:00:00','roleId'=>1,'headPortrait'=>'a/b/c1.jpg'], ['id'=>2,'name'=>'hehe2','status'=>2,'ctime'=>'2018-01-01 12:00:00','roleId'=>2,'headPortrait'=>'a/b/c2.jpg'], ]; // 创建字典数据来源对象 $userData = new UserData(); // 创建格式化管理器 $hformat = new Formation(); // 格式化"$users"数据 $data = $hformat->doFormat($users,[ // 状态数值转状态文本 ['status',[['dict','data'=> [UserData::class,'showStatus'],'args'=>[] ]], 'alias'=>':_text' ], // 日期转换 ['ctime',[['date','params'=>['Y年m月d日 H:i'] ]] ], // 头像短地址转长地址(http) ['headPortrait',[['trim'],['res']], 'alias'=>':_url' ], // 统计访问量,统计购买量 ['hit_num',[['dict','name'=>'hit_num','data'=>[$userData, 'totalAdminNewsNum'],'args'=>[] ]],'dataid'=>'id','alias'=>'hit_num'], ['buy_num',[['dict','name'=>'buy_num','data'=>[$userData, 'totalAdminNewsNum'],'args'=>[] ]],'dataid'=>'id','alias'=>'buy_num'], // 角色ID值转角色名称 ['roleId',[['dict','name'=>'roleName','data'=>[$userData, 'getRoles'],'args'=>[] ]], 'alias'=>'roleName_text'] ]); // 输出数据 $data = [ ['id'=>1,'name'=>'hehe1','status'=>1,'ctime'=>'2018年01月01日 12:00','roleId'=>1,'headPortrait'=>'a/b/c1.jpg', 'status_text'=>'正常','roleName_text'=>'超级管理员','headPortrait_url'=>'http://www.hehex.com/a/b/c1.jpg','hit_num'=>10,'buy_num'=>20], ['id'=>2,'name'=>'hehe2','status'=>1,'ctime'=>'2018年01月01日 12:00','roleId'=>2,'headPortrait'=>'a/b/c1.jpg', 'status_text'=>'禁用','roleName_text'=>'管理员','headPortrait_url'=>'http://www.hehex.com/a/b/c2.jpg','hit_num'=>10,'buy_num'=>21], ]; ``` ### 格式器直接使用 [](#格式器直接使用) ``` use hehe\core\hformat\Formation; $hformat = new Formation(); $str_json = $hformat->jsonEncode(["id"=>1,'name'=>'hehe']); $arr = $hformat->jsonDecode($str_json); $value = $hformat->trim(' hehex '); $date = $hformat->date('2000-01-01','Y年m月d日'); // 字典数据 $data = [ ['id'=>1,'name'=>'hehe1'], ['id'=>2,'name'=>'hehe2'], ['id'=>3,'name'=>'hehe3'], ]; $name = $hformat->createFormator('dict')->setData($data)->getValue(1); // $name = 'hehe1' $name = $this->hformat->dict()->setData($data)->getValue(2); // $name = 'hehe2' ``` 扩展格式器 ----- [](#扩展格式器) > 基类: hehe\\core\\hformat\\base\\Formator, 格式器类必须继承该基类,并实现`getValue`方法 > 格式器属性: > alias:格式器别名,默认为方法名,如:`trim` > params:格式器方法参数,方法:date($value,$format = 'Y-m-d'),格式:\['date','params'=>\['Y-m-d'\]\] ### 格式器定义 [](#格式器定义) ``` namespace hehe\core\hformat\formators; use hehe\core\hformat\base\Formator; // 日期格式器 class DateFormator extends Formator { // 安装格式器 public static function install() { return [ 'date'=>static::class // 'date'=>['class'=>static::class,'属性1'=>'','属性2'=>'',] ]; } protected $format = 'Y-m-d'; // 格式化数据入口 public function getValue(...$params) { return $this->formatDate(...$params); } protected function formatDate(string $value,string $format = '') { if ($format === '') { $format = $this->format; } return date($format,strtotime($value)); } } ``` ### 格式化集合器定义 [](#格式化集合器定义) > 集合器中定义的格式器方法名必须带后缀"Formator",如:trimFormator > 属性: > alias:格式器别名,默认为方法名,如:`trim` > params:格式器方法参数,如:date($value,$format = 'Y-m-d'),参数必须放在数组中,如:\['date','params'=>\['Y-m-d'\]\] > 格式器注册格式如下: > 类静态方法方式:common\\extend\\formats\\CustomFormats@@res > 对象方法方式:common\\extend\\formats\\CustomFormats@res > 数组函数方式:\['对象','方法名'\] > 闭包方式:function($value){return $value;} - 定义格式化集合器 ``` class CommonFormator { // 安装格式器 public static function install() { return [ 'ltrim'=>static::class . '@@ltrim', //'ltrim'=>[static::class,'ltrim'] ]; } public static function ltrim($value) { return ltrim($value); } // 方法名后缀为"Formator"作为格式器,默认别名为:trim public static function trimFormator($value) { return trim($value); } // 方法名后缀为"Formator"作为格式器,默认别名为:toArr public static function toArrFormator($value) { if (!empty($value) && is_string($value)) { $value = explode(',',$value); } return $value; } // 方法名后缀为"Formator"作为格式器,默认别名为:jsonDecode public static function jsonDecodeFormator($value) { return json_decode($value,true); } // 方法名后缀为"Formator"作为格式器,默认别名为:jsonEncode public static function jsonEncodeFormator($value) { return json_encode($value,true); } } ``` ### 注册格式器 [](#注册格式器) ``` use hehe\core\hformat\Formation; // 注册格式器 Formation::addFormator(DateFormator::class,'date'); Formation::addFormatCollectors(DateFormator::class); Formation::install(DateFormator::class); // 注册格式化集合器 Formation::addFormatCollectors(CommonFormator::class); Formation::install(CommonFormator::class); ``` 格式化模型 ----- [](#格式化模型) > 格式化模型即是事先定义好格式化规则,然后通过格式化模型进行数据格式化 > 格式化模型规则:与常规"格式化规则"一致,但支持通过isdef属性设置是否为默认规则,默认规则必执行 ### 定义格式化模型 [](#定义格式化模型) ``` class UserFormat { public static function defaultFormat() { // 字典数据来源 $user = new UserData(); return [ // 状态值转换 ['status',[ ['dict','data'=>[UserData::class,'showStatus'] ]],'isdef'=>true,'alias'=>':Text'], ['ctime',[['date','params'=>['Y年m月d日 H:i']]],'isdef'=>true ], // 头像图片http 转换 ['headPortrait',[ ['res'] ],'isdef'=>true,'alias'=>'headPortraitUrl'], // 统计访问量,统计购买量 ['hit_num',[['dict','name'=>'hit_num','data'=>[$user, 'totalAdminNewsNum']]],'dataid'=>'id'], ['buy_num',[['dict','name'=>'buy_num','data'=>[$user, 'totalAdminNewsNum']]],'dataid'=>'id'], // 角色数值转角色名称 ['roleId',[ ['dict','name'=>'roleName','data'=>[$user, 'getRoles']] ],'isdef'=>true,'alias'=>'roleName_text'] ]; } } ``` ### 格式化模型示例 [](#格式化模型示例) ``` use hehe\core\hformat\Formation; $users = [ ['id'=>1,'name'=>'hehe1','status'=>1,'ctime'=>'2018-01-01 12:00:00','roleId'=>1,'headPortrait'=>'/a/b/c1.jpg'], ['id'=>2,'name'=>'hehe2','status'=>2,'ctime'=>'2018-01-01 12:00:00','roleId'=>2,'headPortrait'=>'/a/b/c2.jpg'], ]; $hformat = new Formation(); $data = $hformat->doFormat($users,UserFormat::defaultFormat(),['hit_num']); // $data = $hformat->doFormat($users,UserFormat::defaultFormat(),['hit_num','ctime'=>['alias'=>':Text']]); // 输出数据 $data = [ ['id'=>1,'name'=>'hehe1','status'=>1,'ctime'=>'2018年01月01日 12:00','roleId'=>1,'headPortrait'=>'a/b/c1.jpg', 'status_text'=>'正常','roleName_text'=>'超级管理员','headPortrait_url'=>'http://www.hehex.com/a/b/c1.jpg','hit_num'=>10], ['id'=>2,'name'=>'hehe2','status'=>1,'ctime'=>'2018年01月01日 12:00','roleId'=>2,'headPortrait'=>'a/b/c1.jpg', 'status_text'=>'禁用','roleName_text'=>'管理员','headPortrait_url'=>'http://www.hehex.com/a/b/c2.jpg','hit_num'=>10], ]; ``` 字典格式器 ----- [](#字典格式器) > 基类: `hehe\core\hformat\base\DictFormator`, 字典格式器类必须继承此基类 > 可重写获取字典数据方法`buildData(Rule $rule,array $datas)`方法 > 字典格式器属性: > id:字典数据id,如:1 > name:字典数据名称,如:admin > cache:缓存key,如果两个规则设置了相同的缓存key,则只读取一次字典数据,避免重复读取 > data:获取字典数据方法,方法第一个参数是从数据中获取的id(dataid)集合,格式:\['类名获对象','方法'\] > 返回数据格式:\[ \['id'=>1,'name'=>'超级管理员'\], \['id'=>2,'name'=>'管理员'\] \] > args:字典数据方法参数,如:\['args'=>\['Y-m-d'\]\] - 定义字典数据源 ``` class UserData { public static function showStatus():array { return [ ['id'=>1,'name'=>'正常'], ['id'=>2,'name'=>'禁用'], ['id'=>3,'name'=>'注销'], ]; } public function totalAdminNewsNum(array $ids) { return [ ['id'=>1,'hit_num'=>10,'buy_num'=>20], ['id'=>2,'hit_num'=>10,'buy_num'=>25], ['id'=>3,'hit_num'=>11,'buy_num'=>21], ]; } /** * @param array $ids 数据id集合 * @param bool $effective 是否读取有效角色 * @return array[] */ public function getRoles(array $ids,bool $effective = false) { return [ ['id'=>1,'roleName'=>'超级管理员'], ['id'=>2,'roleName'=>'管理员'], ['id'=>3,'roleName'=>'普通用户'], ]; } } ``` - 示例代码 ``` use hehe\core\hformat\Formation; use UserData; // 数据定义,一般从数据库获取 $users = [ ['id'=>1,'name'=>'hehe1','status'=>1,'roleId'=>1], ['id'=>2,'name'=>'hehe2','status'=>2,'roleId'=>2], ]; // 创建字典数据来源对象 $userData = new UserData(); // 创建格式化管理器 $hformat = new Formation(); // 格式化"$users"数据 $data = $hformat->doFormat($users,[ // 状态数值转状态文本 ['status',[['dict','data'=> [UserData::class,'showStatus'] ]], 'alias'=>':_text' ], // 统计访问量,统计购买量 ['hit_num',[['dict','name'=>'hit_num','data'=>[$userData, 'totalAdminNewsNum'] ]],'dataid'=>'id','alias'=>'hit_num'], ['buy_num',[['dict','name'=>'buy_num','data'=>[$userData, 'totalAdminNewsNum']]],'dataid'=>'id','alias'=>'buy_num'], // 角色ID值转角色名称 ['roleId',[['dict','name'=>'roleName','data'=>[$userData, 'getRoles'],'args'=>[true] ]], 'alias'=>'roleName_text'] ]); // 输出数据 $data = [ ['id'=>1,'name'=>'hehe1','status'=>1,'roleId'=>1, 'status_text'=>'正常','roleName_text'=>'超级管理员','hit_num'=>10,'buy_num'=>20], ['id'=>2,'name'=>'hehe2','status'=>1, 'status_text'=>'禁用','roleName_text'=>'管理员','hit_num'=>10,'buy_num'=>21], ]; ``` 安装格式器 ----- [](#安装格式器) - 安装单个格式器 ``` use hehe\core\hformat\Formation; Formation::install(DateFormator::class); ``` - 安装格式化集合器 ``` use hehe\core\hformat\Formation; Formation::install(CommonFormator::class); ``` - 安装指定格式器类同目录下所有格式器 ``` use hehe\core\hformat\Formation; Formation::install(CommonFormator::class,true); Formation::install(DateFormator::class,true); ``` - 安装指定格式器类同级目录以及其子目录下所有格式器 ``` use hehe\core\hformat\Formation; Formation::install(CommonFormator::class,true,true); Formation::install(DateFormator::class,true,true); ``` - 安装指定后缀的验证器(默认前缀Formator) ``` use hehe\core\hformat\Formation; Formation::install(DateFormator::class,true,false,'Formator'); ``` 注解格式器 ----- [](#注解格式器) > 类名: `hehe\core\hformat\annotation\AnnFormator` > 注解: `@AnnFormator`, `@AnnFormator("别名")` - 注解常规格式器 ``` use hehe\core\hformat\annotation\AnnFormator; use \hehe\core\hformat\base\Formator; /** * @AnnFormator("uri") */ class UrlFormator extends Formator { public function getValue(...$params) { return $this->formatUri(...$params); } protected function formatUri(string $url) { // 生成URL地址 return $url; } } ``` - 注解格式化集合器 ``` use hehe\core\hformat\annotation\AnnFormator; /** * @AnnFormator() */ class CommonFormator { // 方法名后缀为"Formator"作为格式器,默认别名为:toArr public static function toArrFormator($value) { if (!empty($value) && is_string($value)) { $value = explode(',',$value); } return $value; } } ``` - 注解格式化集合器方法 ``` use hehe\core\hformat\annotation\AnnFormator; class CommonFormator { /** * @AnnFormator("toArr") */ public static function toArrFormator($value) { if (!empty($value) && is_string($value)) { $value = explode(',',$value); } return $value; } /** * @AnnFormator() */ public static function uriFormator(string $url) { // URL生成 return $url; } } ``` 默认格式器 ----- [](#默认格式器) 格式器说明规则示例`int`强制整型`['name', ['int'] ]``float`浮点型`['name', ['float'] ]``jsonEncode`数组json`['name', ['jsonEncode'] ]``jsonDecode`json字符串转数组`['name', ['jsonDecode'] ]``date`日期格式`['name', ['date','params'=>['Y-m-d']] ]``toArr`字符串转数组`['name', ['toArr'] ]``trim`字符串去掉两边空格`['name', ['trim'] ]``dict`字典数组列值转换`['name', ['dict','id'=>'','name'=>''] ]` ### Health Score 24 — LowBetter than 32% of packages Maintenance45 Moderate activity, may be stable Popularity4 Limited adoption so far Community7 Small or concentrated contributor base Maturity34 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 617d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/fef1cea3ff1614a44fc4060212c8e03e14511610ae5482351a80a3b9f6d28e97?d=identicon)[chinahehex](/maintainers/chinahehex) --- Top Contributors [![139hehe](https://avatars.githubusercontent.com/u/42648391?v=4)](https://github.com/139hehe "139hehe (13 commits)") ### Embed Badge ![Health badge](/badges/hehex-hehep-hformat/health.svg) ``` [![Health](https://phpackages.com/badges/hehex-hehep-hformat/health.svg)](https://phpackages.com/packages/hehex-hehep-hformat) ``` ### Alternatives [components/mathjs Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser with support for symbolic computation, comes with a large set of built-in functions and constants, and offers an integrated solution to work with different data types like numbers, big numbers, complex numbers, fractions, units, and matrices. 15.0k3.8k](/packages/components-mathjs)[aura/payload-interface An interface package for Domain Payload implementations. 13392.7k4](/packages/aura-payload-interface)[njxqlus/filament-lightbox Lightbox entry for Filament 2054.6k](/packages/njxqlus-filament-lightbox) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)