API 文档 - ginkgo


ginkgo\Arrays

0.2.0 新增

数组处理,大部分为原 ginkgo\Func 类迁移而来


类摘要

namespace ginkgo;

class Arrays {
    // 属性
    public static $error;

    private static $errType = array(
        JSON_ERROR_DEPTH            => 'Maximum stack depth exceeded',
        JSON_ERROR_STATE_MISMATCH   => 'State mismatch (invalid or malformed JSON)',
        JSON_ERROR_CTRL_CHAR        => 'Control character error, possibly incorrectly encoded',
        JSON_ERROR_SYNTAX           => 'Syntax error',
    );

    // 方法
    public static filter( array $arr [, bool $pop_false = false ] ) : array
    public static each( array $arr [, string $encode ] ) : array
    public static toJson( array $arr [, bool $encode ] ) : string
    public static fromJson( string $json [, bool $assoc = true ] ) : array
    public static getError() : array
}

成员目录

- 权限 类型 描述
属性 - - -
$error public array static 错误消息
$errType protected array static 错误类型
方法 - - -
filter() public static 过滤数组中的重复内容
each() public static 遍历数组
toJson() public static 转换为 JSON
fromJson() public static JSON 转化为数组
getError() public static 获取错误

$errType 错误类型

private static $errType;

结构

名称 类型 描述
JSON_ERROR_DEPTH 预定义常量 JSON 到达了最大堆栈深度
JSON_ERROR_STATE_MISMATCH 预定义常量 无效或异常的 JSON
JSON_ERROR_CTRL_CHAR 预定义常量 JSON 控制字符错误,可能是编码不对
JSON_ERROR_SYNTAX 预定义常量 JSON 语法错误

filter() 过滤数组中的重复内容

public static function filter( array $arr [, bool $pop_false = true ] ) : array

参数

  • arr 数组
  • pop_false 是否去除等值为 FALSE 的条目

返回

  • 过滤后的数组

each() 遍历数组,对键值进行安全过滤,并用指定的方式对键值进行编码

public static function each( array $arr [, string $encode ] ) : array

参数

  • arr 数组
  • encode 编码方式

    可能的值

    描述
    空(默认值) 不进行编码
    urlencode URL 编码
    json_safe 用 JSON 安全的 URL 编码
    md5 md5 编码

返回

  • 处理后的数组

toJson() 转换为 JSON

public static function toJson( array $arr [, bool $encode = false ] ) : string

参数

  • arr 数组
  • encode 编码方式,对待编码的数组用指定的方式对键值进行编码

    可能的值

    描述
    空(默认值) 不进行编码
    urlencode URL 编码
    json_safe 用 JSON 安全的 URL 编码
    md5 md5 编码

返回

  • JSON 编码后的字符串

fromJson() JSON 转化为数组

public static function fromJson( string $json [, bool $assoc = true ] ) : array

参数

  • json JSON 字符串
  • assoc 是否返回 array

    当该参数为 true 时,将返回 array 否则为 object

返回

  • array / object

getError() 获取错误

public static function getError() : array

参数

返回

  • 获取数组处理时产生的错误消息