Bdf\Serializer\Metadata\PropertyMetadata

Complexity

Total Complexity

36

Size/Duplication

Total Lines	412
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

28 Methods

Rating	Name	Duplication	Size	Complexity
A	inline()	0	3	1
A	normalizationOptions()	0	3	1
A	setGroups()	0	4	2
A	setReadOnly()	0	3	1
A	setDefaultValue()	0	4	1
A	type()	0	3	1
A	setSince()	0	3	1
A	since()	0	3	1
A	defaultValue()	0	3	1
A	name()	0	3	1
A	className()	0	3	1
A	setNormalizationOptions()	0	3	1
A	hasGroups()	0	9	3
A	setUntil()	0	3	1
A	accessor()	0	3	1
A	alias()	0	3	1
A	denormalizationOptions()	0	3	1
A	matchVersion()	0	11	5
A	setInline()	0	3	1
A	until()	0	3	1
A	setAlias()	0	3	1
A	isDefaultValue()	0	3	2
A	__construct()	0	4	1
A	setDenormalizationOptions()	0	3	1
A	readOnly()	0	3	1
A	groups()	0	3	1
A	setAccessor()	0	3	1
A	setType()	0	3	1

<?php

namespace Bdf\Serializer\Metadata;

use Bdf\Serializer\PropertyAccessor\PropertyAccessorInterface;
use Bdf\Serializer\Type\Type;

/**
 * PropertyMetadata
 *
 * @author  Seb
 *
 * @psalm-suppress PropertyNotSetInConstructor
 */
class PropertyMetadata
{
    /**
     * The owner class name
     *
     * @var string
     */
    public $class;

    /**
     * The property name
     *
     * @var string
     */
    public $name;

    /**
     * The property alias
     *
     * @var string
     */
    public $alias;

    /**
     * The property type infos
     *
     * @var Type
     */
    public $type;

    /**
     * The property groups
     *
     * @var array
     */
    public $groups = [];

    /**
     * The property accessor
     *
     * @var PropertyAccessorInterface
     */
    public $accessor;

    /**
     * The version when the property has been added.
     *
     * @var string|null
     */
    public $since;

    /**
     * The version when the property has been removed.
     *
     * @var string|null
     */
    public $until;

    /**
     * The read only state of the property.
     *
     * @var bool
     */
    public $readOnly = false;

    /**
     * The inline state of the property.
     *
     * @var bool
     */
    public $inline = false;

    /**
     * The default value of the property.
     *
     * @var mixed
     */
    public $defaultValue;

    /**
     * A flag to know if the property has a default value.
     *
     * @var bool
     */
    private $hasDefaultValue = false;

    /**
     * Flag to know if the property used php type.
     *
     * @var bool
     */
    public $isPhpTyped = false;

    /**
     * The context options for normalization.
     *
     * @var null|array
     */
    public $normalizationOptions;

    /**
     * The context options for denormalization.
     *
     * @var null|array
     */
    public $denormalizationOptions;

    /**
     * PropertyMetadata constructor.
     *
     * @param string $class
     * @param string $name
     */
    public function __construct(string $class, string $name)
    {
        $this->class = $class;
        $this->name = $name;
    }

    /**
     * Check whether the property should be skipped
     *
     * @param array $groups
     *
     * @return boolean  True if the property has one of the groups
     */
    public function hasGroups(array $groups)
    {
        foreach ($groups as $group) {
            if (isset($this->groups[$group])) {
                return true;
            }
        }

        return false;
    }

    /**
     * Get the property class name
     *
     * @return string
     */
    public function className()
    {
        return $this->class;
    }

    /**
     * Get the property name
     *
     * @return string
     */
    public function name()
    {
        return $this->name;
    }

    /**
     * Set the property type infos
     *
     * @param Type $type
     */
    public function setType(Type $type): void
    {
        $this->type = $type;
    }

    /**
     * Get the property type
     *
     * @return Type
     */
    public function type()
    {
        return $this->type;
    }

