helpers.php ➔ backpack_view() - Code Metrics - Inspection of "[Feature][4.0][Awesome] Themes" - Laravel-Backpack/Base - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#297)

by Cristian

created 2019-05-15 06:05 UTC

helpers.php ➔ backpack_view() A

↳ Parent: Project

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	4
nop	1
dl	0
loc	17
rs	9.7
c	0
b	0
f	0

<?php

if (!function_exists('backpack_url')) {
    /**
     * Appends the configured backpack prefix and returns
     * the URL using the standard Laravel helpers.
     *
     * @param $path
     *
     * @return string
     */
    function backpack_url($path = null, $parameters = [], $secure = null)

    {
        $path = !$path || (substr($path, 0, 1) == '/') ? $path : '/'.$path;

        return url(config('backpack.base.route_prefix', 'admin').$path, $parameters = [], $secure = null);
    }
}

if (!function_exists('backpack_authentication_column')) {
    /**
     * Return the username column name.
     * The Laravel default (and Backpack default) is 'email'.
     *
     * @return string
     */
    function backpack_authentication_column()
    {
        return config('backpack.base.authentication_column', 'email');
    }
}

if (!function_exists('backpack_users_have_email')) {
    /**
     * Check if the email column is present on the user table.
     *
     * @return string
     */
    function backpack_users_have_email()
    {
        $user_model_fqn = config('backpack.base.user_model_fqn');
        $user = new $user_model_fqn();

        return \Schema::hasColumn($user->getTable(), 'email');
    }
}

if (!function_exists('backpack_avatar_url')) {
    /**
     * Returns the avatar URL of a user.
     *
     * @param $user
     *
     * @return string
     */
    function backpack_avatar_url($user)
    {
        $placeholder = 'https://placehold.it/160x160/00a65a/ffffff/&text='.$user->name[0];

        switch (config('backpack.base.avatar_type')) {
            case 'gravatar':
                if (backpack_users_have_email()) {
                    return Gravatar::fallback('https://placehold.it/160x160/00a65a/ffffff/&text='.$user->name[0])->get($user->email);
                } else {
                    return $placeholder;
                }
                break;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

            case 'placehold':
                return $placeholder;
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}

            default:
                return method_exists($user, config('backpack.base.avatar_type')) ? $user->{config('backpack.base.avatar_type')}() : $user->{config('backpack.base.avatar_type')};
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
        }
    }
}

if (!function_exists('backpack_middleware')) {
    /**
     * Return the key of the middleware used across Backpack.
     * That middleware checks if the visitor is an admin.
     *
     * @param $path
     *
     * @return string
     */
    function backpack_middleware()
    {
        return config('backpack.base.middleware_key', 'admin');
    }
}

if (!function_exists('backpack_guard_name')) {
    /*
     * Returns the name of the guard defined
     * by the application config
     */
    function backpack_guard_name()
    {
        return config('backpack.base.guard', config('auth.defaults.guard'));
    }
}

if (!function_exists('backpack_auth')) {
    /*
     * Returns the user instance if it exists
     * of the currently authenticated admin
     * based off the defined guard.
     */
    function backpack_auth()
    {
        return \Auth::guard(backpack_guard_name());
    }
}

if (!function_exists('backpack_user')) {
    /*
     * Returns back a user instance without
     * the admin guard, however allows you
     * to pass in a custom guard if you like.
     */
    function backpack_user()
    {
        return backpack_auth()->user();
    }
}

if (!function_exists('mb_ucfirst')) {
    /**
     * Capitalize the first letter of a string,
     * even if that string is multi-byte (non-latin alphabet).
     *
     * @param string   $string   String to have its first letter capitalized.
     * @param encoding $encoding Character encoding
     *
     * @return string String with first letter capitalized.
     */
    function mb_ucfirst($string, $encoding = false)
    {
        $encoding = $encoding ? $encoding : mb_internal_encoding();

        $strlen = mb_strlen($string, $encoding);
        $firstChar = mb_substr($string, 0, 1, $encoding);
        $then = mb_substr($string, 1, $strlen - 1, $encoding);

        return mb_strtoupper($firstChar, $encoding).$then;
    }
}

if (!function_exists('backpack_view')) {
    /**
     * Returns a new displayable view based on the current configured backpack.
     *
     * @param string (see config/backpack/base.php)
     *
     * @return string
     */
    function backpack_view($view)
    {
        $theme = config('backpack.base.view_namespace');
        $originalTheme = 'backpack::';

        if (is_null($theme)) {
            $theme = $originalTheme;
        }

        $returnView = $theme.$view;

        if (!view()->exists($returnView)) {
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.
}
            $returnView = $originalTheme.$view;
        }

        return $returnView;
    }
}

