Exception::getCode

(PHP 5, PHP 7, PHP 8)

Exception::getCodeGets the Exception code

Descrierea

final public Exception::getCode ( ) : mixed

Returns the Exception code.

Parametri

Această funcție nu are parametri.

Valorile întoarse

Returns the exception code as int in Exception but possibly as other type in Exception descendants (for example as string in PDOException).

Exemple

Example #1 Exception::getCode() example

<?php
try {
    throw new 
Exception("Some error message"30);
} catch(
Exception $e) {
    echo 
"The exception code is: " $e->getCode();
}
?>

Exemplul de mai sus va afișa ceva similar cu:

The exception code is: 30

A se vedea și

add a note add a note

User Contributed Notes 4 notes

up
68
talksonweb at gmail dot com
11 years ago
The exception code can be used to categorize your errors. If you're wondering what the exception code can be used for, read on below.

Let's say each time your application isn't able to connect to the database, you can save the error message under the error/exception code 214. At the end of the month, you can do a quick search on the error number '214' and find out how many times this error occurred. This makes life easier. Also, the error/exception message will give you details into what happened.

The point is to use both the exception message and code. It's helpful in the long run.

Note: I added this note, because I was confused earlier as to the purpose of the exception code and it's use.
up
24
ricky at rocker dot com
11 years ago
when raising an Exception with no error code explicitly defined, getCode() returns the integer 0

<?php
try {
  throw new
Exception("no code!!");
} catch (
Exception $e) {
  print(
"Code='" . $e->getCode() . "'");
}
?>

outputs

Code='0'
up
6
2M
3 years ago
Do not use the strict operator as suggested when checking the Exception Code in \PDOException.
As per documentation: \PDOException is returning a string for its Exception Code and not an Integer.

Ran into the following in PHP8:
<?php

catch(\PDOException $e) {
   
var_dump($e->getCode()); //Output: string(5) "23000"
}

?>
up
-1
ahmad dot mayahi at gmail dot com
7 years ago
One of the most useful tricks of getCode is handling duplication entries when trying to add a duplicate row into the database.

Sometimes we don't need to show any errors regarding this duplication.

The following snippet is taken from one of my projects:

<?php
//I have a mysql table called hosts with one unique key named host_name.
try {
    
$hosts = new Hosts(["host_name" => "www.example.com");
    
$hosts->save();
} catch (\
PDOException $e) {
      if (
$e->getCode() === 23000) {
         
//Do nothing
    
}
}
?>

Here I'm saving the host name, and I don't care if it's already exists.
To Top