UserFrosting API

InvalidCredentialsException extends HttpException

Invalid credentials exception. Used when an account fails authentication for some reason.

Child classes of HttpException should be thrown when we want to return an HTTP status code and user-viewable message(s) during the application lifecycle.

Tags
author

Alex Weissman (https://alexanderweissman.com)

Table of Contents

$defaultMessage string
$httpErrorCode int
$httpErrorCode int
$messages
$defaultMessage string
getHttpErrorCode() Return the HTTP status code associated with this exception. int
getUserMessages() Return the user-viewable messages associated with this exception. mixed
addUserMessage() Add a user-viewable message for this exception. mixed

Properties

$defaultMessage

protected string $defaultMessage = 'SERVER_ERROR'

Methods

getHttpErrorCode()

Return the HTTP status code associated with this exception.

public getHttpErrorCode( ) : int
Return values
int

getUserMessages()

Return the user-viewable messages associated with this exception.

public getUserMessages( ) : mixed
Return values
mixed

addUserMessage()

Add a user-viewable message for this exception.

public addUserMessage( $message : UserMessage|string [, $parameters : array = [] ] ) : mixed
Parameters
$message : UserMessage|string
$parameters : array = []

The parameters to be filled in for any placeholders in the message.

Return values
mixed

Search results