SAML2\Configuration\PrivateKey Class Reference

Configuration of a private key. More...

Inheritance diagram for SAML2\Configuration\PrivateKey:

Collaboration diagram for SAML2\Configuration\PrivateKey:

Public Member Functions
	__construct ($filePath, $name, $passphrase=null)
	getFilePath ()
	hasPassPhrase ()
	getPassPhrase ()
	getName ()
Public Member Functions inherited from SAML2\Configuration\ArrayAdapter
	__construct (array $configuration)
	get ($key, $defaultValue=null)
	Query to get the value in the configuration for the given key. More...
	has ($key)
	Query for whether or not the configuration has a value for the key. More...

Data Fields
const	NAME_NEW = 'new'
const	NAME_DEFAULT = 'default'

Private Attributes
	$filePath
	$passphrase
	$name

Detailed Description

Configuration of a private key.

Definition at line 10 of file PrivateKey.php.

Constructor & Destructor Documentation

__construct()

SAML2\Configuration\PrivateKey::__construct	(		$filePath,
			$name,
			$passphrase = null
	)

Definition at line 30 of file PrivateKey.php.

References SAML2\Configuration\PrivateKey\$filePath, SAML2\Configuration\PrivateKey\$name, SAML2\Configuration\PrivateKey\$passphrase, and SAML2\Exception\InvalidArgumentException\invalidType().

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

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

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

        $this->filePath = $filePath;
        $this->passphrase = $passphrase;
        $this->name = $name;
    }

Here is the call graph for this function:

Member Function Documentation

getFilePath()

SAML2\Configuration\PrivateKey::getFilePath

(

)

Returns

string

Definition at line 52 of file PrivateKey.php.

References SAML2\Configuration\PrivateKey\$filePath.

    {
        return $this->filePath;
    }

getName()

SAML2\Configuration\PrivateKey::getName

(

)

Returns

string

Definition at line 76 of file PrivateKey.php.

References SAML2\Configuration\PrivateKey\$name.

Referenced by SAML2\Configuration\IdentityProvider\getPrivateKey(), and SAML2\Configuration\ServiceProvider\getPrivateKey().

    {
        return $this->name;
    }

Here is the caller graph for this function:

getPassPhrase()

SAML2\Configuration\PrivateKey::getPassPhrase

(

)

Returns

string

Definition at line 68 of file PrivateKey.php.

References SAML2\Configuration\PrivateKey\$passphrase.

    {
        return $this->passphrase;
    }

hasPassPhrase()

SAML2\Configuration\PrivateKey::hasPassPhrase

(

)

Returns

bool

Definition at line 60 of file PrivateKey.php.

References SAML2\Configuration\PrivateKey\$passphrase.

    {
        return (bool) $this->passphrase;
    }

Field Documentation

$filePath

SAML2\Configuration\PrivateKey::$filePath

private

Definition at line 18 of file PrivateKey.php.

Referenced by SAML2\Configuration\PrivateKey\__construct(), and SAML2\Configuration\PrivateKey\getFilePath().

$name

SAML2\Configuration\PrivateKey::$name

private

Definition at line 28 of file PrivateKey.php.

Referenced by SAML2\Configuration\PrivateKey\__construct(), and SAML2\Configuration\PrivateKey\getName().

$passphrase

SAML2\Configuration\PrivateKey::$passphrase

private

Definition at line 23 of file PrivateKey.php.

Referenced by SAML2\Configuration\PrivateKey\__construct(), SAML2\Configuration\PrivateKey\getPassPhrase(), and SAML2\Configuration\PrivateKey\hasPassPhrase().

NAME_DEFAULT

const SAML2\Configuration\PrivateKey::NAME_DEFAULT = 'default'

Definition at line 13 of file PrivateKey.php.

Referenced by SAML2\Configuration\SimpleSAMLConverter\enrichForDecryptionProvider().

NAME_NEW

const SAML2\Configuration\PrivateKey::NAME_NEW = 'new'

Definition at line 12 of file PrivateKey.php.

Referenced by SAML2\Configuration\SimpleSAMLConverter\enrichForDecryptionProvider().

---

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

• libs/composer/vendor/simplesamlphp/saml2/src/SAML2/Configuration/PrivateKey.php