Edit Report a Bug

The InvalidArgumentException class

(PHP 5 >= 5.1.0, PHP 7)

Introduction

Exception thrown if an argument is not of the expected type.

Class synopsis

InvalidArgumentException extends LogicException {

/* Inherited properties */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

/* Inherited methods */

final public Exception::getMessage ( void ) : string

final public Exception::getPrevious ( void ) : Throwable

final public Exception::getCode ( void ) : mixed

final public Exception::getFile ( void ) : string

final public Exception::getLine ( void ) : int

final public Exception::getTrace ( void ) : array

final public Exception::getTraceAsString ( void ) : string

public Exception::__toString ( void ) : string

final private Exception::__clone ( void ) : void

}

add a note

User Contributed Notes 1 note

down

Joey at anti-culture dot net ¶

8 years ago


In my opinion this exception is invaluable for validating arguments- for example providing strict typing a la C:

<?php
function tripleInteger($int)
{
  if(!is_int($int))
    throw new InvalidArgumentException('tripleInteger function only accepts integers. Input was: '.$int);
  return $int * 3;
}

$x = tripleInteger(4); //$x == 12
$x = tripleInteger(2.5); //exception will be thrown as 2.5 is a float
$x = tripleInteger('foo'); //exception will be thrown as 'foo' is a string
$x = tripleInteger('4'); //exception will throw as '4' is also a string

?>

add a note