README

About

The PhMap is a PHP package for create objects from JSON strings, associative arrays and objects. The PhMap is based on phalcon annotations.

Requirements

PHP >= 5.4 && < 7.0;
Phalcon framework >= 2.0;
If you will be using APC or XCache adapters you need to install corresponding PHP extensions.

Installation

Require the package and its dependencies with composer: $ composer require alevikzs/phmap
Install Phalcon framework. Detail guide is here.

How to use

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.

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:

$result = (new \PhMap\Wrapper\Json($json, 'Tree'))->map();

Create object of Tree class from associative array:

$result = (new \PhMap\Mapper\Structure\Associative($array, 'Tree'))->map();

Create object of Tree class from another object:

$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:

$result = (new \PhMap\Wrapper\Smart($value, 'Tree'))->map();

By default mapper use memory adapter, but also you can use file adapter, APC adapter and XCache adapter:

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:

$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():

$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:

$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):

$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:

$result = $mapper->disableValidation()->map();

If you want your class can map some value to itself you must use MapperTrait in your class declaration:

class Tree {

   use \PhMap\MapperTrait;
   
   //other class declaration
   
}

and then you can call mapper() or staticMapper() methods:

$tree = new Tree();
$result = $tree->mapper($json)->map();

$result = Tree::staticMapper($json)->map();

The MIT License (MIT)

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.

alevikzs / phmap

Maintainers

Details