Signifly\Cancellation\Traits\Cancellable

Complexity

Total Complexity

13

Size/Duplication

Total Lines	134
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	bootCancellable()	0	3	1
A	keeping()	0	3	1
A	cancelled()	0	3	1
A	kept()	0	3	1
A	keep()	0	16	2
A	getCancelledAtColumn()	0	3	2
A	getQualifiedCancelledAtColumn()	0	3	1
A	cancelling()	0	3	1
A	cancel()	0	16	2
A	isCancelled()	0	3	1

<?php

namespace Signifly\Cancellation\Traits;

use Signifly\Cancellation\Scopes\CancellingScope;

trait Cancellable
{
    /**
     * Boot the cancelable trait for a model.
     *
     * @return void
     */
    public static function bootCancellable()
    {
        static::addGlobalScope(new CancellingScope());
    }

    /**
     * Perform the actual cancel query on this model instance.
     *
     * @return bool
     */
    public function cancel()
    {
        if ($this->fireModelEvent('cancelling') === false) {

It seems like fireModelEvent() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return false;
        }

        $time = $this->freshTimestamp();

It seems like freshTimestamp() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->{$this->getCancelledAtColumn()} = $time;
        $this->{$this->getUpdatedAtColumn()} = $time;

It seems like getUpdatedAtColumn() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $result = $this->save();

It seems like save() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->fireModelEvent('cancelled', false);

        return $result;
    }

    /**
     * Register a restoring model event with the dispatcher.
     *
     * @param \Closure|string $callback
     *
     * @return void
     */
    public static function cancelling($callback)
    {
        static::registerModelEvent('cancelling', $callback);
    }

    /**
     * Register a restoring model event with the dispatcher.
     *
     * @param \Closure|string $callback
     *
     * @return void
     */
    public static function cancelled($callback)
    {
        static::registerModelEvent('cancelled', $callback);
    }

    /**
     * Determine if the model instance has been cancelled.
     *
     * @return bool
     */
    public function isCancelled()
    {
        return ! is_null($this->{$this->getCancelledAtColumn()});
    }

    /**
     * Keep a cancelled model instance.
     *
     * @return bool|null
     */
    public function keep()
    {
        // If the restoring event does not return false, we will proceed with this
        // restore operation. Otherwise, we bail out so the developer will stop
        // the restore totally. We will clear the deleted timestamp and save.
        if ($this->fireModelEvent('keeping') === false) {
            return false;
        }

        $this->{$this->getCancelledAtColumn()} = null;

        $result = $this->save();

        $this->fireModelEvent('kept', false);

        return $result;
    }

    /**
     * Register a restoring model event with the dispatcher.
     *
     * @param \Closure|string $callback
     *
     * @return void
     */
    public static function keeping($callback)
    {
        static::registerModelEvent('keeping', $callback);
    }

    /**
     * Register a restored model event with the dispatcher.
     *
     * @param \Closure|string $callback
     *
     * @return void
     */
    public static function kept($callback)
    {
        static::registerModelEvent('kept', $callback);
    }

    /**
     * Get the name of the "cancelled at" column.
     *
     * @return string
     */
    public function getCancelledAtColumn()
    {
        return defined('static::CANCELLED_AT') ? static::CANCELLED_AT : 'cancelled_at';

The constant Signifly\Cancellation\Traits\Cancellable::CANCELLED_AT was not found. Maybe you did not declare it correctly or list all dependencies?

    }

    /**
     * Get the fully qualified "cancelled at" column.
     *
     * @return string
     */
    public function getQualifiedCancelledAtColumn()
    {
        return $this->getTable().'.'.$this->getCancelledAtColumn();

It seems like getTable() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }
}