VGirol\JsonApiStructure\Constraint\MemberName

Complexity

Total Complexity

9

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	default()	0	3	1
B	handle()	0	40	7
A	__construct()	0	3	1

<?php

declare(strict_types=1);

namespace VGirol\JsonApiStructure\Constraint;

use VGirol\JsonApiStructure\Messages;

/**
 * Constraint that checks if a name is a valid member name.
 */
class MemberName extends Constraint
{
    /**
     * Undocumented variable
     *
     * @var bool
     */
    private $strict;

    /**
     * Class constructor.
     *
     * @param boolean $strict If true, unsafe characters are not allowed when checking members name.
     */
    public function __construct(bool $strict)
    {
        $this->strict = $strict;
    }

    /**
     * Returns a string representation of the constraint.
     */
    public function default(): string
    {
        return Messages::MEMBER_NAME_NOT_VALID;
    }

    /**
     * Evaluates the constraint for parameter $json. Returns true if the constraint is met, false otherwise.
     *
     * Asserts that a member name is valid.
     *
     * It will do the following checks :
     * 1) asserts that the name is a string with at least one character.
     * 2) asserts that the name has only allowed characters.
     * 3) asserts that it starts and ends with a globally allowed character.
     *
     * @link https://jsonapi.org/format/#document-member-names-allowed-characters
     *
     * @param mixed $name Value or object to evaluate
     *
     * @return bool
     * @throws \VGirol\JsonApiStructure\Exception\ValidationException
     */
    public function handle($name): bool
    {
        if (!\is_string($name)) {
            $this->setFailureMessage(Messages::MEMBER_NAME_MUST_BE_STRING);

            return false;
        }

        if (\strlen($name) < 1) {
            $this->setFailureMessage(Messages::MEMBER_NAME_IS_TOO_SHORT);

            return false;
        }

        // Globally allowed characters
        $globally = '\x{0030}-\x{0039}\x{0041}-\x{005A}\x{0061}-\x{007A}';
        $globallyNotSafe = '\x{0080}-\x{FFFF}';

        // Allowed characters
        $allowed = '\x{002D}\x{005F}';
        $allowedNotSafe = '\x{0020}';

        $regex = "/[^{$globally}{$globallyNotSafe}{$allowed}{$allowedNotSafe}]+/u";
        $safeRegex = "/[^{$globally}{$allowed}]+/u";

        if (\preg_match($this->strict ? $safeRegex : $regex, $name) > 0) {
            $this->setFailureMessage(Messages::MEMBER_NAME_MUST_NOT_HAVE_RESERVED_CHARACTERS);

            return false;
        }

        $regex = "/^[{$globally}{$globallyNotSafe}]{1}(?:.*[{$globally}{$globallyNotSafe}]{1})?$/u";
        $safeRegex = "/^[{$globally}]{1}(?:.*[{$globally}]{1})?$/u";
        if (\preg_match($this->strict ? $safeRegex : $regex, $name) == 0) {
            $this->setFailureMessage(Messages::MEMBER_NAME_MUST_START_AND_END_WITH_ALLOWED_CHARACTERS);

            return false;
        }

        return true;
    }
}