Tool - 84PHP开源框架

>i 本文档的最新修订日期是： > **2022-12-30** # Tool ## 模块简述一些实用的小功能。 ## 依赖本模块依赖于PHP拓展 `cURL` 。 ## :: random()方法 ### 语法 **Tool :: random ( <kbd>传参数组</kbd> )** ### 说明生成一个随机字符串。此方法 `支持` 中文参数名。 ### 参数 * **`mode（模式）`** `(String)` `'AaN'`：用以指定所生成字符串的字符 `构成方式` 。 1. 此参数值中含有 `A` 时，生成的字符串将含有 `大写` 字母A-Z； 2. 此参数值中含有 `a` 时，生成的字符串将含有 `小写` 字母a-z； 2. 此参数值中含有 `N` 时，生成的字符串将含有 `数字` 0-9。 * **`length（长度）`** `(Int)` `32`：用以指定随机字符串的 `长度` 。 ### 返回 `(String)` 类型。返回生成的随机字符串。 >d 虽然字符串为随机生成，但仍有 `极小概率重复` ，因此 `不要` 直接使用本方法生成UUID。 ## :: uuid()方法 ### 语法 **Tool :: uuid ( <kbd>传参数组</kbd> )** ### 说明生成一个几乎不可能会重复的Uuid。此方法 `支持` 中文参数名。 ### 参数 * **`md5（md5）`** `(Bool)` `FALSE`：用以指定是否返回符合MD5加密结果格式的字符串。 ## :: getHeader()方法 ### 语法 **Tool :: getHeader ( <kbd>传参数组</kbd> )** ### 说明获得Header中指定字段的值。此方法 `支持` 中文参数名。 ### 参数 * **`field（字段）`** `(Array)` `必须`：用以指定需要获取Header中哪些字段的值。数组键无需定义，每一个元素的值代表一个需要获取字段的字段名。 ### 返回 `(Array)` 类型。由Header中指定字段的值组成的数组，键为字段名，值为Header中对应字段的值。如果Header中不存在某个指定的字段，那么它 `不会` 出现在返回的数组中。 ## :: send()方法 ### 语法 **Tool :: send ( <kbd>传参数组</kbd> )** ### 说明向目标地址发送数据。此方法 `支持` 中文参数名。 ### 参数 * **`url（地址）`** `(String)` `<必须>`：用以指定向何处发送数据。 * **`mode（模式）`** `(String)` `'GET'`：用以指定以什么方式向远程发送数据。可选的值如下： ``` GET | POST | PUT | DELETE ``` 当值为 `POST` 时，如果传入参数 `data` 的值的类型为数组时，请求的Content-Type为 `multipart/form-data` ，否则为 `application/x-www-form-urlencoded` 。 * **`data（数据）`** `(Array | String)` `[]`：如果值是一个数组，数组的键为字段名，值为字段对应的值。也可传入一个想要发送的请求内容的字符串。 * **`file（文件）`** `(Array)` `[]`：用以指定所发送的文件。传入的数组的键为字段名，值为字段对应的文件的路径。仅在参数 `mode` 的值为 `POST` ，并且参数 `Data` 的值的类型为数组时，本参数才有效。 * **`header（header）`** `(Array)` `[]`：用以指定需要发送的Header头，无需定义键，每一个Header中的字段作为一个元素。 * **`encode（编码）`** `(Bool)` `TRUE`：是否对参数 `data` 的值进行URL编码。当值为 `FALSE` 时，将不会编码；当值为 `TRUE` 时将进行URL编码。当参数 `mode` 的值不为 `GET` ，并且参数 `data` 的值的类型为数组时，本参数无效（将始终进行编码）。 * **`timeout（超时时间）`** `(Int)` `15`：用以指定超时时间。值的单位为秒（s）。 * **`ssl（ssl）`** `(Bool)` `FALSE`：是否进行SSL验证。当值为 `FALSE` 时，将跳过SSL验证，但并不安全；当值为 `TRUE` 时将进行SSL验证。默认进行SSL验证。 ### 返回 `(String | Bool)` 类型。当目标地址对请求响应时，会返回String类型的目标地址的响应。当服务器网络不畅，或目标地址超时响应时，可能返回空字符串或 `FALSE` 。