README

允许在 Yii2 模型之间转换嵌套 JSON 数据结构。

允许将属性名称与 JSON 字段名称进行匹配
允许创建嵌套对象
允许定义用户自定义函数来转换属性值从/到 JSON

示例

/**
 * Пример модели телефона
 */
class Phone extends hap\json\JsonEntity 
{
    /** @var ?int номер телефона */
    public $number;

    /**
     * {@inheritDoc}
     * Пользовательские функции для конвертирования некоторых аттрибутов в JSON
     */
    public function attributesToJson() : array
    {
        return [        
            // конвертируем в формат +X (XXX) XXX-XX-XX при выводе в JSON
            'number' => function($val) : ?string {
                return empty($val) ? null : Formatter::asPhone($val); // null не выводится в JSON
            }
        ];
    }

    /**
     * {@inheritDoc}
     * Пользовательские функции для конвертирования некоторых аттрибутов из JSON.
     */
    public function attributesFromJson() : array
    {
        return [
            // конвертируем телефон в int
            'number' => function($val) : ?int
            {
                return empty($val) ? null : (int)$val;
            }  
        ];   
    }
}

/**
 * Пример модели пользователя.
 */
class Customer extends hap\json\JsonEntity
{
    /** @var ?string */
    public $fio;

    /** @var ?Phone один мобильный телефон */
    public $cellular;

    /** @var Phone[]|null рабочие телефоны */
    public $workPhones;

    /**
     * {@inheritDoc}
     * Пример переопределения названий аттрибутов и полей JSON
     */
    public function attributeFields() : array
    {
        return [
            'fio'   => 'name',
            'workPhones' => 'work_phones'
        ];    
    }

    /**
     * {@inheritDoc}
     * Пример определения типов моделей вложенных аттрибутов.
     */ 
    public function attributeEntities() : array
    {
        return [
            'cellular' => Phone::class,     // одна модель
            'workPhones' => [Phone::class]  // массив моделей
        ];
    }

    /**
     * {@inheritDoc}
     * Пример валидации вложенных аттрибутов
     */
    public function rules() : array
    {
        return [
            ['cellular', 'default'],
            ['cellular', EntityValidator::class, 'class' => Phone::class],

            // пример валидации массива вложенных объектов
            ['workPhones', 'default'],
            ['workPhones', EntityValidator::class, 'class' => [Phone::class]],
        ];    
    }
}

模型使用的 JSON 示例

{
    "name": "Иван Васильевич",            // будет загружен в fio
    "cellular": {                         // будет конвертирован в Phone
        "number": "+7 (123) 456-78-93"    // будет конвертирован в int
    },
    "work_phones": [                      // будет загружен в workPhones[2]
        {
            "number": ""                  // пустое значение null
        },
        {
            "number": "123-45-67"         // будет конвертирован в (int)1234567
        }
    ]
}

使用示例

// создаем модель и загружаем из JSON
$customer = new Customer([
    'json' => Json::decode($string)
]);

// выводим в JSON
echo Json::encode($customer->json);

orhant / hap-json

维护者

详细信息

README