MichaelRubel\EnhancedPipeline\Traits\HasEvents

Complexity

Total Complexity

5

Size/Duplication

Total Lines	53
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	withEvents()	0	5	1
A	fireStartedEvent()	0	7	2
A	firePassedEvent()	0	7	2

<?php

declare(strict_types=1);

namespace MichaelRubel\EnhancedPipeline\Traits;

use MichaelRubel\EnhancedPipeline\Events\PipePassed;
use MichaelRubel\EnhancedPipeline\Events\PipeStarted;

trait HasEvents
{
    /**
     * Determines whether pipeline uses events.
     *
     * @var bool
     */
    protected bool $useEvents = false;

    /**
     * Enable events in pipeline.
     *
     * @return static
     */
    public function withEvents(): static
    {
        $this->useEvents = true;

        return $this;
    }

    /**
     * Fire the started event if enabled.
     *
     * @param  mixed  $pipe
     * @param  mixed  $passable
     *
     * @return void
     */
    protected function fireStartedEvent($pipe, $passable): void
    {
        if (! $this->useEvents) {
            return;
        }

        event(new PipeStarted($pipe, $passable));
    }

    /**
     * Fire the passed event if enabled.
     *
     * @param  mixed  $pipe
     * @param  mixed  $passable
     *
     * @return void
     */
    protected function firePassedEvent($pipe, $passable): void
    {
        if (! $this->useEvents) {
            return;
        }

        event(new PipePassed($pipe, $passable));
    }
}