Layout::verifyLayoutOptions() - Code Metrics - JumpGateio/ViewResolution - Measure and Improve Code Quality continuously with Scrutinizer

Layout::verifyLayoutOptions() A
last analyzed 2018-09-14 22:00 UTC

↳ Parent: Layout

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
nc	5
nop	1
dl	0
loc	20
rs	9.2888
c	0
b	0
f	0

<?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)

    {
        $this->view    = $view;

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

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

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

        $this->layout        = $this->determineLayout(null);
        $this->setPageTitle();
        $this->layout->content = null;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

        return $this;
    }

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

    {
        $this->layout = $this->determineLayout($view);
        $this->setPageTitle();
        $this->layout->content = null;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

        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)) : '');


        if ($area != null) {

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

        }

        $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;
    }
}


1		<?php
2
3		namespace JumpGate\ViewResolution\Resolvers;
4
5		use Illuminate\Config\Repository;
6		use Illuminate\View\Factory;
7		use Illuminate\Http\Request;
8
9		class Layout
10		{
11		/**
12		* @var \Illuminate\View\View
13		*/
14		public $layout;
15
16		/**
17		* @var \Illuminate\View\View
18		*/
19		protected $view;
20
21		/**
22		* @var \Illuminate\Http\Request
23		*/
24		protected $request;
25
26		/**
27		* @var \Illuminate\Config\Repository
28		*/
29		protected $config;
30
31		/**
32		* @var array
33		*/
34		protected $layoutOptions;
35
36		/**
37		* @param \Illuminate\View\Factory $view
38		* @param \Illuminate\Http\Request $request
39		* @param \Illuminate\Config\Repository $config
40		*/
41		public function __construct(Factory $view, Request $request, Repository $config)
		0 ignored issues – show Bug introduced 2018-09-14 21:53 UTC by Report Bug Copy Issue Report 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()`. Loading history...
42		{
43		$this->view = $view;
		0 ignored issues – show Documentation Bug introduced 2017-02-21 20:00 UTC by Report Bug Copy Issue Report It seems like `$view` of type `object<Illuminate\View\Factory>` is incompatible with the declared type `object<Illuminate\View\View>` of property `$view`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
44		$this->request = $request;
45		$this->config = $config;
46		}
47
48		/**
49		* Set up the initial layout to be used.
50		*
51		* @param $layoutOptions
52		*
53		* @return $this
54		*/
55	View Code Duplication	public function setUp($layoutOptions)
		0 ignored issues – show Duplication introduced 2018-09-14 21:53 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
56		{
57		$this->layoutOptions = $this->verifyLayoutOptions($layoutOptions);
		0 ignored issues – show Documentation Bug introduced 2017-02-21 20:00 UTC by Report Bug Copy Issue Report It seems like `$this->verifyLayoutOptions($layoutOptions)` of type `*` is incompatible with the declared type `array` of property `$layoutOptions`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
58		$this->layout = $this->determineLayout(null);
59		$this->setPageTitle();
60		$this->layout->content = null;
		0 ignored issues – show Bug introduced 2017-02-21 20:00 UTC by Report Bug Copy Issue Report Accessing `content` on the interface `Illuminate\Contracts\View\View` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
61
62		return $this;
63		}
64
65		/**
66		* Change the selected layout to something else and ready it for content.
67		*
68		* @param $view
69		*
70		* @return $this
71		*/
72	View Code Duplication	public function change($view)
		0 ignored issues – show Duplication introduced 2018-09-14 21:53 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
73		{
74		$this->layout = $this->determineLayout($view);
75		$this->setPageTitle();
76		$this->layout->content = null;
		0 ignored issues – show Bug introduced 2017-02-21 20:00 UTC by Report Bug Copy Issue Report Accessing `content` on the interface `Illuminate\Contracts\View\View` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
77
78		return $this;
79		}
80
81		/**
82		* Auto determine a logic page title.
83		*/
84		public function setPageTitle()
85		{
86		$area = $this->request->segment(1);
87		$location = ($this->request->segment(2) != null ? ': ' . ucwords($this->request->segment(2)) : '');
		0 ignored issues – show Bug introduced 2017-02-21 20:00 UTC by Report Bug Copy Issue Report 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. Loading history...
88
89		if ($area != null) {
		0 ignored issues – show Bug introduced 2017-02-21 20:00 UTC by Report Bug Copy Issue Report 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. Loading history...
90		$pageTitle = ucwords($area) . $location;
91		} else {
92		$pageTitle = $this->config->get('core::siteName') . ($this->request->segment(1) != null ? ': ' . ucwords($this->request->segment(1)) : '');
		0 ignored issues – show Bug introduced 2017-02-21 20:00 UTC by Report Bug Copy Issue Report 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. Loading history...
93		}
94
95		$this->view->share('pageTitle', $pageTitle);
96		}
97
98		/**
99		* Determine which layout to use based on the request.
100		*
101		* @param $layout
102		*
103		* @return \Illuminate\Contracts\View\View
104		*/
105		protected function determineLayout($layout)
106		{
107		if (! is_null($layout)) {
108		return $this->view->make($layout);
109		}
110
111		if (is_string($this->layout)) {
112		return $this->view->make($this->layout);
113		}
114
115		if (is_null($this->layout) && $this->request->ajax()) {
116		return $this->view->make($this->layoutOptions['ajax']);
117		}
118
119		if (is_null($this->layout)) {
120		return $this->view->make($this->layoutOptions['default']);
121		}
122
123		return $this->layout;
124		}
125
126		/**
127		* Make sure that we have a valid set of layout options.
128		*
129		* @param $layoutOptions
130		*
131		* @return mixed
132		*/
133		private function verifyLayoutOptions($layoutOptions)
134		{
135		// If using the config details, go with that instead of expecting passed options.
136		if (config('jumpgate.view-resolution.load_layout')) {
137		return config('jumpgate.view-resolution.layout_options');
138		}
139
140		// If using the passed options, make sure they are valid options.
141		if (! is_array($layoutOptions)) {
142		throw new \InvalidArgumentException('The layoutOptions must be an array.');
143		}
144		if (! isset($layoutOptions['default'])) {
145		throw new \InvalidArgumentException('The layoutOptions must have a default layout view.');
146		}
147		if (! isset($layoutOptions['ajax'])) {
148		throw new \InvalidArgumentException('The layoutOptions must have a ajax layout view.');
149		}
150
151		return $layoutOptions;
152		}
153		}
154

JumpGateio / ViewResolution

Layout::verifyLayoutOptions() A last analyzed 2018-09-14 22:00 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

Layout::verifyLayoutOptions() A
last analyzed 2018-09-14 22:00 UTC