Auth0-PHP

TokenException extends Exception
in package
implements Auth0Exception

FinalYes
Tags
codeCoverageIgnore

Table of Contents

Interfaces

Auth0Exception
Represents all errors generated by SDK itself.

Constants

MSG_HS256_REQUIRES_KEY_AS_STRING  : string = 'HS256 algorithm requires a key in string format.'
MSG_KEY_TYPE_NOT_SUPPORTED  : string = 'Key type "%s" is not supported for the %s algo...
MSG_KEY_TYPE_UNKNOWN  : string = 'Key type could not be determined'
MSG_LIB_OPENSSL_MISSING  : string = 'The OpenSSL extension is required to generate...
MSG_LIB_OPENSSL_MISSING_ALGO  : string = 'The OpenSSL extension must support %s algorith...
MSG_SIGNING_KEY_PROCESSING_ERROR  : string = 'An exception occurred while attempting to proc...
MSG_UNABLE_TO_ENCODE_SEGMENT  : string = 'An exception occurred while attempting to enco...
MSG_UNABLE_TO_SIGN_DATA  : string = 'An exception occurred while attempting to prod...
MSG_UNKNOWN_ERROR  : string = 'An unknown error occurred.'
MSG_UNSUPPORTED_ALGORITHM  : string = 'Unsupported algorithm "%s". Supported algorith...

Methods

keyTypeMismatch()  : self
openSslMissing()  : self
openSslMissingAlgo()  : self
requireKeyAsStringHs256()  : self
unableToEncodeSegment()  : self
unableToProcessSigningKey()  : self
unableToSignData()  : self
unidentifiableKeyType()  : self
unknown()  : self
unsupportedAlgorithm()  : self

Constants

MSG_HS256_REQUIRES_KEY_AS_STRING

public string MSG_HS256_REQUIRES_KEY_AS_STRING = 'HS256 algorithm requires a key in string format.'

MSG_KEY_TYPE_NOT_SUPPORTED

public string MSG_KEY_TYPE_NOT_SUPPORTED = 'Key type "%s" is not supported for the %s algorithm'

MSG_KEY_TYPE_UNKNOWN

public string MSG_KEY_TYPE_UNKNOWN = 'Key type could not be determined'

MSG_LIB_OPENSSL_MISSING

public string MSG_LIB_OPENSSL_MISSING = 'The OpenSSL extension is required to generate tokens'

MSG_LIB_OPENSSL_MISSING_ALGO

public string MSG_LIB_OPENSSL_MISSING_ALGO = 'The OpenSSL extension must support %s algorithm to generate tokens'

MSG_SIGNING_KEY_PROCESSING_ERROR

public string MSG_SIGNING_KEY_PROCESSING_ERROR = 'An exception occurred while attempting to process the configured signing key: %s'

MSG_UNABLE_TO_ENCODE_SEGMENT

public string MSG_UNABLE_TO_ENCODE_SEGMENT = 'An exception occurred while attempting to encode segment "%s" during token generation: %s'

MSG_UNABLE_TO_SIGN_DATA

public string MSG_UNABLE_TO_SIGN_DATA = 'An exception occurred while attempting to produce signature during token generation: %s'

MSG_UNKNOWN_ERROR

public string MSG_UNKNOWN_ERROR = 'An unknown error occurred.'

MSG_UNSUPPORTED_ALGORITHM

public string MSG_UNSUPPORTED_ALGORITHM = 'Unsupported algorithm "%s". Supported algorithms are: %s'

Methods

keyTypeMismatch()

public static keyTypeMismatch(string $keyType, string $algorithm[, Throwable|null $previous = null ]) : self
Parameters
$keyType : string
$algorithm : string
$previous : Throwable|null = null
Return values
self

openSslMissing()

public static openSslMissing([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

openSslMissingAlgo()

public static openSslMissingAlgo(string $algorithm[, Throwable|null $previous = null ]) : self
Parameters
$algorithm : string
$previous : Throwable|null = null
Return values
self

requireKeyAsStringHs256()

public static requireKeyAsStringHs256([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

unableToEncodeSegment()

public static unableToEncodeSegment(string $segment, string $message[, Throwable|null $previous = null ]) : self
Parameters
$segment : string
$message : string
$previous : Throwable|null = null
Return values
self

unableToProcessSigningKey()

public static unableToProcessSigningKey(string $message[, Throwable|null $previous = null ]) : self
Parameters
$message : string
$previous : Throwable|null = null
Return values
self

unableToSignData()

public static unableToSignData(string $message[, Throwable|null $previous = null ]) : self
Parameters
$message : string
$previous : Throwable|null = null
Return values
self

unidentifiableKeyType()

public static unidentifiableKeyType([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

unknown()

public static unknown([Throwable|null $previous = null ]) : self
Parameters
$previous : Throwable|null = null
Return values
self

unsupportedAlgorithm()

public static unsupportedAlgorithm(string $algorithm, string $supported[, Throwable|null $previous = null ]) : self
Parameters
$algorithm : string
$supported : string
$previous : Throwable|null = null
Return values
self
On this page

Search results