HumHub Documentation (unofficial)

ErrorHandler extends ErrorHandler
in package

ErrorHandler handles uncaught PHP errors and exceptions.

ErrorHandler displays these errors using appropriate views based on the nature of the errors and the mode the application runs at.

ErrorHandler is configured as an application component in [[\yii\base\Application]] by default. You can access that instance via Yii::$app->errorHandler.

For more details and usage information on ErrorHandler, see the guide article on handling errors.

Tags
author

Qiang Xue qiang.xue@gmail.com

author

Timur Ruziev resurtm@gmail.com

since
2.0

Table of Contents

Constants

EVENT_SHUTDOWN  = 'shutdown'

Properties

$behaviors  : array<string|int, Behavior>
$callStackItemView  : string
$discardExistingOutput  : bool
$displayVars  : array<string|int, mixed>
$errorAction  : string|null
$errorView  : string
$exception  : Throwable|null
$exceptionView  : string
$maxSourceLines  : int
$maxTraceSourceLines  : int
$memoryReserveSize  : int
$previousExceptionView  : string
$silentExitOnException  : bool
$traceLine  : string
$_behaviors  : array<string|int, Behavior>|null
$_events  : array<string|int, mixed>
$_eventWildcards  : array<string|int, mixed>
$_hhvmException  : Throwable
$_memoryReserve  : string
$_registered  : bool
$_workingDirectory  : string

Methods

__call()  : mixed
Calls the named method which is not a class method.
__clone()  : mixed
This method is called after the object is created by cloning an existing one.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of a component property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets the value of a component property.
__unset()  : mixed
Sets a component property to be null.
addTypeLinks()  : string
Adds informational links to the given PHP type/class.
argumentsToString()  : string
Converts arguments array to its string representation.
attachBehavior()  : Behavior
Attaches a behavior to this component.
attachBehaviors()  : mixed
Attaches a list of behaviors to the component.
behaviors()  : array<string|int, mixed>
Returns a list of behaviors that this component should behave as.
canGetProperty()  : bool
Returns a value indicating whether a property can be read.
canSetProperty()  : bool
Returns a value indicating whether a property can be set.
className()  : string
Returns the fully qualified name of this class.
clearOutput()  : mixed
Removes all output echoed before calling this method.
convertExceptionToError()  : never
Converts an exception into a PHP error.
convertExceptionToString()  : string
Converts an exception into a simple string.
convertExceptionToVerboseString()  : string
Converts an exception into a string that has verbose information about the exception and its trace.
createFrameworkVersionLink()  : string
Creates string containing HTML link which refers to the page with the current version of the framework and version number text.
createHttpStatusLink()  : string
Creates HTML containing link to the page with the information on given HTTP status code.
createServerInformationLink()  : string
Creates string containing HTML link which refers to the home page of determined web-server software and its full name.
detachBehavior()  : Behavior|null
Detaches a behavior from the component.
detachBehaviors()  : mixed
Detaches all behaviors from the component.
ensureBehaviors()  : mixed
Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
getBehavior()  : Behavior|null
Returns the named behavior object.
getBehaviors()  : array<string|int, Behavior>
Returns all behaviors attached to this component.
getExceptionName()  : string|null
Returns human-readable exception name.
handleError()  : bool
Handles PHP execution errors such as warnings and notices.
handleException()  : mixed
Handles uncaught PHP exceptions.
handleFatalError()  : mixed
Handles fatal PHP errors.
handleHhvmError()  : bool
Handles HHVM execution errors such as warnings and notices.
hasEventHandlers()  : bool
Returns a value indicating whether there is any handler attached to the named event.
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasProperty()  : bool
Returns a value indicating whether a property is defined for this component.
htmlEncode()  : string
Converts special characters to HTML entities.
init()  : mixed
Initializes the object.
isCoreFile()  : bool
Determines whether given name of the file belongs to the framework.
logException()  : mixed
Logs the given exception.
off()  : bool
Detaches an existing event handler from this component.
on()  : mixed
Attaches an event handler to an event.
register()  : mixed
Register this error handler.
renderCallStack()  : string
Renders call stack.
renderCallStackItem()  : string
Renders a single call stack element.
renderFile()  : string
Renders a view file as a PHP script.
renderPreviousExceptions()  : string
Renders the previous exception stack for a given Exception.
renderRequest()  : string
Renders the global variables of the request.
trigger()  : mixed
Triggers an event.
unregister()  : mixed
Unregisters this error handler by restoring the PHP error and exception handlers.
convertExceptionToArray()  : array<string|int, mixed>
Converts an exception into an array.
getTypeUrl()  : string|null
Returns the informational link URL for a given PHP type/class.
handleFallbackExceptionMessage()  : mixed
Handles exception thrown during exception processing in [[handleException()]].
renderException()  : mixed
Renders the exception.
shouldRenderSimpleHtml()  : bool
attachBehaviorInternal()  : Behavior
Attaches a behavior to this component.

