InvalidArgumentClassException
extends InvalidArgumentTypeException
in package
InvalidArgumentException represents an exception caused by invalid arguments passed to a method.
Tags
Table of Contents
Properties
- $given : mixed
- $isInstantiating : bool
- $methodName : string
- $parameter : string|null
- $suffix : string
- $valid : array<string|int, mixed>
Methods
- __construct() : mixed
- formatMessage() : string
- getGiven() : mixed
- getMethodName() : string
- getName() : string
- getParameter() : string|null
- getSuffix() : string
- getValid() : array<string|int, mixed>
- newInstance() : self
- setMethodName() : self
- setParameter() : InvalidArgumentExceptionTrait
- setSuffix() : self
- setValid() : self
- formatGiven() : string
- formatPrologue() : string
- formatValid() : string
- updateMessage() : self
Properties
$given
protected
mixed
$given
$isInstantiating
protected
bool
$isInstantiating
= true
$methodName
protected
string
$methodName
$parameter
protected
string|null
$parameter
= null
$suffix
protected
string
$suffix
= ''
$valid
protected
array<string|int, mixed>
$valid
= []
Methods
__construct()
public
__construct(string $parameterOrMessage[, string|array<string|int, string> $valid = null ][, mixed $given = null ][, int $code = null ][, Throwable|null $previous = null ]) : mixed
Parameters
- $parameterOrMessage : string
-
Name of parameter in question, or alternatively the full message string containing at least one space character (ASCII 32). In this case,
$validand$givenare considered to be$codeand$previousrespectively - $valid : string|array<string|int, string> = null
-
(List of) valid parameter(s)
- $given : mixed = null
-
Parameter received
- $code : int = null
-
Optional exception code
- $previous : Throwable|null = null
-
Optional previous exception
Tags
formatMessage()
public
formatMessage() : string
Return values
stringgetGiven()
public
getGiven() : mixed
getMethodName()
public
getMethodName() : string
Return values
stringgetName()
public
getName() : string
Return values
string —the user-friendly name of this exception
getParameter()
public
getParameter() : string|null
Return values
string|nullgetSuffix()
public
getSuffix() : string
Return values
stringgetValid()
public
getValid() : array<string|int, mixed>
Return values
array<string|int, mixed>newInstance()
public
static newInstance(mixed $parameterOrMessage[, mixed $valid = null ][, mixed $given = null ][, mixed $code = null ][, mixed $previous = null ]) : self
Parameters
- $parameterOrMessage : mixed
- $valid : mixed = null
- $given : mixed = null
- $code : mixed = null
- $previous : mixed = null
Tags
Return values
selfsetMethodName()
public
setMethodName(string $methodName) : self
Parameters
- $methodName : string
Return values
selfsetParameter()
public
setParameter(string|null $parameter) : InvalidArgumentExceptionTrait
Parameters
- $parameter : string|null
Return values
InvalidArgumentExceptionTraitsetSuffix()
public
setSuffix(string $suffix) : self
Parameters
- $suffix : string
Return values
selfsetValid()
public
setValid(mixed $valid) : self
Parameters
- $valid : mixed
Return values
selfformatGiven()
protected
formatGiven() : string
Return values
stringformatPrologue()
protected
formatPrologue() : string
Return values
stringformatValid()
protected
formatValid() : string
Return values
stringupdateMessage()
protected
updateMessage() : self