vBulletin v6.1.0

vB_Exception extends Exception
in package
uses vB_Trait_NoSerialize

AbstractYes

vB Exception Base class for all exceptions.

The standard error message fetched with getMessage() should not be given to the end user and should be used only for development. For this reason, they should not need to be localised.

Exceptions that will use a user visible message should implement their own method to do so.

concrete classes can extend.

Table of Contents

Methods

__construct()  : mixed
Constructor.
__serialize()  : array<string|int, mixed>
__sleep()  : array<string|int, mixed>
__toString()  : mixed
Magic method.
__unserialize()  : void
__wakeup()  : void
getFullTrace()  : string
Returns the stack trace for an exception
isCritical()  : bool
Checks if an exception is considered critical.
logError()  : mixed
Logs details of the error.
mailError()  : mixed
Sends details of the error to a configured email address.
toString()  : string
Creates a string representation of the error.

Methods

__construct()

Constructor.

public __construct(string $message[, int $code = false ][, string $file = false ][, int $line = false ]) : mixed

Checks whether the error should be logged, mailed and/or debugged.

$code, $line and $file should only be specified if the exception was thrown because of a PHP error. The code should be the PHP error level of the error. $file and $line will override where the exception was thrown from and instead be set to where the PHP error occured.

Parameters
$message : string
  • A description of the error
$code : int = false
  • The PHP code of the error
$file : string = false
  • The file the exception was thrown from
$line : int = false
  • The line the exception was thrown from

__serialize()

public __serialize() : array<string|int, mixed>
Return values
array<string|int, mixed>

__sleep()

public __sleep() : array<string|int, mixed>
Return values
array<string|int, mixed>

__toString()

Magic method.

public __toString() : mixed

Seperated from toString function because __toString cannot take parameters in 5.3

__unserialize()

public __unserialize(array<string|int, mixed> $serialized) : void
Parameters
$serialized : array<string|int, mixed>

getFullTrace()

Returns the stack trace for an exception

public static getFullTrace(Exception $e) : string

The exception class provides a getTrace and getTraceAsString function, but maddeningly, these do not include the line on which the exception was thrown. This function adds that information the to the string trace and returns it

Declared as as static function so we can use this with other people's exceptions
as well as our own.
Parameters
$e : Exception
Return values
string

isCritical()

Checks if an exception is considered critical.

public isCritical() : bool
Return values
bool

logError()

Logs details of the error.

public logError() : mixed

mailError()

Sends details of the error to a configured email address.

public mailError() : mixed

toString()

Creates a string representation of the error.

public toString([bool $verbose = false ]) : string

This is useful when logging or mailing the error and displays full details of the error and where it occurred, including a full stack trace.

Parameters
$verbose : bool = false
  • Whether to display full details
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results