0 follower

Final Class Yiisoft\ActiveRecord\Event\BeforeUpsert

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

Event triggered before the model is upserted (inserted or updated) in the database.

It allows to modify properties that will be used for {@see \Yiisoft\ActiveRecord\ActiveRecordInterface::upsert()} operation.

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

Public Properties

Hide inherited properties

Property Type Description Defined By
$insertProperties array|null Yiisoft\ActiveRecord\Event\BeforeUpsert
$model Yiisoft\ActiveRecord\ActiveRecordInterface Yiisoft\ActiveRecord\Event\AbstractEvent
$updateProperties array|boolean Yiisoft\ActiveRecord\Event\BeforeUpsert

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\ActiveRecord\Event\BeforeUpsert
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

Property Details

Hide inherited properties

$insertProperties public property
public array|null $insertProperties = null
$updateProperties public property
public array|boolean $updateProperties = null

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( Yiisoft\ActiveRecord\ActiveRecordInterface $model, array|null &$insertProperties, array|boolean &$updateProperties )
$model Yiisoft\ActiveRecord\ActiveRecordInterface

The model being upserted.
$insertProperties array|null

Properties to be inserted. If null, the properties will be taken from the model.
$updateProperties array|boolean

Properties to be updated. If false, no properties will be updated. If true, $insertProperties will be used for update as well.

 

                public function __construct(
    ActiveRecordInterface $model,
    public ?array &$insertProperties,
    public array|bool &$updateProperties,
) {
    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 {@see isDefaultPrevented() default action is prevented}.

public mixed getReturnValue ( )

                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 boolean isDefaultPrevented ( )

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

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

public boolean isPropagationStopped ( )

                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 returnValue().

public void preventDefault ( )

                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 {@see isDefaultPrevented() default action is prevented}.

See also preventDefault().

public void returnValue ( mixed $returnValue )
$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 void stopPropagation ( )

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