Overview

Namespaces

  • Webmozart
    • KeyValueStore
      • Api
      • Decorator
      • Util

Classes

  • KeyUtil
  • Serializer
  • Overview
  • Namespace
  • Class
 1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 
<?php

/*
 * This file is part of the webmozart/key-value-store package.
 *
 * (c) Bernhard Schussek <bschussek@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Webmozart\KeyValueStore\Util;

use Webmozart\KeyValueStore\Api\InvalidKeyException;

/**
 * Utility methods for dealing with key-value store keys.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
final class KeyUtil
{
    /**
     * Validates that a key is valid.
     *
     * @param mixed $key The tested key.
     *
     * @throws InvalidKeyException If the key is invalid.
     */
    public static function validate($key)
    {
        if (!is_string($key) && !is_int($key)) {
            throw InvalidKeyException::forKey($key);
        }
    }

    /**
     * Validates that multiple keys are valid.
     *
     * @param array $keys The tested keys.
     *
     * @throws InvalidKeyException If a key is invalid.
     */
    public static function validateMultiple($keys)
    {
        foreach ($keys as $key) {
            if (!is_string($key) && !is_int($key)) {
                throw InvalidKeyException::forKey($key);
            }
        }
    }

    private function __construct()
    {
    }
}
Webmozart Key-Value Store API API documentation generated by ApiGen