CodeIgniter v4.5 API

CastException extends FrameworkException
in package
implements HasExitCodeInterface

CastException is thrown for invalid cast initialization and management.

Table of Contents

Interfaces

HasExitCodeInterface
Interface for Exceptions that has exception code as exit code.

Methods

__construct()  : mixed
Tweaks the exception's constructor to assign the file/line to where it is actually raised rather than were it is instantiated.
forCopyError()  : static
forEnabledZlibOutputCompression()  : static
forFabricatorCreateFailed()  : static
forInvalidDirectory()  : static
forInvalidFile()  : static
forInvalidInterface()  : static
Thrown when the cast class does not extends BaseCast.
forInvalidJsonFormat()  : static
Thrown when the Json format is invalid.
forInvalidMethod()  : static
Thrown when the cast method is not `get` or `set`.
forInvalidTimestamp()  : static
Thrown when the casting timestamp is not correct timestamp.
forMissingExtension()  : static
forNoHandlers()  : static
getExitCode()  : int
Returns exit status code.

Methods

__construct()

Tweaks the exception's constructor to assign the file/line to where it is actually raised rather than were it is instantiated.

public final __construct([string $message = '' ][, int $code = 0 ][, Throwable|null $previous = null ]) : mixed
Parameters
$message : string = ''
$code : int = 0
$previous : Throwable|null = null

forCopyError()

public static forCopyError(string $path) : static
Parameters
$path : string
Return values
static

forEnabledZlibOutputCompression()

public static forEnabledZlibOutputCompression() : static
Return values
static

forFabricatorCreateFailed()

public static forFabricatorCreateFailed(string $table, string $reason) : static
Parameters
$table : string
$reason : string
Return values
static

forInvalidDirectory()

public static forInvalidDirectory(string $path) : static
Parameters
$path : string
Return values
static

forInvalidFile()

public static forInvalidFile(string $path) : static
Parameters
$path : string
Return values
static

forInvalidInterface()

Thrown when the cast class does not extends BaseCast.

public static forInvalidInterface(string $class) : static
Parameters
$class : string
Return values
static

forInvalidJsonFormat()

Thrown when the Json format is invalid.

public static forInvalidJsonFormat(int $error) : static
Parameters
$error : int
Return values
static

forInvalidMethod()

Thrown when the cast method is not `get` or `set`.

public static forInvalidMethod(string $method) : static
Parameters
$method : string
Return values
static

forInvalidTimestamp()

Thrown when the casting timestamp is not correct timestamp.

public static forInvalidTimestamp() : static
Return values
static

forMissingExtension()

public static forMissingExtension(string $extension) : static
Parameters
$extension : string
Tags
deprecated
4.5.0

No longer used.

Return values
static

forNoHandlers()

public static forNoHandlers(string $class) : static
Parameters
$class : string
Return values
static

getExitCode()

Returns exit status code.

public getExitCode() : int
Return values
int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results