Iben\Statable\Statable

Complexity

Total Complexity

13

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	stateHistory()	0	4	1
A	addHistoryLine()	0	7	2
A	getActorId()	0	4	1
A	stateIs()	0	4	1
A	apply()	0	7	3
A	canApply()	0	4	1
A	stateMachine()	0	8	2
A	getGraph()	0	4	1
A	saveBeforeTransition()	0	4	1

<?php

namespace Iben\Statable;

use SM\StateMachine\StateMachine;
use Iben\Statable\Models\StateHistory;

trait Statable
{
    /**
     * @var StateMachine
     */
    protected $SM;

    /**
     * @return \Illuminate\Database\Eloquent\Model
     */
    public function stateHistory()
    {
        return $this->morphMany(StateHistory::class, 'statable');

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

    }

    /**
     * @param array $transitionData
     */
    public function addHistoryLine(array $transitionData)
    {
        if ($this->getKey()) {

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

            $transitionData['actor_id'] = $this->getActorId();
            $this->stateHistory()->create($transitionData);

The method create() does not exist on Illuminate\Database\Eloquent\Model. Did you maybe mean created()?

        }
    }

    /**
     * @return int|null
     */
    public function getActorId()
    {
        return auth()->id();

The method id does only exist in Illuminate\Contracts\Auth\Guard, but not in Illuminate\Contracts\Auth\Factory.

    }

    /**
     * @return mixed|string
     * @throws \Illuminate\Container\EntryNotFoundException
     */
    public function stateIs()
    {
        return $this->stateMachine()->getState();
    }

    /**
     * @param $transition
     * @return bool
     * @throws \SM\SMException|\Illuminate\Container\EntryNotFoundException
     */
    public function apply($transition)
    {
        if ($this->getKey() === null && $this->saveBeforeTransition()) {

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

            $this->save();

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

        }
        return $this->stateMachine()->apply($transition);
    }

    /**
     * @param $transition
     * @return bool
     * @throws \SM\SMException|\Illuminate\Container\EntryNotFoundException
     */
    public function canApply($transition)
    {
        return $this->stateMachine()->can($transition);
    }

    /**
     * @return mixed|\SM\StateMachine\StateMachine
     * @throws \Illuminate\Container\EntryNotFoundException
     */
    public function stateMachine()
    {
        if (! $this->SM) {
            $this->SM = app('sm.factory')->get($this, $this->getGraph());
        }

        return $this->SM;
    }

    /**
     * @return string
     */
    protected function getGraph()
    {
        return 'default';
    }

    /**
     * @return bool
     */
    protected function saveBeforeTransition()
    {
        return false;
    }
}