TRex\Reflection\TypeReflection

Complexity

Total Complexity

34

Size/Duplication

Total Lines	414
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

66.67%

Importance

Changes	4
Bugs	0	Features	2

26 Methods

Rating	Name	Duplication	Size	Complexity
A	createFromVariable()	0	4	2
A	isAutoloadEnabled()	0	4	1
A	setEnableAutoload()	0	4	1
A	getType()	0	4	1
A	isValid()	0	4	1
A	isVoid()	0	4	1
A	isMixed()	0	4	1
A	isNull()	0	4	1
A	isBoolean()	0	4	1
A	isString()	0	4	1
A	isInteger()	0	4	1
A	isFloat()	0	4	1
A	isNumber()	0	4	1
A	isScalar()	0	4	1
A	isArray()	0	4	1
A	isObject()	0	4	1
A	isResource()	0	4	1
A	isCallable()	0	4	1
A	setType()	0	4	1
A	getTypeMappingList()	0	4	1
A	isInTypeMapping()	0	4	1
A	getStandardizedTypes()	0	4	1
A	__construct()	0	5	1
A	getStandardizedType()	0	9	3
B	is()	0	10	5
A	getTypeMapping()	0	11	2

<?php
namespace TRex\Reflection;

use \InvalidArgumentException;


/**
 * TypeReflection reflect the types.
 *
 * @package TRex\Reflection
 * @author Raphaël Lefebvre <raphael@raphaellefebvre.be>
 * @transient
 */
class TypeReflection
{

    const VOID_TYPE = 'void';
    const MIXED_TYPE = 'mixed';
    const NULL_TYPE = 'null';
    const BOOLEAN_TYPE = 'boolean';
    const STRING_TYPE = 'string';
    const INTEGER_TYPE = 'integer';
    const FLOAT_TYPE = 'float';
    const NUMBER_TYPE = 'number';
    const SCALAR_TYPE = 'scalar';
    const ARRAY_TYPE = 'array';
    const OBJECT_TYPE = 'object';
    const RESOURCE_TYPE = 'resource';
    const CALLABLE_TYPE = 'callable';
    const UNKNOWN_TYPE = 'unknown type';

    /**
     * @var array
     */
    private $typeMappingList = array(
        self::VOID_TYPE => array(
            'void',
        ),
        self::MIXED_TYPE => array(
            'mixed',
        ),
        self::NULL_TYPE => array(
            'null',
        ),
        self::BOOLEAN_TYPE => array(
            'bool',
            'boolean',
        ),
        self::STRING_TYPE => array(
            'string',
        ),
        self::INTEGER_TYPE => array(
            'int',
            'integer',
            'long',
        ),
        self::FLOAT_TYPE => array(
            'float',
            'double',
            'real',
        ),
        self::NUMBER_TYPE => array(
            'int',
            'integer',
            'long',
            'float',
            'double',
            'real',
        ),
        self::SCALAR_TYPE => array(
            'bool',
            'boolean',
            'string',
            'int',
            'integer',
            'long',
            'float',
            'double',
            'real',
        ),
        self::ARRAY_TYPE => array(
            'array',
        ),
        self::OBJECT_TYPE => array(
            'object',
        ),
        self::RESOURCE_TYPE => array(
            'resource',
        ),
        self::CALLABLE_TYPE => array(
            'callable',
        ),
    );

    /**
     * Reflected type or class name
     *
     * @var string
     */
    private $type;

    /**
     * @var bool
     */
    private $enableAutoload;

    /**
     * @param mixed $variable
     * @return TypeReflection
     */
    public static function createFromVariable($variable)
    {
        return new self(is_object($variable) ? get_class($variable) : strtolower(gettype($variable)));
    }

    /**
     * Constructor.
     *
     * @param string $type Reflected type or class name
     * @param bool $enableAutoload
     */
    public function __construct($type, $enableAutoload = false)
    {
        $this->setType($type);
        $this->enableAutoload = $enableAutoload;
    }

    /**
     * Getter of $enableAutoload
     *
     * @return boolean
     */
    public function isAutoloadEnabled()
    {
        return $this->enableAutoload;
    }

    /**
     * Setter of $enableAutoload
     *
     * @param boolean $enableAutoload
     */
    public function setEnableAutoload($enableAutoload)
    {
        $this->enableAutoload = (boolean)$enableAutoload;
    }

    /**
     * Gets the reflected type.
     *
     * @return string
     */
    public function getType()
    {
        return $this->type;
    }

    /**
     * Depending on the type, returns a standardized type, a constant value of XXX_TYPE.
     * Note that if the type is a class name, object type is returned.
     *
     *
     * @return string

Should the return type not be integer|string?

     */
    public function getStandardizedType()
    {
        foreach ($this->getStandardizedTypes() as $standardizedType) {
            if ($this->is($standardizedType)) {
                return $standardizedType;
            }
        }
        return self::UNKNOWN_TYPE;
    }

