0 follower

Final Class Yiisoft\ActiveRecord\Event\BeforeSave

All Classes | Properties | Methods
InheritanceYiisoft\ActiveRecord\Event\BeforeSave » Yiisoft\ActiveRecord\Event\AbstractEvent
ImplementsPsr\EventDispatcher\StoppableEventInterface

Event triggered before the model is saved (inserted or updated) to the database.

It allows to modify properties that will be used for Yiisoft\ActiveRecord\ActiveRecordInterface::save() operation.

See also Yiisoft\ActiveRecord\ActiveRecordInterface::save().

Public Properties

Hide inherited properties

Property Type Description Defined By
$model Yiisoft\ActiveRecord\ActiveRecordInterface Yiisoft\ActiveRecord\Event\AbstractEvent
$properties array|null Yiisoft\ActiveRecord\Event\BeforeSave

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\ActiveRecord\Event\BeforeSave
getReturnValue() Returns the value that will be returned by the method that triggered this event if the AbstractEvent::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 AbstractEvent::isDefaultPrevented() default action is prevented. Yiisoft\ActiveRecord\Event\AbstractEvent
stopPropagation() Stops the propagation of the event to further listeners. Yiisoft\ActiveRecord\Event\AbstractEvent

Property Details

Hide inherited properties

$properties public property
public array|null $properties = null

Method Details

Hide inherited methods

__construct() public method

public __construct( Yiisoft\ActiveRecord\ActiveRecordInterface $model, array|null &$properties ): mixed
$model Yiisoft\ActiveRecord\ActiveRecordInterface

The model that is being saved.
$properties array|null

The properties that will be used for the save operation.

 

                public function __construct(ActiveRecordInterface $model, public ?array &$properties)
{
    parent::__construct($model);
}
getReturnValue() public method

Defined in: Yiisoft\ActiveRecord\Event\AbstractEvent::getReturnValue()

Returns the value that will be returned by the method that triggered this event if the AbstractEvent::isDefaultPrevented() default action is prevented.

public getReturnValue( ): mixed

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

Defined in: Yiisoft\ActiveRecord\Event\AbstractEvent::isDefaultPrevented()

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

public isDefaultPrevented( ): boolean

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

Defined in: Yiisoft\ActiveRecord\Event\AbstractEvent::isPropagationStopped()

public isPropagationStopped( ): boolean

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

Defined in: Yiisoft\ActiveRecord\Event\AbstractEvent::preventDefault()

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

See also Yiisoft\ActiveRecord\Event\AbstractEvent::returnValue().

public preventDefault( ): void

                public function preventDefault(): void
{
    $this->isDefaultPrevented = true;
}
returnValue() public method

Defined in: Yiisoft\ActiveRecord\Event\AbstractEvent::returnValue()

Sets the return value which will be returned by the method that triggered this event if the AbstractEvent::isDefaultPrevented() default action is prevented.

See also Yiisoft\ActiveRecord\Event\AbstractEvent::preventDefault().

public returnValue( mixed $returnValue ): void
$returnValue mixed 

                public function returnValue(mixed $returnValue): void
{
    $this->returnValue = $returnValue;
}
stopPropagation() public method

Defined in: Yiisoft\ActiveRecord\Event\AbstractEvent::stopPropagation()

Stops the propagation of the event to further listeners.

No further listeners will be notified after this method is called.

public stopPropagation( ): void

                public function stopPropagation(): void
{
    $this->isPropagationStopped = true;
}