Firebase\JWT\Key Class Reference

Collaboration diagram for Firebase\JWT\Key:

Public Member Functions
	__construct ( $keyMaterial, string $algorithm)
	getAlgorithm ()
	Return the algorithm valid for this key. More...
	getKeyMaterial ()

Private Attributes
	$keyMaterial
string	$algorithm

Detailed Description

Definition at line 10 of file Key.php.

Constructor & Destructor Documentation

__construct()

Firebase\JWT\Key::__construct	(		$keyMaterial,
		string	$algorithm
	)

Parameters

string | resource | OpenSSLAsymmetricKey | OpenSSLCertificate	$keyMaterial
string	$algorithm

Definition at line 21 of file Key.php.

References Firebase\JWT\Key\$algorithm, and Firebase\JWT\Key\$keyMaterial.

      {
        if (
            !\is_string($keyMaterial)
            && !$keyMaterial instanceof OpenSSLAsymmetricKey
            && !$keyMaterial instanceof OpenSSLCertificate
            && !\is_resource($keyMaterial)
        ) {
            throw new TypeError('Key material must be a string, resource, or OpenSSLAsymmetricKey');
        }

        if (empty($keyMaterial)) {
            throw new InvalidArgumentException('Key material must not be empty');
        }

        if (empty($algorithm)) {
            throw new InvalidArgumentException('Algorithm must not be empty');
        }

        // TODO: Remove in PHP 8.0 in favor of class constructor property promotion
        $this->keyMaterial = $keyMaterial;
        $this->algorithm = $algorithm;
    }

Member Function Documentation

getAlgorithm()

Firebase\JWT\Key::getAlgorithm

(

)

Return the algorithm valid for this key.

Returns

string

Definition at line 52 of file Key.php.

References Firebase\JWT\Key\$algorithm.

                                  : string
    {
        return $this->algorithm;
    }

getKeyMaterial()

Firebase\JWT\Key::getKeyMaterial

(

)

Returns

string|resource|OpenSSLAsymmetricKey|OpenSSLCertificate

Definition at line 60 of file Key.php.

References Firebase\JWT\Key\$keyMaterial.

    {
        return $this->keyMaterial;
    }

Field Documentation

$algorithm

string Firebase\JWT\Key::$algorithm

private

Definition at line 15 of file Key.php.

Referenced by Firebase\JWT\Key\__construct(), and Firebase\JWT\Key\getAlgorithm().

$keyMaterial

Firebase\JWT\Key::$keyMaterial

private

Definition at line 13 of file Key.php.

Referenced by Firebase\JWT\Key\__construct(), and Firebase\JWT\Key\getKeyMaterial().

---

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

• Services/LTI/src/Firebase/Key.php