    /**
     * Indicates if the type is recognized.
     *
     * @return bool
     */
    public function isValid()
    {
        return !$this->is(self::UNKNOWN_TYPE);
    }

    /**
     * Indicates whether the reflected type is void.
     * Valid values are:
     *  - void
     *
     * @return bool
     */
    public function isVoid()
    {
        return $this->is(self::VOID_TYPE);
    }

    /**
     * Indicates whether the reflected type is mixed.
     * Valid values are:
     *  - mixed
     *
     * @return bool
     */
    public function isMixed()
    {
        return $this->is(self::MIXED_TYPE);
    }

    /**
     * Indicates whether the reflected type is null.
     * Valid values are:
     *  - null
     *
     * @return bool
     */
    public function isNull()
    {
        return $this->is(self::NULL_TYPE);
    }

    /**
     * Indicates whether the reflected type is boolean.
     * Valid values are:
     *  - bool
     *  - boolean
     *
     * @return bool
     */
    public function isBoolean()
    {
        return $this->is(self::BOOLEAN_TYPE);
    }

    /**
     * Indicates whether the reflected type is string.
     * Valid values are:
     *  - string
     *
     * @return bool
     */
    public function isString()
    {
        return $this->is(self::STRING_TYPE);
    }

    /**
     * Indicates whether the reflected type is integer.
     * Valid values are
     *  - int
     *  - integer
     *  - long
     *
     * @return bool
     */
    public function isInteger()
    {
        return $this->is(self::INTEGER_TYPE);
    }

    /**
     * Indicates whether the reflected type is float.
     * Valid values are
     *  - float
     *  - double
     *  - real
     *
     * @return bool
     */
    public function isFloat()
    {
        return $this->is(self::FLOAT_TYPE);
    }

    /**
     * Indicates whether the reflected type is number.
     * Valid values are:
     *  - every value valid for int
     *  - every value valid for float
     *
     * @return bool
     */
    public function isNumber()
    {
        return $this->is(self::NUMBER_TYPE);
    }

    /**
     * Indicates whether the reflected type is scalar.
     * Valid values are:
     *  - every value valid for boolean
     *  - every value valid for string
     *  - every value valid for int
     *  - every value valid for float
     *
     * @return bool
     */
    public function isScalar()
    {
        return $this->is(self::SCALAR_TYPE);
    }

    /**
     * Indicates whether the reflected type is array.
     * Valid values are:
     *  - array
     *  - xxx[]
     *
     * @return bool
     */
    public function isArray()
    {
        return $this->is(self::ARRAY_TYPE);
    }

    /**
     * Indicates whether the reflected type is object.
     * Valid values are:
     *  - object
     *  - valid class name
     *
     * @return bool
     */
    public function isObject()
    {
        return $this->is(self::OBJECT_TYPE);
    }

    /**
     * Indicates whether the reflected type is resource.
     * Valid values are:
     *  - resource
     *
     * @return bool
     */
    public function isResource()
    {
        return $this->is(self::RESOURCE_TYPE);
    }

    /**
     * Indicates whether the reflected type is callable.
     * Valid values are:
     *  - callable
     *
     * @return bool
     */
    public function isCallable()
    {
        return $this->is(self::CALLABLE_TYPE);
    }

    /**
     * Indicates whether the reflected type is $standardizedType.
     *
     * @param string $standardizedType see specific const.
     * @return bool
     */
    public function is($standardizedType)
    {
        if ($standardizedType === self::OBJECT_TYPE && class_exists($this->getType(), $this->isAutoloadEnabled())) {
            return true;
        }
        if ($standardizedType === self::ARRAY_TYPE && stripos($this->getType(), '[]') !== false) {
            return true;
        }
        return $this->isInTypeMapping($standardizedType);
    }

    /**
     * Setter of $type.
     *
     * @param string $type
     */
    private function setType($type)
    {
        $this->type = (string)$type;
    }

    /**
     * Getter of $typeMappingList.
     *
     * @return array
     */
    private function getTypeMappingList()
    {
        return $this->typeMappingList;
    }

    /**
     * Returns a type mapping.
     *
     * @param string $standardizeType
     * @return array
     */
    private function getTypeMapping($standardizeType)
    {
        if(!isset($this->getTypeMappingList()[$standardizeType])){
            throw new InvalidArgumentException(sprintf(
                '$standardizeType not valid. Should be on of the values: %s. "%s" given.',
                json_encode($this->getStandardizedTypes()),
                $standardizeType
            ));
        }
        return $this->getTypeMappingList()[$standardizeType];
    }

    /**
     * Indicates whether self::$type is a possible type of $standardizedType.
     *
     * @param string $standardizedType
     * @return bool
     */
    private function isInTypeMapping($standardizedType)
    {
        return in_array(strtolower($this->getType()), $this->getTypeMapping($standardizedType), true);
    }

    /**
     * get the possible types.
     *
     * @return array

Consider making the return type a bit more specific; maybe use array<integer|string>.

     */
    private function getStandardizedTypes()
    {
        return array_keys($this->getTypeMappingList());
    }
}