Key.php

Go to the documentation of this file.

<?php

namespace SAML2\Certificate;

use SAML2\Certificate\Exception\InvalidKeyUsageException;
use SAML2\Exception\InvalidArgumentException;

class Key implements \ArrayAccess
{
    // Possible key usages
    const USAGE_SIGNING = 'signing';
    const USAGE_ENCRYPTION = 'encryption';

    protected $keyData = array();

    public function __construct(array $keyData)
    {
        // forcing usage of offsetSet
        foreach ($keyData as $property => $value) {
            $this->offsetSet($property, $value);
        }
    }

    public function canBeUsedFor($usage)
    {
        if (!in_array($usage, static::getValidKeyUsages(), true)) {
            throw new InvalidKeyUsageException($usage);
        }

        return isset($this->keyData[$usage]) && $this->keyData[$usage];
    }

    public static function getValidKeyUsages()
    {
        return array(
            self::USAGE_ENCRYPTION,
            self::USAGE_SIGNING
        );
    }

    public function offsetExists($offset)
    {
        return array_key_exists($offset, $this->keyData);
    }

    public function offsetGet($offset)
    {
        $this->assertIsString($offset);

        return $this->keyData[$offset];
    }

    public function offsetSet($offset, $value)
    {
        $this->assertIsString($offset);

        $this->keyData[$offset] = $value;
    }

    public function offsetUnset($offset)
    {
        $this->assertIsString($offset);

        unset($this->keyData[$offset]);
    }

    protected function assertIsString($test)
    {
        if (!is_string($test)) {
            throw InvalidArgumentException::invalidType('string', $test);
        }
    }
}