GenericCollections\Options

Complexity

Total Complexity

6

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	1

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	2
A	optionAllowNullMembers()	0	4	1
A	optionUniqueValues()	0	4	1
A	optionComparisonIsIdentical()	0	4	1
A	getOptions()	0	4	1

<?php namespace GenericCollections;

use GenericCollections\Interfaces\BaseOptions;

/**
 * This class implements the BaseOptions interface
 *
 * Is a ValueObject (read-only) that defines the the container behavior
 *
 * @package GenericCollections
 */
class Options implements BaseOptions
{
    const UNIQUE_VALUES    = 1;
    const ALLOW_NULLS      = 2;
    const COMPARISON_EQUAL = 4;

    /** @var bool null members property */
    private $allowNullMembers;

    /** @var bool duplicates property */
    private $uniqueValues;

    /** @var bool comparison is identical */
    private $comparisonIsIdentical;

    /** @var int original options value */
    private $options;

    /**
     * Create a Options object based on a numeric value
     *
     * @param int $options
     */
    public function __construct($options)
    {
        if (!is_integer($options)) {
            throw new \InvalidArgumentException('The supplied options value is not an integer');
        }
        $options                     = $options & 7; // truncate to max value (3 ^ 2 - 1)
        $this->options               = $options;
        $this->allowNullMembers      = (bool) ($options & self::ALLOW_NULLS);
        $this->uniqueValues          = (bool) ($options & self::UNIQUE_VALUES);
        $this->comparisonIsIdentical = ! (bool) ($options & self::COMPARISON_EQUAL);
    }

    public function optionAllowNullMembers()
    {
        return $this->allowNullMembers;
    }

    public function optionUniqueValues()
    {
        return $this->uniqueValues;
    }

    public function optionComparisonIsIdentical()
    {
        return $this->comparisonIsIdentical;
    }

    /**
     * Return the options value
     *
     * @return int
     */
    public function getOptions()
    {
        return $this->options;
    }
}