Jasny\Auth\Event\CancellableTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	isCancelled()	0	3	1
A	cancel()	0	3	1
A	isPropagationStopped()	0	3	1
A	getCancellationReason()	0	3	1

<?php

declare(strict_types=1);

namespace Jasny\Auth\Event;

/**
 * Trait for cancellable event
 */
trait CancellableTrait
{
    protected ?string $cancelled = null;

    /**
     * Cancel login.
     */
    public function cancel(string $reason): void
    {
        $this->cancelled = $reason;
    }

    /**
     * Is login cancelled?
     */
    public function isCancelled(): bool
    {
        return $this->cancelled !== null;
    }

    /**
     * Get reason why login was cancelled.
     */
    public function getCancellationReason(): string
    {
        return (string)$this->cancelled;
    }

    /**
     * @inheritDoc
     */
    final public function isPropagationStopped(): bool
    {
        return $this->isCancelled();
    }
}