SubjectivePHP\Psr\SimpleCache\KeyValidatorTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	validateKeys()	0	3	1
A	validateKey()	0	8	4

<?php

namespace SubjectivePHP\Psr\SimpleCache;

/**
 * Trait for validating PSR-16 simple cache keys.
 */
trait KeyValidatorTrait
{
    /**
     * Verifies the given cache key is a legal value.
     *
     * @param mixed $key The cache key to validate.
     *
     * @return void
     *
     * @throws InvalidArgumentException Thrown if the $key string is not a legal value.
     */
    protected function validateKey($key)
    {
        if (!is_string($key) || $key === '') {
            throw new InvalidArgumentException('$key must be a valid non empty string');
        }

        if (preg_match('#[{}()/\\\@:]#', $key) > 0) {
            throw new InvalidArgumentException("Key '{$key}' contains unsupported characters");
        }
    }

    /**
     * Verifies all of the given cache keys are a legal values.
     *
     * @param array $keys The collection cache key to validate.
     *
     * @return void
     *
     * @throws InvalidArgumentException Thrown if the $key string is not a legal value.
     */
    protected function validateKeys(array $keys)
    {
        array_walk($keys, [$this, 'validateKey']);
    }
}