JumpGate\ViewResolution\Resolvers\Layout

Complexity

Total Complexity

18

Size/Duplication

Total Lines	145
Duplicated Lines	11.72 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	setUp()	9	9	1
A	change()	8	8	1
A	setPageTitle()	0	13	4
B	determineLayout()	0	20	6
A	verifyLayoutOptions()	0	20	5

<?php

namespace JumpGate\ViewResolution\Resolvers;

use Illuminate\Config\Repository;
use Illuminate\View\Factory;
use Illuminate\Http\Request;

class Layout
{
    /**
     * @var \Illuminate\View\View
     */
    public $layout;

    /**
     * @var \Illuminate\View\View
     */
    protected $view;

    /**
     * @var \Illuminate\Http\Request
     */
    protected $request;

    /**
     * @var \Illuminate\Config\Repository
     */
    protected $config;

    /**
     * @var array
     */
    protected $layoutOptions;

    /**
     * @param \Illuminate\View\Factory      $view
     * @param \Illuminate\Http\Request      $request
     * @param \Illuminate\Config\Repository $config
     */
    public function __construct(Factory $view, Request $request, Repository $config)

You have injected the Request via parameter $request. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via getCurrentRequest().

    {
        $this->view    = $view;

It seems like $view of type object<Illuminate\View\Factory> is incompatible with the declared type object<Illuminate\View\View> of property $view.

        $this->request = $request;
        $this->config  = $config;
    }

    /**
     * Set up the initial layout to be used.
     *
     * @param $layoutOptions
     *
     * @return $this
     */
    public function setUp($layoutOptions)

This method seems to be duplicated in your project.

    {
        $this->layoutOptions = $this->verifyLayoutOptions($layoutOptions);

It seems like $this->verifyLayoutOptions($layoutOptions) of type * is incompatible with the declared type array of property $layoutOptions.

        $this->layout        = $this->determineLayout(null);
        $this->setPageTitle();
        $this->layout->content = null;

Accessing content on the interface Illuminate\Contracts\View\View suggest that you code against a concrete implementation. How about adding an instanceof check?

        return $this;
    }

    /**
     * Change the selected layout to something else and ready it for content.
     *
     * @param $view
     *
     * @return $this
     */
    public function change($view)

This method seems to be duplicated in your project.

    {
        $this->layout = $this->determineLayout($view);
        $this->setPageTitle();
        $this->layout->content = null;

Accessing content on the interface Illuminate\Contracts\View\View suggest that you code against a concrete implementation. How about adding an instanceof check?

        return $this;
    }

    /**
     * Auto determine a logic page title.
     */
    public function setPageTitle()
    {
        $area     = $this->request->segment(1);
        $location = ($this->request->segment(2) != null ? ': ' . ucwords($this->request->segment(2)) : '');

It seems like you are loosely comparing $this->request->segment(2) of type string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison !== instead.

        if ($area != null) {

It seems like you are loosely comparing $area of type string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison !== instead.

            $pageTitle = ucwords($area) . $location;
        } else {
            $pageTitle = $this->config->get('core::siteName') . ($this->request->segment(1) != null ? ': ' . ucwords($this->request->segment(1)) : '');

It seems like you are loosely comparing $this->request->segment(1) of type string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison !== instead.

        }

        $this->view->share('pageTitle', $pageTitle);
    }

    /**
     * Determine which layout to use based on the request.
     *
     * @param $layout
     *
     * @return \Illuminate\Contracts\View\View
     */
    protected function determineLayout($layout)
    {
        if (! is_null($layout)) {
            return $this->view->make($layout);
        }

        if (is_string($this->layout)) {
            return $this->view->make($this->layout);
        }

        if (is_null($this->layout) && $this->request->ajax()) {
            return $this->view->make($this->layoutOptions['ajax']);
        }

        if (is_null($this->layout)) {
            return $this->view->make($this->layoutOptions['default']);
        }

        return $this->layout;
    }

    /**
     * Make sure that we have a valid set of layout options.
     *
     * @param $layoutOptions
     *
     * @return mixed
     */
    private function verifyLayoutOptions($layoutOptions)
    {
        // If using the config details, go with that instead of expecting passed options.
        if (config('jumpgate.view-resolution.load_layout')) {
            return config('jumpgate.view-resolution.layout_options');
        }

        // If using the passed options, make sure they are valid options.
        if (! is_array($layoutOptions)) {
            throw new \InvalidArgumentException('The layoutOptions must be an array.');
        }
        if (! isset($layoutOptions['default'])) {
            throw new \InvalidArgumentException('The layoutOptions must have a default layout view.');
        }
        if (! isset($layoutOptions['ajax'])) {
            throw new \InvalidArgumentException('The layoutOptions must have a ajax layout view.');
        }

        return $layoutOptions;
    }
}