Thinktomorrow\Chief\Management\Assistants\AssistedManager

Complexity

Total Complexity

13

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	isAssistedBy()	0	3	1
A	assistantsAsClassNames()	0	3	1
A	getAssistantClass()	0	14	4
A	addAssistant()	0	7	2
A	assistant()	0	10	2
A	assistants()	0	9	3

<?php


namespace Thinktomorrow\Chief\Management\Assistants;

use Thinktomorrow\Chief\Management\Exceptions\MissingAssistant;

trait AssistedManager
{
    protected $assistants = [];

    /**
     * Check if this manager is assisted by a certain assistant
     *
     * @param string $assistantKey
     * @return bool
     */
    public function isAssistedBy(string $assistantKey): bool
    {
        return !! $this->getAssistantClass($assistantKey);
    }

    /**
     * @param bool $asInstances
     * @return array
     * @throws \Exception
     */
    public function assistants($asInstances = true): array
    {
        $assistants = [];

        foreach ($this->assistants as $assistant) {
            $assistants[] = $asInstances ? $this->assistant($assistant) : $assistant;
        }

        return $assistants;
    }

    public function assistantsAsClassNames()
    {
        return $this->assistants(false);
    }

    /**
     * Instantiate the assistant
     *
     * @param string $assistantKey
     * @return Assistant
     * @throws \Exception
     */
    public function assistant(string $assistantKey): Assistant
    {
        if (! $this->isAssistedBy($assistantKey)) {
            throw new MissingAssistant('No assistant [' . $assistantKey . '] registered on manager ' . get_class($this));
        }

        $instance = app($this->getAssistantClass($assistantKey));
        $instance->manager($this);

The method manager() does not exist on Illuminate\Contracts\Foundation\Application.

        return $instance;

The expression return $instance could return the type Illuminate\Contracts\Foundation\Application which is incompatible with the type-hinted return Thinktomorrow\Chief\Management\Assistants\Assistant. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get assistant class by key or assistant classname
     *
     * @param string $assistantKey
     * @return string|null
     */
    private function getAssistantClass(string $assistantKey): ?string
    {
        foreach ($this->assistants as $class) {
            if ($assistantKey == $class::key()) {
                return $class;
            }
        }

        // Alternatively, check if the passed argument is the assistant class name
        if (in_array($assistantKey, $this->assistants)) {
            return $assistantKey;
        }

        return null;
    }

    public function addAssistant(string $assistantClass)
    {
        if(false === array_search($assistantClass, $this->assistants)) {
            $this->assistants[] = $assistantClass;
        }

        return $this;
    }
}