Constants

EVENT_SHUTDOWN

public mixed EVENT_SHUTDOWN = 'shutdown'
Tags
event

Event an event that is triggered when the handler is called by shutdown function via [[handleFatalError()]].

since
2.0.46

Properties

$behaviors read-only

public array<string|int, Behavior> $behaviors

List of behaviors attached to this component.

$callStackItemView

public string $callStackItemView = '@yii/views/errorHandler/callStackItem.php'

the path of the view file for rendering exceptions and errors call stack element.

$discardExistingOutput

public bool $discardExistingOutput = true

whether to discard any existing page output before error display. Defaults to true.

$displayVars

public array<string|int, mixed> $displayVars = ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION']

list of the PHP predefined variables that should be displayed on the error page. Note that a variable must be accessible via $GLOBALS. Otherwise it won't be displayed. Defaults to ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION'].

Tags
see
renderRequest()
since
2.0.7

$errorAction

public string|null $errorAction

the route (e.g. site/error) to the controller action that will be used to display external errors. Inside the action, it can retrieve the error information using Yii::$app->errorHandler->exception. This property defaults to null, meaning ErrorHandler will handle the error display.

$errorView

public string $errorView = '@yii/views/errorHandler/error.php'

the path of the view file for rendering exceptions without call stack information.

$exception

public Throwable|null $exception

the exception that is being handled currently.

$exceptionView

public string $exceptionView = '@yii/views/errorHandler/exception.php'

the path of the view file for rendering exceptions.

$maxSourceLines

public int $maxSourceLines = 19

maximum number of source code lines to be displayed. Defaults to 19.

$maxTraceSourceLines

public int $maxTraceSourceLines = 13

maximum number of trace source code lines to be displayed. Defaults to 13.

$memoryReserveSize

public int $memoryReserveSize = 262144

the size of the reserved memory. A portion of memory is pre-allocated so that when an out-of-memory issue occurs, the error handler is able to handle the error with the help of this reserved memory. If you set this value to be 0, no memory will be reserved. Defaults to 256KB.

$previousExceptionView

public string $previousExceptionView = '@yii/views/errorHandler/previousException.php'

the path of the view file for rendering previous exceptions.

$silentExitOnException

public bool $silentExitOnException

if true - handleException() will finish script with ExitCode::OK. false - ExitCode::UNSPECIFIED_ERROR.

Tags
since
2.0.36

$_behaviors

private array<string|int, Behavior>|null $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events

private array<string|int, mixed> $_events = []

the attached event handlers (event name => handlers)

$_eventWildcards

private array<string|int, mixed> $_eventWildcards = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

Tags
since
2.0.14

$_hhvmException

private Throwable $_hhvmException

from HHVM error that stores backtrace

$_memoryReserve

private string $_memoryReserve

Used to reserve memory for fatal error handler.

$_registered

private bool $_registered = false

