1. Documentation
  2. API
  3. Library
  4. Auth
  5. AuthException

October\Rain\Auth\AuthException

Overview

AuthException used when user authentication fails. Implements a softer error message

Extends
Implements
  • Stringable
  • Throwable

Public Properties

There are no public properties in the class.

Show inherited public properties

Inherited Public Properties

Protected Properties

protected static string $errorMessage

errorMessage default soft error message

protected static array $errorCodes

errorCodes for each error distinction.

Show inherited protected properties

Inherited Protected Properties

Public Methods

public __construct()

public __construct(
    string $message = '',
    int $code = 0,
    Exception $previous = null
): void

__construct softens a detailed authentication error with a more vague message when the application is not in debug mode for security reasons.

public static setDefaultErrorMessage()

public static setDefaultErrorMessage($message): void

setDefaultErrorMessage will override the soft error message displayed to the user

Show inherited public methods

Inherited Public Methods

Protected Methods

protected useSoftErrors()

protected useSoftErrors(): bool

useSoftErrors determines if soft errors should be used, set by config and when enabled uses less specific error messages.

Show inherited protected methods

Inherited Protected Methods