HumHub Documentation (unofficial)

EmailTarget extends Target
in package

Application

EmailTarget sends selected log messages to the specified email addresses.

You may configure the email to be sent by setting the [[message]] property, through which you can set the target email addresses, subject, etc.:

'components' => [
    'log' => [
         'targets' => [
             [
                 'class' => 'yii\log\EmailTarget',
                 'mailer' => 'mailer',
                 'levels' => ['error', 'warning'],
                 'message' => [
                     'from' => ['log@example.com'],
                     'to' => ['developer1@example.com', 'developer2@example.com'],
                     'subject' => 'Log message',
                 ],
             ],
         ],
    ],
],

In the above mailer is ID of the component that sends email and should be already configured.

Properties

$behaviors : array<string|int, Behavior>
$categories : array<string|int, mixed>
$enabled : bool
$except : array<string|int, mixed>
$exportInterval : int
$levels : int
$logVars : array<string|int, mixed>
$mailer : MailerInterface|array<string|int, mixed>|string
$maskVars : array<string|int, mixed>
$message : array<string|int, mixed>
$messages : array<string|int, mixed>
$microtime : bool
$prefix : callable|null
$_behaviors : array<string|int, Behavior>|null
$_enabled : mixed
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>
$_levels : mixed

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.
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.
collect() : mixed: Processes the given log messages.
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.
export() : mixed: Sends log messages to specified email addresses.
filterMessages() : array<string|int, mixed>: Filters the given messages according to their categories and levels.
formatMessage() : string: Formats a log message for display as a string.
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getEnabled() : bool: Check whether the log target is enabled.
getLevels() : int
getMessagePrefix() : string: Returns a string to be prefixed to the given message.
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.
init() : mixed: Initializes the object.
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
setEnabled() : mixed: Sets a value indicating whether this log target is enabled.
setLevels() : mixed: Sets the message levels that this target is interested in.
trigger() : mixed: Triggers an event.
composeMessage() : MessageInterface: Composes a mail message with the given body content.
getContextMessage() : string: Generates the context information to be logged.
getTime() : string: Returns formatted ('Y-m-d H:i:s') timestamp for message.
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$categories


    public
        array<string|int, mixed>
    $categories
     = []

list of message categories that this target is interested in. Defaults to empty, meaning all categories. You can use an asterisk at the end of a category so that the category may be used to match those categories sharing the same common prefix. For example, 'yii\db*' will match categories starting with 'yii\db', such as 'yii\db\Connection'.

$enabled


    public
        bool
    $enabled

Indicates whether this log target is enabled. Defaults to true. Note that the type of this property differs in getter and setter. See [[getEnabled()]] and [[setEnabled()]] for details.

$except


    public
        array<string|int, mixed>
    $except
     = []

list of message categories that this target is NOT interested in. Defaults to empty, meaning no uninteresting messages. If this property is not empty, then any category listed here will be excluded from [[categories]]. You can use an asterisk at the end of a category so that the category can be used to match those categories sharing the same common prefix. For example, 'yii\db*' will match categories starting with 'yii\db', such as 'yii\db\Connection'.

$exportInterval


    public
        int
    $exportInterval
     = 1000

how many messages should be accumulated before they are exported. Defaults to 1000. Note that messages will always be exported when the application terminates. Set this property to be 0 if you don't want to export messages until the application terminates.

$levels


    public
        int
    $levels

The message levels that this target is interested in. This is a bitmap of level values. Defaults to 0, meaning all available levels. Note that the type of this property differs in getter and setter. See [[getLevels()]] and [[setLevels()]] for details.

For more details and usage information on Target, see the guide article on logging & targets.

$logVars


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

list of the PHP predefined variables that should be logged in a message. Note that a variable must be accessible via $GLOBALS. Otherwise it won't be logged.

Defaults to ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION', '_SERVER'].

Since version 2.0.9 additional syntax can be used: Each element could be specified as one of the following:

var - var will be logged.
var.key - only var[key] key will be logged.
!var.key - var[key] key will be excluded.

Note that if you need $_SESSION to logged regardless if session was used you have to open it right at the start of your request.

$mailer


    public
        MailerInterface|array<string|int, mixed>|string
    $mailer
     = 'mailer'

the mailer object or the application component ID of the mailer object. After the EmailTarget object is created, if you want to change this property, you should only assign it with a mailer object. Starting from version 2.0.2, this can also be a configuration array for creating the object.

$maskVars


    public
        array<string|int, mixed>
    $maskVars
     = ['_SERVER.HTTP_AUTHORIZATION', '_SERVER.PHP_AUTH_USER', '_SERVER.PHP_AUTH_PW']

list of the PHP predefined variables that should NOT be logged "as is" and should always be replaced with a mask *** before logging, when exist.

Defaults to [ '_SERVER.HTTP_AUTHORIZATION', '_SERVER.PHP_AUTH_USER', '_SERVER.PHP_AUTH_PW']

Each element could be specified as one of the following:

var - var will be logged as ***
var.key - only var[key] will be logged as ***

$message


    public
        array<string|int, mixed>
    $message
     = []

the configuration array for creating a [[\yii\mail\MessageInterface|message]] object. Note that the "to" option must be set, which specifies the destination email address(es).

$messages


    public
        array<string|int, mixed>
    $messages
     = []

the messages that are retrieved from the logger so far by this log target. Please refer to [[Logger::messages]] for the details about the message structure.

$microtime


    public
        bool
    $microtime
     = false

