Ma27\ApiKeyAuthenticationBundle\Model\User\ClassMetadata

Complexity

Total Complexity

14

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

90.24%

Importance

Changes	5
Bugs	3	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	3
A	getPropertyValue()	0	17	4
A	getPropertyName()	0	10	3
A	modifyProperty()	0	10	1
A	checkProperty()	0	15	3

<?php

namespace Ma27\ApiKeyAuthenticationBundle\Model\User;

use ReflectionClass;
use ReflectionProperty;

/**
 * Metadata object that contains the necessary data of the user model.
 *
 * @internal This code is part of the internal API to gather the appropriate model information and shouldn't be used for else use-cases
 */
class ClassMetadata
{
    const LOGIN_PROPERTY = 1;
    const PASSWORD_PROPERTY = 2;
    const API_KEY_PROPERTY = 3;
    const LAST_ACTION_PROPERTY = 4;

    /**
     * @var int[]
     */
    private static $necessaryProperties = array(
        self::LOGIN_PROPERTY    => 'login',
        self::PASSWORD_PROPERTY => 'password',
        self::API_KEY_PROPERTY  => 'apiKey',
    );

    /**
     * @var ReflectionProperty[]
     */
    private $properties = array();

    /**
     * @var string[]
     */
    private $lazyPropertyNameCache = array();

    /**
     * @var string[]
     */
    private $lazyValueCache = array();

    /**
     * Constructor.
     *
     * @param ReflectionProperty[] $properties
     *
     * @throws \InvalidArgumentException If one necessary property is missing
     */
    public function __construct(array $properties)
    {
        $this->properties = $properties;

        foreach (self::$necessaryProperties as $propertyIndex => $alias) {
            if (!isset($this->properties[$propertyIndex])) {
                throw new \InvalidArgumentException(sprintf(
                    'Missing required property "%s"!',
                    $alias
                ));
            }
        }
    }

    /**
     * Gets the value of the given property.
     *
     * @param object $user
     * @param int    $property
     * @param bool   $strict
     *
     * @return mixed
     */
    public function getPropertyValue($user, $property = self::LOGIN_PROPERTY, $strict = false)
    {
        if ($this->checkProperty($property, $strict)) {
            $oid = spl_object_hash($user);
            if (isset($this->lazyValueCache[$oid])) {
                if (isset($this->lazyValueCache[$oid][$property])) {
                    return $this->lazyValueCache[$oid][$property];
                }
            } else {
                $this->lazyValueCache[$oid] = array();
            }

            $this->properties[$property]->setAccessible(true);

            return $this->lazyValueCache[$oid][$property] = $this->properties[$property]->getValue($user);
        }
    }

    /**
     * Gets the name of a specific property by its metadata constant.
     *
     * @param int  $property
     * @param bool $strict
     *
     * @return null|string
     */
    public function getPropertyName($property = self::LOGIN_PROPERTY, $strict = false)
    {
        if ($this->checkProperty($property, $strict)) {
            if (isset($this->lazyPropertyNameCache[$property])) {
                return $this->lazyPropertyNameCache[$property];
            }

            return $this->lazyPropertyNameCache[$property] = $this->properties[$property]->getName();
        }
    }

    /**
     * Modifies a property and clears the cache.
     *
     * @param object $user
     * @param mixed  $newValue
     * @param int    $property
     */
    public function modifyProperty($user, $newValue, $property = self::LOGIN_PROPERTY)
    {
        $this->checkProperty($property, true);

        $propertyObject = $this->properties[$property];
        $propertyObject->setAccessible(true);
        $propertyObject->setValue($user, $newValue);

        unset($this->lazyValueCache[spl_object_hash($user)]);
    }

    /**
     * Validates a property.
     *
     * @param int  $property
     * @param bool $strict
     *
     * @return bool
     */
    private function checkProperty($property = self::LOGIN_PROPERTY, $strict = false)
    {
        if (!isset($this->properties[$property])) {
            if ($strict) {
                throw new \LogicException(sprintf(
                    'Cannot get property "%s"!',
                    $property
                ));
            }

            return false;
        }

        return true;
    }
}