HumHub Documentation (unofficial)

SearchAddEvent extends Event
in package

Application

Event is the base class for all event classes.

Properties

$data : mixed
$handled : bool
$name : string
$sender : object|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>

Methods

__call() : mixed: Calls the named method which is not a class method.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of an object property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets value of an object property.
__unset() : mixed: Sets an object property to null.
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.
hasHandlers() : bool: Returns a value indicating whether there is any handler attached to the specified class-level event.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined.
init() : mixed: Initializes the object.
off() : bool: Detaches an event handler from a class-level event.
offAll() : mixed: Detaches all registered class-level event handlers.
on() : mixed: Attaches an event handler to a class-level event.
trigger() : mixed: Triggers a class-level event.

$data


    public
        mixed
    $data

the data that is passed to [[Component::on()]] when attaching an event handler. Note that this varies according to which event handler is currently executing.

$handled


    public
        bool
    $handled
     = false

whether the event is handled. Defaults to false. When a handler sets this to be true, the event processing will stop and ignore the rest of the uninvoked event handlers.

$name


    public
        string
    $name

the event name. This property is set by [[Component::trigger()]] and [[trigger()]]. Event handlers may use this property to check what event it is handling.

$sender


    public
        object|null
    $sender

the sender of this event. If not set, this property will be set as the object whose trigger() method is called. This property may also be a null when this event is a class-level event which is triggered in a static context.

$_events


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

contains all globally registered event handlers.

$_eventWildcards


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

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

__call()

Calls the named method which is not a class method.


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

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

__construct()

Constructor.


    public
                    __construct(mixed $attributes) : 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

$attributes : mixed

__get()

Returns the value of an object property.


    public
                    __get(string $name) : mixed

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

Parameters

$name : string: the property name

Return values

mixed —

the property value

__isset()

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


    public
                    __isset(string $name) : bool

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

Note that if the property is not defined, false will be returned.

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set (not null).

__set()

Sets value of an object property.


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

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

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets an object property to null.


    public
                    __unset(string $name) : mixed

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

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

Parameters

$name : string: the property name

canGetProperty()

Returns a value indicating whether a property can be read.


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

A property is readable 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);

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties

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

A property is writable 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);

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties

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.

hasHandlers()

Returns a value indicating whether there is any handler attached to the specified class-level event.


    public
            static        hasHandlers(string|object $class, string $name) : bool

Note that this method will also check all parent classes to see if there is any handler attached to the named event.

Parameters

$class : string|object: the object or the fully qualified class name specifying the class-level event.
$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

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

Parameters

$name : string: the method name

Return values

bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined.


    public
                    hasProperty(string $name[, bool $checkVars = 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);

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties

Return values

bool —

whether the property is defined

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.

off()

Detaches an event handler from a class-level event.


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

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

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

Parameters

$class : string: the fully qualified class name from which the event handler needs to be detached.
$name : string: the 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 —

whether a handler is found and detached.

offAll()

Detaches all registered class-level event handlers.


    public
            static        offAll() : mixed

on()

Attaches an event handler to a class-level event.


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

When a class-level event is triggered, event handlers attached to that class and all parent classes will be invoked.

For example, the following code attaches an event handler to ActiveRecord's afterInsert event:

Event::on(ActiveRecord::class, ActiveRecord::EVENT_AFTER_INSERT, function ($event) {
    Yii::trace(get_class($event->sender) . ' is inserted.');
});

The handler will be invoked for EVERY successful ActiveRecord insertion.

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

Event::on('app\models\db\*', '*Insert', function ($event) {
    Yii::trace(get_class($event->sender) . ' is inserted.');
});

For more details about how to declare an event handler, please refer to [[Component::on()]].

Parameters

$class : string: the fully qualified class name to which the event handler needs to attach.
$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.

trigger()

Triggers a class-level event.


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

This method will cause invocation of event handlers that are attached to the named event for the specified class and all its parent classes.

Parameters

$class : string|object: the object or the fully qualified class name specifying the class-level event.
$name : string: the event name.
$event : Event|null = null: the event parameter. If not set, a default [[Event]] object will be created.

SearchAddEvent extends Event in package Application

Tags

Table of Contents

Properties

Methods

Properties

$data

$handled

$name

$sender

$_events

$_eventWildcards

Tags

Methods

__call()

Parameters

Tags

Return values

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

Tags

Return values

className()

Tags

Return values

hasHandlers()

Parameters

Return values

hasMethod()

Parameters

Return values

hasProperty()

Parameters

Tags

Return values

init()

off()

Parameters

Tags

Return values

offAll()

Tags

on()

Parameters

Tags

trigger()

Parameters

SearchAddEvent extends Event
in package

Application