SAML2\Certificate\Key Class Reference

Simple DTO wrapper for (X509) keys. More...

Inheritance diagram for SAML2\Certificate\Key:

Collaboration diagram for SAML2\Certificate\Key:

Public Member Functions
	__construct (array $keyData)
	canBeUsedFor ($usage)
	Whether or not the key is configured to be used for usage given. More...
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)

Static Public Member Functions
static	getValidKeyUsages ()
	Returns the list of valid key usage options. More...

Data Fields
const	USAGE_SIGNING = 'signing'
const	USAGE_ENCRYPTION = 'encryption'

Protected Member Functions
	assertIsString ($test)
	Asserts that the parameter is of type string. More...

Protected Attributes
	$keyData = array()

Detailed Description

Simple DTO wrapper for (X509) keys.

Implements ArrayAccess for easier backwards compatibility.

Definition at line 12 of file Key.php.

Constructor & Destructor Documentation

__construct()

SAML2\Certificate\Key::__construct

(

array

$keyData

)

Parameters

array

$keyData

Definition at line 26 of file Key.php.

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

References SAML2\Certificate\Key\$keyData, and SAML2\Certificate\Key\offsetSet().

Here is the call graph for this function:

Member Function Documentation

assertIsString()

SAML2\Certificate\Key::assertIsString (   $test )

protected

Asserts that the parameter is of type string.

Parameters

mixed

$test

Exceptions

Exception

Definition at line 93 of file Key.php.

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

References $test, and SAML2\Exception\InvalidArgumentException\invalidType().

Referenced by SAML2\Certificate\Key\offsetGet(), SAML2\Certificate\Key\offsetSet(), and SAML2\Certificate\Key\offsetUnset().

Here is the call graph for this function:

Here is the caller graph for this function:

canBeUsedFor()

SAML2\Certificate\Key::canBeUsedFor

(

$usage

)

Whether or not the key is configured to be used for usage given.

Parameters

string

$usage

Returns

bool

Definition at line 40 of file Key.php.

    {
        if (!in_array($usage, static::getValidKeyUsages(), true)) {
            throw new InvalidKeyUsageException($usage);
        }
 
        return isset($this->keyData[$usage]) && $this->keyData[$usage];
    }

getValidKeyUsages()

static SAML2\Certificate\Key::getValidKeyUsages ( )

static

Returns the list of valid key usage options.

Returns

array

Definition at line 53 of file Key.php.

    {
        return array(
            self::USAGE_ENCRYPTION,
            self::USAGE_SIGNING
        );
    }

Referenced by SAML2\Certificate\Exception\InvalidKeyUsageException\__construct().

Here is the caller graph for this function:

offsetExists()

SAML2\Certificate\Key::offsetExists

(

$offset

)

Definition at line 61 of file Key.php.

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

offsetGet()

SAML2\Certificate\Key::offsetGet

(

$offset

)

Definition at line 66 of file Key.php.

    {
        $this->assertIsString($offset);
 
        return $this->keyData[$offset];
    }

References SAML2\Certificate\Key\assertIsString().

Here is the call graph for this function:

offsetSet()

SAML2\Certificate\Key::offsetSet	(		$offset,
			$value
	)

Reimplemented in SAML2\Certificate\X509.

Definition at line 73 of file Key.php.

    {
        $this->assertIsString($offset);
 
        $this->keyData[$offset] = $value;
    }

References SAML2\Certificate\Key\assertIsString().

Referenced by SAML2\Certificate\Key\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

offsetUnset()

SAML2\Certificate\Key::offsetUnset

(

$offset

)

Definition at line 80 of file Key.php.

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

References SAML2\Certificate\Key\assertIsString().

Here is the call graph for this function:

Field Documentation

$keyData

SAML2\Certificate\Key::$keyData = array()

protected

Definition at line 21 of file Key.php.

Referenced by SAML2\Certificate\Key\__construct(), and SAML2\Certificate\PrivateKey\create().

USAGE_ENCRYPTION

const SAML2\Certificate\Key::USAGE_ENCRYPTION = 'encryption'

Definition at line 16 of file Key.php.

USAGE_SIGNING

const SAML2\Certificate\Key::USAGE_SIGNING = 'signing'

Definition at line 15 of file Key.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/simplesamlphp/saml2/src/SAML2/Certificate/Key.php