https://github.com/alevikzs/phmap
The PhMap is a library for creating objects from json strings, associative arrays and objects
https://github.com/alevikzs/phmap
apc deserialization phalcon php xcache
Last synced: 3 months ago
JSON representation
The PhMap is a library for creating objects from json strings, associative arrays and objects
- Host: GitHub
- URL: https://github.com/alevikzs/phmap
- Owner: alevikzs
- License: mit
- Created: 2016-01-23T23:50:32.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-03-18T21:20:14.000Z (about 9 years ago)
- Last Synced: 2024-11-16T12:06:41.111Z (over 1 year ago)
- Topics: apc, deserialization, phalcon, php, xcache
- Language: PHP
- Size: 60.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PhMap
[](https://packagist.org/packages/alevikzs/phmap)
[](https://packagist.org/packages/alevikzs/phmap)
[](https://packagist.org/packages/alevikzs/phmap)
[](https://www.versioneye.com/user/projects/56da017bd5a5350029ae5cd8)
[](https://www.versioneye.com/php/alevikzs:phmap/references)
[](https://scrutinizer-ci.com/g/alevikzs/phmap/?branch=master)
[](https://codeclimate.com/github/alevikzs/phmap)
[](https://scrutinizer-ci.com/g/alevikzs/phmap/build-status/master)
[](https://scrutinizer-ci.com/g/alevikzs/phmap/?branch=master)
## About
The PhMap is a PHP package for create objects from JSON strings, associative arrays and objects. The PhMap is
based on [phalcon annotations](https://docs.phalconphp.com/en/latest/reference/annotations.html).
## Requirements
* PHP >= 5.4 && < 7.0;
* [Phalcon framework](https://phalconphp.com) >= 2.0;
* If you will be using [APC](http://php.net/manual/en/book.apc.php) or [XCache](https://xcache.lighttpd.net/) adapters you need to install corresponding PHP extensions.
## Installation
1. Require the package and its dependencies with composer: ```$ composer require alevikzs/phmap```
2. Install [Phalcon framework](https://phalconphp.com). Detail guide is [here](https://phalconphp.com/en/download).
## How to use
```php
class Tree {
private $height;
private $name;
private $branch;
public function getHeight() {
return $this->height;
}
public function setHeight($height) {
$this->height = $height;
}
public function getName() {
return $this->name;
}
public function setName($name) {
$this->name = $name;
}
public function getBranch() {
return $this->branch;
}
/**
* @mapper(class="\Tests\Dummy\Branch")
*/
public function setBranch(Branch $branch) {
$this->branch = $branch;
}
}
```
As you can see, if some property of you object has type of another class - you must declare an annotation ```@mapper```
for setter method of this property. This annotation has two arguments: ```class``` and ```isArray```. The first
argument is a string with the class name and second is a boolean value that indicates your property value is
array or not.
```php
class Branch {
private $length;
private $leaves;
public function getLength() {
return $this->length;
}
public function setLength($length) {
$this->length = $length;
}
public function getLeaves() {
return $this->leaves;
}
/**
* @mapper(class="\Tests\Dummy\Leaf", isArray=true)
*/
public function setLeaves(array $leaves) {
$this->leaves = $leaves;
}
}
class Leaf {
private $height;
private $width;
public function getHeight() {
return $this->height;
}
public function setHeight($height) {
$this->height = $height;
}
public function getWidth() {
return $this->width;
}
public function setWidth($width) {
$this->width = $width;
}
}
```
Create object of Tree class from JSON string:
```php
$result = (new \PhMap\Wrapper\Json($json, 'Tree'))->map();
```
Create object of Tree class from associative array:
```php
$result = (new \PhMap\Mapper\Structure\Associative($array, 'Tree'))->map();
```
Create object of Tree class from another object:
```php
$result = (new \PhMap\Mapper\Structure\Object($object, 'Tree'))->map();
```
You can use ```\PhMap\Mapper\Smart``` if you don't know what type of you value. In this case mapping instructions
will be applied automatically:
```php
$result = (new \PhMap\Wrapper\Smart($value, 'Tree'))->map();
```
By default mapper use [memory adapter](https://docs.phalconphp.com/en/latest/api/Phalcon_Annotations_Adapter_Memory.html),
but also you can use [file adapter](https://docs.phalconphp.com/en/latest/api/Phalcon_Annotations_Adapter_Files.html),
[APC adapter](https://docs.phalconphp.com/en/latest/api/Phalcon_Annotations_Adapter_Apc.html) and
[XCache adapter](https://docs.phalconphp.com/en/latest/api/Phalcon_Annotations_Adapter_Xcache.html):
```php
new \PhMap\Wrapper\Json($json, 'Tree', \PhMap\Mapper::MEMORY_ANNOTATION_ADAPTER);
new \PhMap\Wrapper\Smart($json, 'Tree', \PhMap\Mapper::FILES_ANNOTATION_ADAPTER);
new \PhMap\Mapper\Structure\Associative($array, 'Tree', \PhMap\Mapper::APC_ANNOTATION_ADAPTER);
new \PhMap\Mapper\Structure\Object($object, 'Tree', \PhMap\Mapper::X_CACHE_ANNOTATION_ADAPTER);
```
Also, you can pass already exist object to constructor:
```php
$tree = new Tree();
$result = (new \PhMap\Mapper\Smart($json, $tree))->map();
```
You can reuse mapper object. Just set the necessary properties, and call the method ```map()```:
```php
$mapper = new \PhMap\Mapper\Structure\Object($tree, 'Tree', \PhMap\Mapper::X_CACHE_ANNOTATION_ADAPTER)
$result = $mapper->map();
$mapper->setInputObject($branch)
->setOutputObject(new Branch())
->setAnnotationAdapterType(Mapper::MEMORY_ANNOTATION_ADAPTER);
$result = $mapper->map();
```
Mapper object has ```setTransforms(Transforms $transforms)``` method. The argument of this method is a transforms
object. This object is used to declare a set of rules where each rule indicates what field of input value corresponds
to the output field value:
```php
$mapper = new \PhMap\Mapper\Structure\Object($tree, 'Tree')
$transforms = (new \PhMap\Transforms())
->add(
(new \PhMap\Transform())
->setInputFieldName('nameIn')
->setOutputFieldName('name')
)
->add(
(new \PhMap\Transform())
->setInputFieldName('branchIn')
->setOutputFieldName('branch')
->setTransforms(
(new \PhMap\Transforms())->add(
(new \PhMap\Transform())
->setInputFieldName('leavesIn')
->setOutputFieldName('leaves')
)
)
);
$result = $mapper->setTransforms($transforms)->map();
```
For skipping some attributes and not map them, you can use ```setSkipAttributes(array $attributes)```:
```php
$mapper = new \PhMap\Mapper\Structure\Object($tree, 'Tree')
$attributes = [
'name',
'branch.length'
];
$result = $mapper->setSkipAttributes($attributes)->map();
```
If you want to disable validation you can use ```disableValidation()``` method:
```php
$result = $mapper->disableValidation()->map();
```
If you want your class can map some value to itself you must use MapperTrait in your class declaration:
```php
class Tree {
use \PhMap\MapperTrait;
//other class declaration
}
```
and then you can call ```mapper()``` or ```staticMapper()``` methods:
```php
$tree = new Tree();
$result = $tree->mapper($json)->map();
$result = Tree::staticMapper($json)->map();
```
## The MIT License (MIT)
**Copyright (c) 2016 Alexey Novikov **
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.