whether this instance has been registered using register()

$_workingDirectory

private string $_workingDirectory

the current working directory

Methods

__call()

Calls the named method which is not a class method.

public __call(string $name, array<string|int, mixed> $params) : mixed

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters
$name : string

the method name

$params : array<string|int, mixed>

method parameters

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed

the method return value

__clone()

This method is called after the object is created by cloning an existing one.

public __clone() : mixed

It removes all behaviors because they are attached to the old object.

__construct()

Constructor.

public __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call [[init()]].

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
Parameters
$config : array<string|int, mixed> = []

name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.

public __get(string $name) : mixed

This method will check in the following order and act accordingly:

  • a property defined by a getter: return the getter result
  • a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only.

see
__set()
Return values
mixed

the property value or the value of a behavior's property

__isset()

Checks if a property is set, i.e. defined and not null.

public __isset(string $name) : bool

This method will check in the following order and act accordingly:

  • a property defined by a setter: return whether the property is set
  • a property of a behavior: return whether the property is set
  • return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool

whether the named property is set

__set()

Sets the value of a component property.

public __set(string $name, mixed $value) : mixed

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value
  • an event in the format of "on xyz": attach the handler to the event "xyz"
  • a behavior in the format of "as xyz": attach the behavior named as "xyz"
  • a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only.

see
__get()

__unset()

Sets a component property to be null.

public __unset(string $name) : mixed

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value to be null
  • a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

Adds informational links to the given PHP type/class.

public addTypeLinks(string $code) : string
Parameters
$code : string

type/class name to be linkified.

Return values
string

linkified with HTML type/class name.

argumentsToString()

Converts arguments array to its string representation.

public argumentsToString(array<string|int, mixed> $args) : string
Parameters
$args : array<string|int, mixed>

arguments array to be converted

Return values
string

string representation of the arguments array

attachBehavior()

Attaches a behavior to this component.

public attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the [[Behavior::attach()]] method.

Parameters
$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

the behavior configuration. This can be one of the following:

  • a [[Behavior]] object
  • a string specifying the behavior class
  • an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.
Tags
see
detachBehavior()
Return values
Behavior

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.

public attachBehaviors(array<string|int, mixed> $behaviors) : mixed

Each behavior is indexed by its name and should be a [[Behavior]] object, a string specifying the behavior class, or an configuration array for creating the behavior.

Parameters
$behaviors : array<string|int, mixed>

list of behaviors to be attached to the component

Tags
see
attachBehavior()

behaviors()

Returns a list of behaviors that this component should behave as.

public behaviors() : array<string|int, mixed>

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from [[Behavior]]. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using [[getBehavior()]] or be detached using [[detachBehavior()]]. Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Return values
array<string|int, mixed>

the behavior configurations.

canGetProperty()

Returns a value indicating whether a property can be read.

public canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be read if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a readable property of the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

$checkBehaviors : bool = true

whether to treat behaviors' properties as properties of this component

Tags
see
canSetProperty()
Return values
bool

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.

public canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be written if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a writable property of the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

$checkBehaviors : bool = true

whether to treat behaviors' properties as properties of this component

Tags
see
canGetProperty()
Return values
bool

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string

the fully qualified name of this class.

clearOutput()

Removes all output echoed before calling this method.

public clearOutput() : mixed

convertExceptionToError()

Converts an exception into a PHP error.

public static convertExceptionToError(Throwable $exception) : never

This method can be used to convert exceptions inside of methods like __toString() to PHP errors because exceptions cannot be thrown inside of them.

Parameters
$exception : Throwable

the exception to convert to a PHP error.

Return values
never

convertExceptionToString()

Converts an exception into a simple string.

public static convertExceptionToString(Throwable $exception) : string
Parameters
$exception : Throwable

the exception being converted

Return values
string

the string representation of the exception.

convertExceptionToVerboseString()

Converts an exception into a string that has verbose information about the exception and its trace.

