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

October\Rain\Auth\AuthException

Source: ~/vendor/october/rain/src/Auth/AuthException.php

Extends:

Implements:

  • Throwable

Used when user authentication fails. Implements a softer error message.

Public properties

There are no public properties in the class.

Show inherited public properties

Inherited public properties

Protected properties

protected boolean $softErrors

Use less specific error messages.

protected string $errorMessage

Default soft error message.

Show inherited protected properties

Inherited protected properties

Public methods

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

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

Parameters
  • string $message - Error message.
  • int $code - Error code.
  • Exception $previous - Previous exception.

Show inherited public methods

Inherited public methods

  • public void __toString() - defined in Exception.
  • public void __wakeup() - defined in Exception.
  • public void applyMask(Exception $exception) - defined in October\Rain\Exception\ExceptionBase. This method is used when applying the mask exception to the face exception.
  • public Array getCallStack() - defined in October\Rain\Exception\ExceptionBase. Returns the call stack as an array of values containing a stack information object.
  • public string getClassName() - defined in October\Rain\Exception\ExceptionBase. Returns the class name of the called Exception.
  • public void getCode() - defined in Exception.
  • public string getErrorType() - defined in October\Rain\Exception\ExceptionBase. Returns the error type derived from the error code used.
  • public void getFile() - defined in Exception.
  • public array getHighlight() - defined in October\Rain\Exception\ExceptionBase. Generates information used for highlighting the area of code in context of the exception line number.
  • public array getHighlightLines() - defined in October\Rain\Exception\ExceptionBase. Returns an array of line numbers used for highlighting the problem area of code.
  • public void getLine() - defined in Exception.
  • public void getMessage() - defined in Exception.
  • public void getPrevious() - defined in Exception.
  • public void getTrace() - defined in Exception.
  • public void getTraceAsString() - defined in Exception.
  • public Exception getTrueException() - defined in October\Rain\Exception\ExceptionBase. If this exception is acting as a mask, return the face exception. Otherwise return.
  • public static void mask(string $message=NULL, int $code=0) - defined in October\Rain\Exception\ExceptionBase. Masks an exception with the called class. This should catch fatal and php errors.
  • public void setMask(Exception $exception) - defined in October\Rain\Exception\ExceptionBase. If this exception acts as a mask, sets the face for the foreign exception.
  • public static void unmask() - defined in October\Rain\Exception\ExceptionBase. Removes the active mask from the called class.

Protected methods

Show inherited protected methods

Inherited protected methods

  • protected array filterCallStack(array $traceInfo) - defined in October\Rain\Exception\ExceptionBase. Removes the final steps of a call stack, which add no value for the user.
  • protected string formatStackArguments(array $arguments) - defined in October\Rain\Exception\ExceptionBase. Prepares a function or method argument list for display in HTML or text format.