Auth0-PHP

ConfigurationException extends Exception
in package
implements Auth0Exception

Tags
codeCoverageIgnore

Interfaces, Classes, Traits and Enums

Auth0Exception
Represents all errors generated by SDK itself.

Table of Contents

MSG_CONFIGURATION_REQUIRED  = 'The Auth0 SDK requires an SdkConfiguration be provided at initialization'
MSG_GET_MISSING  = 'Attempted to retrieve the value of an undefined property "%s"'
MSG_INVALID_TOKEN_ALGORITHM  = 'Invalid token algorithm; must be "HS256" or "RS256"'
MSG_NO_PSR17_LIBRARY  = 'No compatible PSR-17 library was configured, and one could not be auto-discovered.'
MSG_NO_PSR18_LIBRARY  = 'No compatible PSR-18 library was configured, and one could not be auto-discovered.'
MSG_REQUIRES_AUDIENCE  = '`audience` must be configured'
MSG_REQUIRES_CLIENT_ID  = '`clientId` must be configured'
MSG_REQUIRES_CLIENT_SECRET  = '`clientSecret` must be configured'
MSG_REQUIRES_COOKIE_SECRET  = '`cookieSecret` must be configured'
MSG_REQUIRES_DOMAIN  = '`domain` must be configured'
MSG_REQUIRES_MANAGEMENT_KEY  = '`managementToken` must be configured'
MSG_REQUIRES_REDIRECT_URI  = '`redirectUri` must be configured'
MSG_REQUIRES_RETURN_URI  = '`returnUri` must be configured'
MSG_SESSION_REQUIRED  = 'Method %s requires a stateful `strategy` with sessions configured.'
MSG_SET_IMMUTABLE  = 'Changes cannot be applied to a locked configuration'
MSG_SET_INCOMPATIBLE  = 'Parameter "%s" must be of type %s, %s used'
MSG_SET_INCOMPATIBLE_NULLABLE  = 'Parameter "%s" must be of type %s or null, %s used'
MSG_SET_MISSING  = 'Attempted to assign a value to undefined property "%s"'
MSG_STRATEGY_REQUIRED  = 'The Auth0 SDK requires a `strategy` to be configured'
MSG_VALIDATION_FAILED  = 'Validation of "%s" was unsuccessful'
MSG_VALUE_REQUIRED  = '`%s` is not configured'
getMissing()  : self
invalidAlgorithm()  : self
missingPsr17Library()  : self
missingPsr18Library()  : self
required()  : self
requiresAudience()  : self
requiresClientId()  : self
requiresClientSecret()  : self
requiresConfiguration()  : self
requiresCookieSecret()  : self
requiresDomain()  : self
requiresManagementToken()  : self
requiresRedirectUri()  : self
requiresReturnUri()  : self
requiresStatefulness()  : self
requiresStrategy()  : self
setImmutable()  : self
setIncompatible()  : self
setIncompatibleNullable()  : self
setMissing()  : self
validationFailed()  : self

Constants

MSG_CONFIGURATION_REQUIRED

public mixed MSG_CONFIGURATION_REQUIRED = 'The Auth0 SDK requires an SdkConfiguration be provided at initialization'

MSG_GET_MISSING

public mixed MSG_GET_MISSING = 'Attempted to retrieve the value of an undefined property "%s"'

MSG_INVALID_TOKEN_ALGORITHM

public mixed MSG_INVALID_TOKEN_ALGORITHM = 'Invalid token algorithm; must be "HS256" or "RS256"'

MSG_NO_PSR17_LIBRARY

public mixed MSG_NO_PSR17_LIBRARY = 'No compatible PSR-17 library was configured, and one could not be auto-discovered.'

MSG_NO_PSR18_LIBRARY

public mixed MSG_NO_PSR18_LIBRARY = 'No compatible PSR-18 library was configured, and one could not be auto-discovered.'

MSG_REQUIRES_CLIENT_SECRET

public mixed MSG_REQUIRES_CLIENT_SECRET = '`clientSecret` must be configured'

MSG_REQUIRES_COOKIE_SECRET

public mixed MSG_REQUIRES_COOKIE_SECRET = '`cookieSecret` must be configured'

MSG_REQUIRES_MANAGEMENT_KEY

public mixed MSG_REQUIRES_MANAGEMENT_KEY = '`managementToken` must be configured'

MSG_REQUIRES_REDIRECT_URI

public mixed MSG_REQUIRES_REDIRECT_URI = '`redirectUri` must be configured'

MSG_SESSION_REQUIRED

public mixed MSG_SESSION_REQUIRED = 'Method %s requires a stateful `strategy` with sessions configured.'

MSG_SET_IMMUTABLE

public mixed MSG_SET_IMMUTABLE = 'Changes cannot be applied to a locked configuration'

MSG_SET_INCOMPATIBLE

public mixed MSG_SET_INCOMPATIBLE = 'Parameter "%s" must be of type %s, %s used'

MSG_SET_INCOMPATIBLE_NULLABLE

public mixed MSG_SET_INCOMPATIBLE_NULLABLE = 'Parameter "%s" must be of type %s or null, %s used'

MSG_SET_MISSING

public mixed MSG_SET_MISSING = 'Attempted to assign a value to undefined property "%s"'

MSG_STRATEGY_REQUIRED

public mixed MSG_STRATEGY_REQUIRED = 'The Auth0 SDK requires a `strategy` to be configured'

MSG_VALIDATION_FAILED

public mixed MSG_VALIDATION_FAILED = 'Validation of "%s" was unsuccessful'

Methods

getMissing()

public static getMissing(string $propertyName[, Throwable|null $previous = null ]) : self
Parameters
$propertyName : string
$previous : Throwable|null = null
Return values
self —

invalidAlgorithm()

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

missingPsr17Library()

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

missingPsr18Library()

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

required()

public static required(string $propertyName[, Throwable|null $previous = null ]) : self
Parameters
$propertyName : string
$previous : Throwable|null = null
Return values
self —

requiresAudience()

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

requiresClientId()

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

requiresClientSecret()

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

requiresConfiguration()

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

requiresCookieSecret()

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

requiresDomain()

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

requiresManagementToken()

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

requiresRedirectUri()

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

requiresReturnUri()

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

requiresStatefulness()

public static requiresStatefulness(string $methodName[, Throwable|null $previous = null ]) : self
Parameters
$methodName : string
$previous : Throwable|null = null
Return values
self —

requiresStrategy()

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

setImmutable()

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

setIncompatible()

public static setIncompatible(string $propertyName, string $expectedType, string $usedType[, Throwable|null $previous = null ]) : self
Parameters
$propertyName : string
$expectedType : string
$usedType : string
$previous : Throwable|null = null
Return values
self —

setIncompatibleNullable()

public static setIncompatibleNullable(string $propertyName, string $expectedType, string $usedType[, Throwable|null $previous = null ]) : self
Parameters
$propertyName : string
$expectedType : string
$usedType : string
$previous : Throwable|null = null
Return values
self —

setMissing()

public static setMissing(string $propertyName[, Throwable|null $previous = null ]) : self
Parameters
$propertyName : string
$previous : Throwable|null = null
Return values
self —

validationFailed()

public static validationFailed(string $propertyName[, Throwable|null $previous = null ]) : self
Parameters
$propertyName : string
$previous : Throwable|null = null
Return values
self —

Search results