ReliqArts\StyleImporter\Util\ViewAccessor

Complexity

Total Complexity

5

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	deriveActiveViewFromBacktrace()	0	11	2
A	getViewHTML()	0	13	2

<?php

declare(strict_types=1);

namespace ReliqArts\StyleImporter\Util;

use Illuminate\View\View;
use ReliqArts\StyleImporter\ConfigProvider;
use ReliqArts\StyleImporter\Exception\ActiveViewHtmlRetrievalFailed;
use ReliqArts\StyleImporter\Exception\ActiveViewRetrievalFailed;
use Throwable;

class ViewAccessor
{
    private const ACTIVE_VIEW_POSITION = 2;

    /**
     * @var ConfigProvider
     */
    private $configProvider;

    /**
     * @var BacktraceAccessor
     */
    private $backtraceAccessor;

    /**
     * ActiveViewRetriever constructor.
     *
     * @param ConfigProvider    $configProvider
     * @param BacktraceAccessor $backtraceAccessor
     */
    public function __construct(ConfigProvider $configProvider, BacktraceAccessor $backtraceAccessor)
    {
        $this->configProvider = $configProvider;
        $this->backtraceAccessor = $backtraceAccessor;
    }

    /**
     * @param null|View $view
     *
     * @throws ActiveViewHtmlRetrievalFailed
     *
     * @return string
     */
    public function getViewHTML(?View $view = null): string
    {
        try {
            $view = $view ?? $this->deriveActiveViewFromBacktrace();

            return $view

The expression return $view->with(array($this->configProvider->getSkipStyleImportVariableName() => true))->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.

                ->with([$this->configProvider->getSkipStyleImportVariableName() => true])
                ->render();
        } catch (Throwable $exception) {
            throw new ActiveViewHtmlRetrievalFailed(
                sprintf('Could not retrieve HTML of active view; %s', $exception->getMessage()),
                $exception->getCode(),
                $exception
            );
        }
    }

    /**
     * @throws ActiveViewRetrievalFailed
     *
     * @return View
     */
    private function deriveActiveViewFromBacktrace(): View
    {
        /** @var null|View $view */
        $view = $this->backtraceAccessor->getNthObjectOfType(self::ACTIVE_VIEW_POSITION, View::class);

        if (!empty($view)) {
            return $view;
        }

        throw new ActiveViewRetrievalFailed(
            'Could not retrieve active view from backtrace.'
        );
    }
}