probiers-us/php-json-property-class

# php-json-property-class

[![CircleCI](https://circleci.com/gh/probiers-us/php-json-property-class.svg?style=shield)](https://circleci.com/gh/probiers-us/php-json-property-class) 
[![Maintainability](https://api.codeclimate.com/v1/badges/fec52ba6feaf8534111f/maintainability)](https://codeclimate.com/github/probiers-us/php-json-property-class/maintainability) 
[![Test Coverage](https://api.codeclimate.com/v1/badges/fec52ba6feaf8534111f/test_coverage)](https://codeclimate.com/github/probiers-us/php-json-property-class/test_coverage)
[![Latest Stable Version](https://poser.pugx.org/probiers-us/php-json-property/v)](//packagist.org/packages/probiers-us/php-json-property) 
[![Latest Unstable Version](https://poser.pugx.org/probiers-us/php-json-property/v/unstable)](//packagist.org/packages/probiers-us/php-json-property) 

## Description
This is a helper to add attributes to an array. This will help,  
if you need to represent JSON entities / classes and resolve recursively when JSON encoding.

## Installation
```
composer require probiers-us/php-json-property
```

## Usage
You can use `JsonPropertyInterface` and `JsonPropertyTrait` in the classes  
you want to add this. Calling `json_encode` will recursively resolve all embedded  
classes in the JSON properties array, leveraging `JsonSerializable`.

### Add a property
```php
$jsonPropertyClass->addJsonProperty('key', 'value');
```

### Add multiple properties
```php
$jsonPropertyClass->addJsonProperties(['key', 'value']);
```

### Remove property
```php
$jsonPropertyClass->removeJsonProperty('key');
```

### Set properties array of class
```php
$jsonPropertyClass->setJsonProperties(['key', 'value']);
```

### Get properties
Get the array without resolving embedded properties
```php
$jsonPropertyClass->getJsonProperties();
```
Get the array of properties and resolve embedded
```php
$jsonPropertyClass->getJsonProperties(true);
```

### Add typed properties
To add typed JSON properties, add a wrapper around e.g. `addJsonProperty`
```php
public function addName(string $name) {
    $this->addJsonProperty('name', $name);
}
```