whether to log time with microseconds. Defaults to false.

$prefix


    public
        callable|null
    $prefix

a PHP callable that returns a string to be prefixed to every exported message.

If not set, [[getMessagePrefix()]] will be used, which prefixes the message with context information such as user IP, user ID and session ID.

The signature of the callable should be function ($message).

$_behaviors


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

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

$_enabled


    private
        mixed
    $_enabled
     = true

$_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)

$_levels


    private
        mixed
    $_levels
     = 0

__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

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

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

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

__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

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.

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

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

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

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

collect()

Processes the given log messages.


    public
                    collect(array<string|int, mixed> $messages, bool $final) : mixed

This method will filter the given messages with [[levels]] and [[categories]]. And if requested, it will also export the filtering result to specific medium (e.g. email).

Parameters

$messages : array<string|int, mixed>: log messages to be processed. See [[Logger::messages]] for the structure of each message.
$final : bool: whether this method is called at the end of the current application

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

export()

Sends log messages to specified email addresses.


    public
                    export() : mixed

Starting from version 2.0.14, this method throws LogRuntimeException in case the log can not be exported.

filterMessages()

Filters the given messages according to their categories and levels.


    public
            static        filterMessages(array<string|int, mixed> $messages[, int $levels = 0 ][, array<string|int, mixed> $categories = [] ][, array<string|int, mixed> $except = [] ]) : array<string|int, mixed>

Parameters

$messages : array<string|int, mixed>: messages to be filtered. The message structure follows that in [[Logger::messages]].
$levels : int = 0: the message levels to filter by. This is a bitmap of level values. Value 0 means allowing all levels.
$categories : array<string|int, mixed> = []: the message categories to filter by. If empty, it means all categories are allowed.
$except : array<string|int, mixed> = []: the message categories to exclude. If empty, it means all categories are allowed.

Return values

array<string|int, mixed> —

the filtered messages.

formatMessage()

Formats a log message for display as a string.


    public
                    formatMessage(array<string|int, mixed> $message) : string

Parameters

$message : array<string|int, mixed>: the log message to be formatted. The message structure follows that in [[Logger::messages]].

Return values

string —

the formatted message

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

getEnabled()

Check whether the log target is enabled.


    public
                    getEnabled() : bool

Return values

bool —

A value indicating whether this log target is enabled.

getLevels()


    public
                    getLevels() : int

Return values

int —

the message levels that this target is interested in. This is a bitmap of level values. Defaults to 0, meaning all available levels.

getMessagePrefix()

Returns a string to be prefixed to the given message.


    public
                    getMessagePrefix(array<string|int, mixed> $message) : string

If [[prefix]] is configured it will return the result of the callback. The default implementation will return user IP, user ID and session ID as a prefix.

Parameters

$message : array<string|int, mixed>: the message being exported. The message structure follows that in [[Logger::messages]].

Return values

string —

the prefix string

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

Return values

bool —

whether the property is defined

init()

Initializes the object.


    public
                    init() : mixed

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.

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.

setEnabled()

Sets a value indicating whether this log target is enabled.


    public
                    setEnabled(bool|callable $value) : mixed

Parameters

$value : bool|callable

a boolean value or a callable to obtain the value from. The callable value is available since version 2.0.13.

A callable may be used to determine whether the log target should be enabled in a dynamic way. For example, to only enable a log if the current user is logged in you can configure the target as follows:

'enabled' => function() {
    return !Yii::$app->user->isGuest;
}

setLevels()

Sets the message levels that this target is interested in.


    public
                    setLevels(array<string|int, mixed>|int $levels) : mixed

The parameter can be either an array of interested level names or an integer representing the bitmap of the interested level values. Valid level names include: 'error', 'warning', 'info', 'trace' and 'profile'; valid level values include: [[Logger::LEVEL_ERROR]], [[Logger::LEVEL_WARNING]], [[Logger::LEVEL_INFO]], [[Logger::LEVEL_TRACE]] and [[Logger::LEVEL_PROFILE]].

For example,

['error', 'warning']
// which is equivalent to:
Logger::LEVEL_ERROR | Logger::LEVEL_WARNING

Parameters

$levels : array<string|int, mixed>|int: message levels that this target is interested in.

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.

composeMessage()

Composes a mail message with the given body content.


    protected
                    composeMessage(string $body) : MessageInterface

Parameters

$body : string: the body content

Return values

MessageInterface —

$message

getContextMessage()

Generates the context information to be logged.


    protected
                    getContextMessage() : string

The default implementation will dump user information, system variables, etc.

Return values

string —

the context information. If an empty string, it means no context information.

getTime()

Returns formatted ('Y-m-d H:i:s') timestamp for message.


    protected
                    getTime(float $timestamp) : string

If [[microtime]] is configured to true it will return format 'Y-m-d H:i:s.u'.

Parameters

$timestamp : float

Return values

string

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.

EmailTarget extends Target in package Application

Tags

Table of Contents

Properties

Methods

Properties

$behaviors read-only

$categories

$enabled

$except

Tags

$exportInterval

$levels

$logVars

Tags

$mailer

$maskVars

Tags

$message

$messages

$microtime

Tags

$prefix

$_behaviors

$_enabled

$_events

$_eventWildcards

Tags

$_levels

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

attachBehavior()

Parameters

Tags

Return values

attachBehaviors()

Parameters

Tags

behaviors()

Return values

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

Tags

Return values

className()

Tags

Return values

collect()

Parameters

EmailTarget extends Target
in package

Application