    /**
     * Set the property alias
     *
     * @param string $alias
     */
    public function setAlias($alias): void
    {
        $this->alias = $alias;
    }

    /**
     * Get the property alias
     *
     * @return string
     */
    public function alias()
    {
        return $this->alias;
    }

    /**
     * Set the property groups
     *
     * @param array $groups
     */
    public function setGroups(array $groups): void
    {
        foreach ($groups as $group) {
            $this->groups[$group] = $group;
        }
    }

    /**
     * Get the property groups
     *
     * @return array
     */
    public function groups()
    {
        return $this->groups;
    }

    /**
     * Set the property accessor
     *
     * @param PropertyAccessorInterface $accessor
     */
    public function setAccessor(PropertyAccessorInterface $accessor): void
    {
        $this->accessor = $accessor;
    }

    /**
     * Get the property accessor
     *
     * @return PropertyAccessorInterface
     */
    public function accessor()
    {
        return $this->accessor;
    }

    /**
     * Set the version when the property has been added
     *
     * @param string|null $version
     */
    public function setSince($version): void
    {
        $this->since = $version;
    }

    /**
     * Get the version when the property has been added
     *
     * @return string|null
     */
    public function since()
    {
        return $this->since;
    }

    /**
     * Set the version when the property has been removed
     *
     * @param string|null $version
     */
    public function setUntil($version): void
    {
        $this->until = $version;
    }

    /**
     * Get the version when the property has been removed
     *
     * @return string|null
     */
    public function until()
    {
        return $this->until;
    }

    /**
     * Test if the property match to the version
     *
     * @param string $version
     *
     * @return boolean
     */
    public function matchVersion($version)
    {
        if (null !== $this->since && version_compare($version, $this->since, '<')) {
            return false;
        }

        if (null !== $this->until && version_compare($version, $this->until, '>')) {
            return false;
        }

        return true;
    }

    /**
     * Set the value of the read only flag.
     *
     * @param bool $flag
     */
    public function setReadOnly($flag): void
    {
        $this->readOnly = $flag;
    }

    /**
     * Get the value of the read only flag.
     *
     * @return bool
     */
    public function readOnly()
    {
        return $this->readOnly;
    }

    /**
     * Set the property inline.
     *
     * The result of the normalization of this property
     * will be add on the same layer of the property.
     * Works only if the normalization of this property is an array.
     *
     * @param bool $flag
     */
    public function setInline(bool $flag): void
    {
        $this->inline = $flag;
    }

    /**
     * Get the inline state of the property.
     *
     * @return bool
     */
    public function inline(): bool
    {
        return $this->inline;
    }

    /**
     * Set the value to skip.
     *
     * @param mixed $defaultValue
     */
    public function setDefaultValue($defaultValue): void
    {
        $this->defaultValue = $defaultValue;
        $this->hasDefaultValue = true;
    }

    /**
     * Get the value to skip.
     *
     * @return mixed
     */
    public function defaultValue()
    {
        return $this->defaultValue;
    }

    /**
     * Check whether the value is the default value of the property.
     *
     * @param mixed $value
     */
    public function isDefaultValue($value): bool
    {
        return $this->hasDefaultValue && $this->defaultValue === $value;
    }

    /**
     * Set the options for normalization context
     *
     * @param null|array $options
     */
    public function setNormalizationOptions($options): void
    {
        $this->normalizationOptions = $options;
    }

    /**
     * Get property options for normalization context.
     *
     * @return null|array
     */
    public function normalizationOptions()
    {
        return $this->normalizationOptions;
    }

    /**
     * Set the options for denormalization context
     *
     * @param null|array $options
     */
    public function setDenormalizationOptions($options): void
    {
        $this->denormalizationOptions = $options;
    }

    /**
     * Get property options for denormalization context.
     *
     * @return null|array
     */
    public function denormalizationOptions()
    {
        return $this->denormalizationOptions;
    }
}