public static convertExceptionToVerboseString(Throwable $exception) : string
Parameters
$exception : Throwable

the exception being converted

Tags
since
2.0.14
Return values
string

the string representation of the exception.

Creates string containing HTML link which refers to the page with the current version of the framework and version number text.

public createFrameworkVersionLink() : string
Return values
string

framework version information hyperlink.

Creates HTML containing link to the page with the information on given HTTP status code.

public createHttpStatusLink(int $statusCode, string $statusDescription) : string
Parameters
$statusCode : int

to be used to generate information link.

$statusDescription : string

Description to display after the the status code.

Return values
string

generated HTML with HTTP status code information.

Creates string containing HTML link which refers to the home page of determined web-server software and its full name.

public createServerInformationLink() : string
Return values
string

server software information hyperlink.

detachBehavior()

Detaches a behavior from the component.

public detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters
$name : string

the behavior's name.

Return values
Behavior|null

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.

public detachBehaviors() : mixed

ensureBehaviors()

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.

public ensureBehaviors() : mixed

getBehavior()

Returns the named behavior object.

public getBehavior(string $name) : Behavior|null
Parameters
$name : string

the behavior name

Return values
Behavior|null

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.

public getBehaviors() : array<string|int, Behavior>
Return values
array<string|int, Behavior>

list of behaviors attached to this component

getExceptionName()

Returns human-readable exception name.

public getExceptionName(Throwable $exception) : string|null
Parameters
$exception : Throwable
Return values
string|null

human-readable exception name or null if it cannot be determined

handleError()

Handles PHP execution errors such as warnings and notices.

public handleError(int $code, string $message, string $file, int $line) : bool

This method is used as a PHP error handler. It will simply raise an [[ErrorException]].

Parameters
$code : int

the level of the error raised.

$message : string

the error message.

$file : string

the filename that the error was raised in.

$line : int

the line number the error was raised at.

Tags
throws
ErrorException
Return values
bool

whether the normal error handler continues.

handleException()

Handles uncaught PHP exceptions.

public handleException(Throwable $exception) : mixed

This method is implemented as a PHP exception handler.

Parameters
$exception : Throwable

the exception that is not caught

handleFatalError()

Handles fatal PHP errors.

public handleFatalError() : mixed

handleHhvmError()

Handles HHVM execution errors such as warnings and notices.

public handleHhvmError(int $code, string $message, string $file, int $line, mixed $context, mixed $backtrace) : bool

This method is used as a HHVM error handler. It will store exception that will be used in fatal error handler

Parameters
$code : int

the level of the error raised.

$message : string

the error message.

$file : string

the filename that the error was raised in.

$line : int

the line number the error was raised at.

$context : mixed
$backtrace : mixed

trace of error

Tags
throws
ErrorException
since
2.0.6
Return values
bool

whether the normal error handler continues.

hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.

public hasEventHandlers(string $name) : bool
Parameters
$name : string

the event name

Return values
bool

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

A method is defined if:

  • the class has a method with the specified name
  • an attached behavior has a method with the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkBehaviors : bool = true

whether to treat behaviors' methods as methods of this component

Return values
bool

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined for this component.

public hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a property of the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

$checkBehaviors : bool = true

whether to treat behaviors' properties as properties of this component

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool

whether the property is defined

htmlEncode()

Converts special characters to HTML entities.

public htmlEncode(string $text) : string
Parameters
$text : string

to encode.

Return values
string

encoded original text.

init()

Initializes the object.

public init() : mixed

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

isCoreFile()

Determines whether given name of the file belongs to the framework.

public isCoreFile(string $file) : bool
Parameters
$file : string

name to be checked.

Return values
bool

whether given name of the file belongs to the framework.

logException()

Logs the given exception.

public logException(Throwable $exception) : mixed
Parameters
$exception : Throwable

the exception to be logged

Tags
since
2.0.3

this method is now public.

off()