1			<?php
2
3			if (!function_exists('backpack_url')) {
4			/**
5			* Appends the configured backpack prefix and returns
6			* the URL using the standard Laravel helpers.
7			*
8			* @param $path
9			*
10			* @return string
11			*/
12			function backpack_url($path = null, $parameters = [], $secure = null)
			0 ignored issues – show Unused Code introduced 2018-10-30 14:06 UTC by Report Bug Copy Issue Report The parameter `$parameters` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2018-10-30 14:06 UTC by Report Bug Copy Issue Report The parameter `$secure` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
13			{
14			$path = !$path \|\| (substr($path, 0, 1) == '/') ? $path : '/'.$path;
15
16			return url(config('backpack.base.route_prefix', 'admin').$path, $parameters = [], $secure = null);
17			}
18			}
19
20			if (!function_exists('backpack_authentication_column')) {
21			/**
22			* Return the username column name.
23			* The Laravel default (and Backpack default) is 'email'.
24			*
25			* @return string
26			*/
27			function backpack_authentication_column()
28			{
29			return config('backpack.base.authentication_column', 'email');
30			}
31			}
32
33			if (!function_exists('backpack_users_have_email')) {
34			/**
35			* Check if the email column is present on the user table.
36			*
37			* @return string
38			*/
39			function backpack_users_have_email()
40			{
41			$user_model_fqn = config('backpack.base.user_model_fqn');
42			$user = new $user_model_fqn();
43
44			return \Schema::hasColumn($user->getTable(), 'email');
45			}
46			}
47
48			if (!function_exists('backpack_avatar_url')) {
49			/**
50			* Returns the avatar URL of a user.
51			*
52			* @param $user
53			*
54			* @return string
55			*/
56			function backpack_avatar_url($user)
57			{
58			$placeholder = 'https://placehold.it/160x160/00a65a/ffffff/&text='.$user->name[0];
59
60			switch (config('backpack.base.avatar_type')) {
61			case 'gravatar':
62			if (backpack_users_have_email()) {
63			return Gravatar::fallback('https://placehold.it/160x160/00a65a/ffffff/&text='.$user->name[0])->get($user->email);
64			} else {
65			return $placeholder;
66			}
67			break;
			0 ignored issues – show Unused Code introduced 2018-03-07 07:27 UTC by Report Bug Copy Issue Report `break;` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
68
69			case 'placehold':
70			return $placeholder;
71			break;
			0 ignored issues – show Unused Code introduced 2018-03-07 07:27 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
72
73			default:
74			return method_exists($user, config('backpack.base.avatar_type')) ? $user->{config('backpack.base.avatar_type')}() : $user->{config('backpack.base.avatar_type')};
75			break;
			0 ignored issues – show Unused Code introduced 2018-05-02 04:48 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
76			}
77			}
78			}
79
80			if (!function_exists('backpack_middleware')) {
81			/**
82			* Return the key of the middleware used across Backpack.
83			* That middleware checks if the visitor is an admin.
84			*
85			* @param $path
86			*
87			* @return string
88			*/
89			function backpack_middleware()
90			{
91			return config('backpack.base.middleware_key', 'admin');
92			}
93			}
94
95			if (!function_exists('backpack_guard_name')) {
96			/*
97			* Returns the name of the guard defined
98			* by the application config
99			*/
100			function backpack_guard_name()
101			{
102			return config('backpack.base.guard', config('auth.defaults.guard'));
103			}
104			}
105
106			if (!function_exists('backpack_auth')) {
107			/*
108			* Returns the user instance if it exists
109			* of the currently authenticated admin
110			* based off the defined guard.
111			*/
112			function backpack_auth()
113			{
114			return \Auth::guard(backpack_guard_name());
115			}
116			}
117
118			if (!function_exists('backpack_user')) {
119			/*
120			* Returns back a user instance without
121			* the admin guard, however allows you
122			* to pass in a custom guard if you like.
123			*/
124			function backpack_user()
125			{
126			return backpack_auth()->user();
127			}
128			}
129
130			if (!function_exists('mb_ucfirst')) {
131			/**
132			* Capitalize the first letter of a string,
133			* even if that string is multi-byte (non-latin alphabet).
134			*
135			* @param string $string String to have its first letter capitalized.
136			* @param encoding $encoding Character encoding
137			*
138			* @return string String with first letter capitalized.
139			*/
140			function mb_ucfirst($string, $encoding = false)
141			{
142			$encoding = $encoding ? $encoding : mb_internal_encoding();
143
144			$strlen = mb_strlen($string, $encoding);
145			$firstChar = mb_substr($string, 0, 1, $encoding);
146			$then = mb_substr($string, 1, $strlen - 1, $encoding);
147
148			return mb_strtoupper($firstChar, $encoding).$then;
149			}
150			}
151
152			if (!function_exists('backpack_view')) {
153			/**
154			* Returns a new displayable view based on the current configured backpack.
155			*
156			* @param string (see config/backpack/base.php)
157			*
158			* @return string
159			*/
160			function backpack_view($view)
161			{
162			$theme = config('backpack.base.view_namespace');
163			$originalTheme = 'backpack::';
164
165			if (is_null($theme)) {
166			$theme = $originalTheme;
167			}
168
169			$returnView = $theme.$view;
170
171			if (!view()->exists($returnView)) {
			0 ignored issues – show Bug introduced 2018-03-31 07:07 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...
172			$returnView = $originalTheme.$view;
173			}
174
175			return $returnView;
176			}
177			}

Laravel-Backpack / Base

Pull Request — master (#297)

helpers.php ➔ backpack_view() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like