VGirol\JsonApiAssert\Constraint\ContainsOnlyAllowedMembersConstraint

Complexity

Total Complexity

6

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	matches()	0	13	4
A	toString()	0	5	1

<?php
declare (strict_types = 1);

namespace VGirol\JsonApiAssert\Constraint;

use PHPUnit\Framework\Constraint\Constraint;

/**
 * A constraint class to assert that a json object contains only members from the provided list.
 */
class ContainsOnlyAllowedMembersConstraint extends Constraint
{
    /**
     * @var array<string>
     */
    private $members;

    /**
     * Class constructor.
     *
     * @param array<string> $members
     */
    public function __construct(array $members)
    {
        $this->members = $members;
    }

    /**
     * Returns a string representation of the constraint.
     */
    public function toString(): string
    {
        return \sprintf(
            'contains only elements of "%s"',
            \implode(', ', $this->members)
        );
    }

    /**
     * Evaluates the constraint for parameter $other. Returns true if the
     * constraint is met, false otherwise.
     *
     * @param mixed $other value or object to evaluate
     */
    protected function matches($other): bool
    {
        if (!is_array($other)) {
            return false;
        }

        foreach (array_keys($other) as $key) {
            if (!in_array($key, $this->members)) {
                return false;
            }
        }

        return true;
    }
}