0 follower

Abstract Class Yiisoft\ActiveRecord\Event\AbstractEvent

All Classes | Properties | Methods

Inheritance	Yiisoft\ActiveRecord\Event\AbstractEvent
Implements	Psr\EventDispatcher\StoppableEventInterface
Subclasses	Yiisoft\ActiveRecord\Event\AfterCreateQuery, Yiisoft\ActiveRecord\Event\AfterDelete, Yiisoft\ActiveRecord\Event\AfterInsert, Yiisoft\ActiveRecord\Event\AfterPopulate, Yiisoft\ActiveRecord\Event\AfterSave, Yiisoft\ActiveRecord\Event\AfterUpdate, Yiisoft\ActiveRecord\Event\AfterUpsert, Yiisoft\ActiveRecord\Event\BeforeCreateQuery, Yiisoft\ActiveRecord\Event\BeforeDelete, Yiisoft\ActiveRecord\Event\BeforeInsert, Yiisoft\ActiveRecord\Event\BeforePopulate, Yiisoft\ActiveRecord\Event\BeforeSave, Yiisoft\ActiveRecord\Event\BeforeUpdate, Yiisoft\ActiveRecord\Event\BeforeUpsert

Base class for events in Active Record models.

Public Properties

Property	Type	Description	Defined By
$model	Yiisoft\ActiveRecord\ActiveRecordInterface		Yiisoft\ActiveRecord\Event\AbstractEvent

Method	Description	Defined By
__construct()		Yiisoft\ActiveRecord\Event\AbstractEvent
getReturnValue()	Returns the value that will be returned by the method that triggered this event if the {@see isDefaultPrevented() default action is prevented}.	Yiisoft\ActiveRecord\Event\AbstractEvent
isDefaultPrevented()	Checks if the default action associated with this event has been prevented.	Yiisoft\ActiveRecord\Event\AbstractEvent
isPropagationStopped()		Yiisoft\ActiveRecord\Event\AbstractEvent
preventDefault()	Prevents the default action associated with this event from being executed.	Yiisoft\ActiveRecord\Event\AbstractEvent
returnValue()	Sets the return value which will be returned by the method that triggered this event if the {@see isDefaultPrevented() default action is prevented}.	Yiisoft\ActiveRecord\Event\AbstractEvent
stopPropagation()	Stops the propagation of the event to further listeners.	Yiisoft\ActiveRecord\Event\AbstractEvent

$model public property

__construct() public method

public mixed __construct ( Yiisoft\ActiveRecord\ActiveRecordInterface $model )
$model	Yiisoft\ActiveRecord\ActiveRecordInterface	The target model associated with this event.

                public function __construct(
    public readonly ActiveRecordInterface $model,
) {}

getReturnValue() public method

Returns the value that will be returned by the method that triggered this event if the {@see isDefaultPrevented() default action is prevented}.

public mixed getReturnValue ( )

                public function getReturnValue(): mixed
{
    return $this->returnValue;
}

isDefaultPrevented() public method

Checks if the default action associated with this event has been prevented.

public boolean isDefaultPrevented ( )

                public function isDefaultPrevented(): bool
{
    return $this->isDefaultPrevented;
}

isPropagationStopped() public method

public boolean isPropagationStopped ( )

                public function isPropagationStopped(): bool
{
    return $this->isPropagationStopped;
}

preventDefault() public method

Prevents the default action associated with this event from being executed.

public void returnValue ( mixed $returnValue )
$returnValue	mixed