Tool

<br/> >i 本文档的最新修订日期是: > **2021-07-23** # Tool ## 模块简述 一些实用的小功能。 ## 模块配置 配置文件位于 <font color="#c7254e">`/Config/Tool.php`</font> 。 * **<font color="#ff6600">`HtmlTag`</font>** <font color="#0099ff">`(String)`</font> <font color="#bbbbbb">`...`</font> : 用于指定哪些HTML标签可以被还原。 标签之间用竖线 <font color="#c7254e">`|`</font> 分隔,默认有这些标签可以被还原:<font color="#c7254e">`br`</font> 、<font color="#c7254e">`p`</font> 、<font color="#c7254e">`span`</font> 、<font color="#c7254e">`i`</font> 、<font color="#c7254e">`b`</font> 、<font color="#c7254e">`u`</font> 、<font color="#c7254e">`strong`</font> 、<font color="#c7254e">`h1`</font> 、<font color="#c7254e">`h2`</font> 、<font color="#c7254e">`h3`</font> 、<font color="#c7254e">`h4`</font> 、<font color="#c7254e">`h5`</font> 、<font color="#c7254e">`h6`</font> 、<font color="#c7254e">`hr`</font> 、<font color="#c7254e">`table`</font> 、<font color="#c7254e">`thead`</font> 、<font color="#c7254e">`tbody`</font> 、<font color="#c7254e">`tfoot`</font> 、<font color="#c7254e">`caption`</font> 、<font color="#c7254e">`colgroup`</font> 、<font color="#c7254e">`col`</font> 、<font color="#c7254e">`ul`</font> 、<font color="#c7254e">`ol`</font> 、<font color="#c7254e">`li`</font> 、<font color="#c7254e">`em`</font> 、<font color="#c7254e">`sup`</font> 、<font color="#c7254e">`sub`</font> 、<font color="#c7254e">`tr`</font> 、<font color="#c7254e">`td`</font> 、<font color="#c7254e">`th`</font> 、<font color="#c7254e">`dt`</font> 、<font color="#c7254e">`dd`</font> 、<font color="#c7254e">`dl`</font> 、<font color="#c7254e">`pre`</font> 。 ## :: Random()方法 ### 语法 **<font color="#0099ff"><font color="#ff6600">Tool</font> :: <font color="#ff6600">Random</font> ( <kbd>传参数组</kbd> )</font>** ### 说明 生成一个随机字符串。 此方法 <font color="#c7254e">`支持`</font> 中文参数名。 ### 参数 * **<font color="#ff6600">`mode(模式)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`'AaN'`</font>: 用以指定所生成字符串的字符 <font color="#c7254e">`构成方式`</font> 。 1. 此参数值中含有 <font color="#c7254e">`A`</font> 时,生成的字符串将含有 <font color="#c7254e">`大写`</font> 字母A-Z; 2. 此参数值中含有 <font color="#c7254e">`a`</font> 时,生成的字符串将含有 <font color="#c7254e">`小写`</font> 字母a-z; 2. 此参数值中含有 <font color="#c7254e">`N`</font> 时,生成的字符串将含有 <font color="#c7254e">`数字`</font> 0-9。 * **<font color="#ff6600">`length(长度)`</font>** <font color="#0099ff">`(Int)`</font> <font color="#BBBBBB">`32`</font>: 用以指定随机字符串的 <font color="#c7254e">`长度`</font> 。 ### 返回 <font color="#0099ff">`(String)`</font> 类型。 返回生成的随机字符串。 >d 虽然字符串为随机生成,但仍有 <font color="#c7254e">`极小概率重复`</font> ,因此 <font color="#c7254e">`不要`</font> 直接使用本方法生成UUID。 ## :: Uuid()方法 ### 语法 **<font color="#0099ff"><font color="#ff6600">Tool</font> :: <font color="#ff6600">Uuid</font> ( <kbd>传参数组</kbd> )</font>** ### 说明 生成一个几乎不可能会重复的Uuid。 此方法 <font color="#c7254e">`支持`</font> 中文参数名。 ### 参数 * **<font color="#ff6600">`md5(md5)`</font>** <font color="#0099ff">`(Bool)`</font> <font color="#BBBBBB">`FALSE`</font>: 用以指定是否返回符合MD5加密结果格式的字符串。 ## :: GetHeader()方法 ### 语法 **<font color="#0099ff"><font color="#ff6600">Tool</font> :: <font color="#ff6600">GetHeader</font> ( <kbd>传参数组</kbd> )</font>** ### 说明 获得Header中指定字段的值。 此方法 <font color="#c7254e">`支持`</font> 中文参数名。 ### 参数 * **<font color="#ff6600">`field(字段)`</font>** <font color="#0099ff">`(Array)`</font> <font color="#BBBBBB">`必须`</font>: 用以指定需要获取Header中哪些字段的值。 数组键无需定义,每一个元素的值代表一个需要获取字段的字段名。 ### 返回 <font color="#0099ff">`(Array)`</font> 类型。 由Header中指定字段的值组成的数组,键为字段名,值为Header中对应字段的值。 如果Header中不存在某个指定的字段,那么它 <font color="#c7254e">`不会`</font> 出现在返回的数组中。 ## :: Html()方法 >d 此方法即将计划废弃,将在6.x版本中删除,且不再增添新功能。 ### 语法 **<font color="#0099ff"><font color="#ff6600">Tool</font> :: <font color="#ff6600">Html</font> ( <kbd>传参数组</kbd> )</font>** ### 说明 还原经过 <font color="#c7254e">`Receive`</font> 模块中 <font color="#c7254e">`SafeCheck()`</font> 方法转换的字符串。 此方法 <font color="#c7254e">`支持`</font> 中文参数名。 ### 参数 * **<font color="#ff6600">`string(字符串)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`'AaN'`</font>: 用以指定待还原的字符串。 * **<font color="#ff6600">`tag_other(其它标记)`</font>** <font color="#0099ff">`(String)`</font> <font color="#BBBBBB">`NULL`</font>: 用以指定其它需要被还原的HTML标签。 标签之间用竖线 <font color="#c7254e">`|`</font> 分隔。 * **<font color="#ff6600">`event(事件)`</font>** <font color="#0099ff">`(Bool)`</font> <font color="#BBBBBB">`FALSE`</font>: 用以指定是否允许HTML中的 <font color="#c7254e">`js事件`</font> 。 ### 返回 <font color="#0099ff">`(String)`</font> 类型。 将返回经过还原后的字符串。