Detaches an existing event handler from this component.

public off(string $name[, callable|null $handler = null ]) : bool

This method is the opposite of [[on()]].

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters
$name : string

event name

$handler : callable|null = null

the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Tags
see
on()
Return values
bool

if a handler is found and detached

on()

Attaches an event handler to an event.

public on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an [[Event]] object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});
Parameters
$name : string

the event name

$handler : callable

the event handler

$data : mixed = null

the data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via [[Event::data]].

$append : bool = true

whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

Tags
see
off()

register()

Register this error handler.

public register() : mixed
Tags
since
2.0.32

this will not do anything if the error handler was already registered

renderCallStack()

Renders call stack.

public renderCallStack(Throwable $exception) : string
Parameters
$exception : Throwable

exception to get call stack from

Tags
since
2.0.12
Return values
string

HTML content of the rendered call stack.

renderCallStackItem()

Renders a single call stack element.

public renderCallStackItem(string|null $file, int|null $line, string|null $class, string|null $method, array<string|int, mixed> $args, int $index) : string
Parameters
$file : string|null

name where call has happened.

$line : int|null

number on which call has happened.

$class : string|null

called class name.

$method : string|null

called function/method name.

$args : array<string|int, mixed>

array of method arguments.

$index : int

number of the call stack element.

Return values
string

HTML content of the rendered call stack element.

renderFile()

Renders a view file as a PHP script.

public renderFile(string $_file_, array<string|int, mixed> $_params_) : string
Parameters
$_file_ : string

the view file.

$_params_ : array<string|int, mixed>

the parameters (name-value pairs) that will be extracted and made available in the view file.

Return values
string

the rendering result

renderPreviousExceptions()

Renders the previous exception stack for a given Exception.

public renderPreviousExceptions(Throwable $exception) : string
Parameters
$exception : Throwable

the exception whose precursors should be rendered.

Return values
string

HTML content of the rendered previous exceptions. Empty string if there are none.

renderRequest()

Renders the global variables of the request.

public renderRequest() : string

List of global variables is defined in [[displayVars]].

Tags
see
displayVars
Return values
string

the rendering result

trigger()

Triggers an event.

public trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters
$name : string

the event name

$event : Event|null = null

the event instance. If not set, a default [[Event]] object will be created.

unregister()

Unregisters this error handler by restoring the PHP error and exception handlers.

public unregister() : mixed
Tags
since
2.0.32

this will not do anything if the error handler was not registered

convertExceptionToArray()

Converts an exception into an array.

protected convertExceptionToArray(Throwable $exception) : array<string|int, mixed>
Parameters
$exception : Throwable

the exception being converted

Return values
array<string|int, mixed>

the array representation of the exception.

getTypeUrl()

Returns the informational link URL for a given PHP type/class.

protected getTypeUrl(string $class, string|null $method) : string|null
Parameters
$class : string

the type or class name.

$method : string|null

the method name.

Tags
see
addTypeLinks()
Return values
string|null

the informational link URL.

handleFallbackExceptionMessage()

Handles exception thrown during exception processing in [[handleException()]].

protected handleFallbackExceptionMessage(Throwable $exception, Throwable $previousException) : mixed
Parameters
$exception : Throwable

Exception that was thrown during main exception processing.

$previousException : Throwable

Main exception processed in [[handleException()]].

Tags
since
2.0.11

renderException()

Renders the exception.

protected renderException(Throwable $exception) : mixed
Parameters
$exception : Throwable

the exception to be rendered.

shouldRenderSimpleHtml()

protected shouldRenderSimpleHtml() : bool
Tags
since
2.0.12
Return values
bool

if simple HTML should be rendered

attachBehaviorInternal()

Attaches a behavior to this component.

private attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior
Parameters
$name : string|int

the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.

$behavior : string|array<string|int, mixed>|Behavior

the behavior to be attached

Return values
Behavior

the attached behavior.


        
On this page

Search results