GpsLab\Component\Payload\PayloadTrait

Complexity

Total Complexity

17

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	payload()	0	4	1
A	setPayload()	0	14	3
A	lostProperties()	0	4	2
A	setProperty()	0	10	4
A	analyze()	0	8	3
A	getProperties()	0	10	2
A	getMethods()	0	10	2

<?php

/**
 * GpsLab component.
 *
 * @author    Peter Gribanov <info@peter-gribanov.ru>
 * @copyright Copyright (c) 2011, Peter Gribanov
 * @license   http://opensource.org/licenses/MIT
 */

namespace GpsLab\Component\Payload;

use GpsLab\Component\Payload\Exception\PropertyException;

trait PayloadTrait
{
    /**
     * @var array
     */
    private $payload = [];

    /**
     * @var string[]
     */
    private $properties = [];

    /**
     * @var string[]
     */
    private $methods = [];

    /**
     * @return array
     */
    final public function payload()
    {
        return $this->payload;
    }

    /**
     * @param array    $payload
     * @param string[] $required
     *
     * @throws PropertyException
     */
    final protected function setPayload(array $payload, array $required = [])
    {
        if ($lost = $this->lostProperties($payload, $required)) {
            throw PropertyException::noRequiredProperties($lost, $this);
        }

        $this->analyze();

        foreach ($payload as $name => $value) {
            $this->setProperty($name, $value);
        }

        $this->payload = $payload;
    }

    /**
     * @param array    $payload
     * @param string[] $required
     *
     * @return string[]
     */
    private function lostProperties(array $payload, array $required = [])
    {
        return !empty($required) ? array_diff($required, array_keys($payload)) : [];
    }

    /**
     * @param string $name
     * @param mixed  $value
     */
    private function setProperty($name, $value)
    {
        if (in_array($name, $this->properties)) {
            $this->$name = $value;
        } elseif (($method = 'set'.ucfirst($name)) && in_array($method, $this->methods)) {
            $this->{$method}($value);
        } else {
            throw PropertyException::undefinedProperty($name, $this);
        }
    }

    private function analyze()
    {
        if (!$this->properties && !$this->methods) {
            $ref = new \ReflectionClass($this);
            $this->properties = $this->getProperties($ref);
            $this->methods = $this->getMethods($ref);
        }
    }

    /**
     * @param \ReflectionClass $ref
     *
     * @return string[]
     */
    private function getProperties(\ReflectionClass $ref)
    {
        $names = [];
        $properties = $ref->getProperties(\ReflectionProperty::IS_PUBLIC | \ReflectionProperty::IS_PROTECTED);
        foreach ($properties as $property) {
            $names[] = $property->name;
        }

        return $names;
    }

    /**
     * @param \ReflectionClass $ref
     *
     * @return string[]
     */
    private function getMethods(\ReflectionClass $ref)
    {
        $names = [];
        $methods = $ref->getMethods(\ReflectionMethod::IS_PUBLIC | \ReflectionMethod::IS_PROTECTED);
        foreach ($methods as $method) {
            $names[] = $method->name;
        }

        return $names;
    }
}