ViewResolverTrait - Code Metrics - devnile/microboard - Measure and Improve Code Quality continuously with Scrutinizer

ViewResolverTrait A
last analyzed 2020-11-17 12:23 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
dl	0
loc	84
rs	10
c	0
b	0
f	0
wmc	11
lcom	1
cbo	2

4 Methods

Rating	Name	Size	Complexity
A	getViewPathFor()	8	2
B	buildVariables()	35	6
A	getRightPrefixFor()	6	2
A	getResourceVariables()	6	1

<?php

namespace Microboard\Foundations\Traits;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;

trait ViewResolverTrait
{
    /**
     * @param $file
     * @return string
     */
    protected function getViewPathFor($file)
    {
        if (view()->exists($view = $this->buildVariables()['viewsPrefix'] . ".{$file}")) {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            return $view;
        }

        return "microboard::resource.{$file}";
    }

    /**
     * Build variables depends on given $attributes.
     *
     * @param Model|null $model
     * @return array
     */
    protected function buildVariables(?Model $model = null)
    {
        $routePrefix = 'microboard';
        $translationsPrefix = '';
        $viewsPrefix = '';
        $viewsPath = 'admin';

        if (property_exists($this, 'attributes')) {
            if (isset($this->attributes['routes_prefix'])) {
                $routePrefix = $this->attributes['routes_prefix'];
class MyClass { }

$x = new MyClass();
$x->foo = true;
            }
            if (isset($this->attributes['translations_prefix'])) {
                $translationsPrefix = $this->attributes['translations_prefix'];
            }
            if (isset($this->attributes['views_prefix'])) {
                $viewsPrefix = $this->attributes['views_prefix'];
            }
            if (isset($this->attributes['views_path'])) {
                $viewsPath = $this->attributes['views_path'];
            }
        }

        return [
            'resource' => $this->model,
class MyClass { }

$x = new MyClass();
$x->foo = true;
            'model' => $model,
            'resourceName' => $name = Str::of($this->baseName)->lower()->plural(),
class MyClass { }

$x = new MyClass();
$x->foo = true;
            'resourceVariable' => Str::of($this->baseName)->lower(),
            'routePrefix' => $this->getRightPrefixFor($routePrefix, '.', $name),
            'translationsPrefix' => $this->getRightPrefixFor($translationsPrefix, '::', $name),
            'viewsPrefix' => $this->getRightPrefixFor(
                $viewsPrefix, '::',
                $this->getRightPrefixFor($viewsPath, '.', $name)
            ),
        ];
    }

    /**
     * Join given prefix and $resource with the delimiter.
     *
     * @param string $prefix
     * @param string $delimiter
     * @param string $resource
     * @return string
     */
    protected function getRightPrefixFor($prefix = '', $delimiter = '.', $resource = '')
    {
        return (
            $prefix ? $prefix . $delimiter : ''
            ) . $resource;
    }

    /**
     * @param $view
     * @param Model|null $model
     * @return array
     */
    protected function getResourceVariables($view, ?Model $model = null): array
    {
        return array_merge([
            'widgets' => $this->getWidgetsFor($view)
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        ], $this->buildVariables($model));
    }
}


1			<?php
2
3			namespace Microboard\Foundations\Traits;
4
5			use Illuminate\Database\Eloquent\Model;
6			use Illuminate\Support\Str;
7
8			trait ViewResolverTrait
9			{
10			/**
11			* @param $file
12			* @return string
13			*/
14			protected function getViewPathFor($file)
15			{
16			if (view()->exists($view = $this->buildVariables()['viewsPrefix'] . ".{$file}")) {
			0 ignored issues – show Bug introduced 2020-07-05 00:27 UTC by Report Bug Copy Issue Report The method `exists` does only exist in `Illuminate\Contracts\View\Factory`, but not in `Illuminate\View\View`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
17			return $view;
18			}
19
20			return "microboard::resource.{$file}";
21			}
22
23			/**
24			* Build variables depends on given $attributes.
25			*
26			* @param Model\|null $model
27			* @return array
28			*/
29			protected function buildVariables(?Model $model = null)
30			{
31			$routePrefix = 'microboard';
32			$translationsPrefix = '';
33			$viewsPrefix = '';
34			$viewsPath = 'admin';
35
36			if (property_exists($this, 'attributes')) {
37			if (isset($this->attributes['routes_prefix'])) {
38			$routePrefix = $this->attributes['routes_prefix'];
			0 ignored issues – show Bug introduced 2020-07-02 18:54 UTC by Report Bug Copy Issue Report The property `attributes` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
39			}
40			if (isset($this->attributes['translations_prefix'])) {
41			$translationsPrefix = $this->attributes['translations_prefix'];
42			}
43			if (isset($this->attributes['views_prefix'])) {
44			$viewsPrefix = $this->attributes['views_prefix'];
45			}
46			if (isset($this->attributes['views_path'])) {
47			$viewsPath = $this->attributes['views_path'];
48			}
49			}
50
51			return [
52			'resource' => $this->model,
			0 ignored issues – show Bug introduced 2020-07-04 21:07 UTC by Report Bug Copy Issue Report The property `model` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
53			'model' => $model,
54			'resourceName' => $name = Str::of($this->baseName)->lower()->plural(),
			0 ignored issues – show Bug introduced 2020-07-05 00:27 UTC by Report Bug Copy Issue Report The property `baseName` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
55			'resourceVariable' => Str::of($this->baseName)->lower(),
56			'routePrefix' => $this->getRightPrefixFor($routePrefix, '.', $name),
57			'translationsPrefix' => $this->getRightPrefixFor($translationsPrefix, '::', $name),
58			'viewsPrefix' => $this->getRightPrefixFor(
59			$viewsPrefix, '::',
60			$this->getRightPrefixFor($viewsPath, '.', $name)
61			),
62			];
63			}
64
65			/**
66			* Join given prefix and $resource with the delimiter.
67			*
68			* @param string $prefix
69			* @param string $delimiter
70			* @param string $resource
71			* @return string
72			*/
73			protected function getRightPrefixFor($prefix = '', $delimiter = '.', $resource = '')
74			{
75			return (
76			$prefix ? $prefix . $delimiter : ''
77			) . $resource;
78			}
79
80			/**
81			* @param $view
82			* @param Model\|null $model
83			* @return array
84			*/
85			protected function getResourceVariables($view, ?Model $model = null): array
86			{
87			return array_merge([
88			'widgets' => $this->getWidgetsFor($view)
			0 ignored issues – show Bug introduced 2020-07-03 02:14 UTC by Report Bug Copy Issue Report It seems like `getWidgetsFor()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
89			], $this->buildVariables($model));
90			}
91			}
92

devnile / microboard

ViewResolverTrait A last analyzed 2020-11-17 12:23 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like

ViewResolverTrait A
last analyzed 2020-11-17 12:23 UTC