Thinktomorrow\Chief\Concerns\Viewable\Viewable

Complexity

Total Complexity

18

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Test Coverage

Coverage

62.86%

Importance

Changes	2
Bugs	1	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	viewData()	0	22	4
A	viewKey()	0	15	5
A	renderView()	0	10	3
A	setViewParent()	0	5	1
A	viewPath()	0	3	1
A	renderRawView()	0	13	4

<?php

namespace Thinktomorrow\Chief\Concerns\Viewable;

use Thinktomorrow\Chief\Concerns\Morphable\MorphableContract;
use Thinktomorrow\Chief\Modules\Module;
use Thinktomorrow\Chief\Pages\Page;
use Thinktomorrow\Chief\Relations\ActsAsParent;
use Thinktomorrow\Chief\Sets\Set;

trait Viewable
{
    protected $viewParent;

    public function renderView(): string
    {
        $renderedView = $this->renderRawView();

        // In case of snippets, we inject these after the initial view rendering
        if (method_exists($this, 'shouldParseWithSnippets') && $this->shouldParseWithSnippets($renderedView)) {
            $renderedView = $this->parseWithSnippets($renderedView);

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

        }

        return $renderedView;
    }

    private function renderRawView(): string
    {
        try {
            return view($this->viewPath(), $this->viewData())->render();

The expression return view($this->viewPath(), $this->viewData())->render() could return the type array which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

        } catch (NotFoundView $e) {
            if (config('thinktomorrow.chief.strict')) {
                throw $e;
            }
        }

        // If no view has been created for this model, we try once again to fetch the content value if any. This will silently fail

This line exceeds maximum limit of 120 characters; contains 131 characters

        // if no content value is present. We consider the 'content' attribute to be a default for our copy.
        return isset($this->content) ? (string) $this->content : '';
    }

    public function setViewParent(ActsAsParent $parent): ViewableContract
    {
        $this->viewParent = $parent;

        return $this;

The expression return $this returns the type Thinktomorrow\Chief\Concerns\Viewable\Viewable which is incompatible with the type-hinted return Thinktomorrow\Chief\Concerns\Viewable\ViewableContract.

    }

    /**
     * This is the model's view identifier. This key is used to determine the full view
     * path of the model. By default this is based on the morphKey value of the model.
     *
     * @return string
     * @throws NotFoundViewKey
     */
    public function viewKey(): string
    {
        if (property_exists($this, 'viewKey') && isset($this->viewKey)) {
            return $this->viewKey;
        }

        if ($this instanceof MorphableContract) {
            return $this->morphKey();

The expression return $this->morphKey() could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

        }

        if (config('thinktomorrow.chief.strict')) {
            throw new NotFoundViewKey('Missing view key. Please add a [viewKey] property to ' . get_class($this));
        };

        return '';
    }

    /**
     * This is the full path reference for this model's view file. This is relative to your main view folder
     * e.g. key 'articles.show'. A sensible default is set and determined based on the viewKey value.
     * But you are free to override this and change it to another value to fit your own logic.
     *
     * @return string
     * @throws NotFoundView
     */
    protected function viewPath(): string
    {
        return ViewPath::make($this, $this->viewParent, $this->baseViewPath ?? null)->get();

$this of type Thinktomorrow\Chief\Concerns\Viewable\Viewable is incompatible with the type Thinktomorrow\Chief\Concerns\Viewable\ViewableContract expected by parameter $viewable of Thinktomorrow\Chief\Concerns\Viewable\ViewPath::make().

    }

    /**
     * @return array
     */
    private function viewData(): array
    {
        $viewData = [
            'model'  => $this,
            'parent' => $this->viewParent,
        ];

        // TODO: add className as variable next to generic model: e.g. Event class should pass variable $event.

        /** @deprecated since 0.3 in favor of generic 'model' variable */
        if ($this instanceof Page) {
            $viewData['page'] = $this;
        }
        if ($this instanceof Module) {
            $viewData['module'] = $this;
        }
        if ($this instanceof Set) {
            $viewData['collection'] = $this;
            $viewData['pages'] = $this;
        }

        return $viewData;
    }
}