UserFrosting API

BadRequestException extends HttpException

BadRequestException.

This exception should be thrown when a user has submitted an ill-formed request, or other incorrect data.

Tags
author

Alexander Weissman (https://alexanderweissman.com)

Table of Contents

$httpErrorCode int
$defaultMessage string
$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