Completed
Push — master ( c2b776...5d5d0e )
by Chin
03:26
created

RouterMacros::multilingual()   A

Complexity

Conditions 4
Paths 1

Size

Total Lines 13

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 4
nc 1
nop 0
dl 0
loc 13
rs 9.8333
c 0
b 0
f 0
1
<?php
2
3
namespace ChinLeung\LaravelMultilingualRoutes\Macros;
4
5
use ChinLeung\LaravelMultilingualRoutes\MultilingualRegistrar;
6
use ChinLeung\LaravelMultilingualRoutes\MultilingualRoutePendingRegistration;
7
use Closure;
8
9
class RouterMacros
10
{
11
    /**
12
     * Register a multilingual GET route.
13
     *
14
     * @param  string  $key
1 ignored issue
show
Bug introduced by
There is no parameter named $key. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
15
     * @param  mixed  $handle
1 ignored issue
show
Bug introduced by
There is no parameter named $handle. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
16
     * @param  array  $locales
1 ignored issue
show
Bug introduced by
There is no parameter named $locales. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
17
     * @return \Closure
18
     */
19
    public function multilingual() : Closure
20
    {
21
        return function ($key, $handle, $locales = []) {
22
            return new MultilingualRoutePendingRegistration(
23
                $this->container && $this->container->bound(MultilingualRegistrar::class)
1 ignored issue
show
Bug introduced by
The property container 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...
24
                    ? $this->container->make(MultilingualRegistrar::class)
25
                    : new MultilingualRegistrar($this),
1 ignored issue
show
Documentation introduced by
$this is of type this<ChinLeung\LaravelMu...es\Macros\RouterMacros>, but the function expects a object<Illuminate\Routing\Router>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
26
                $key,
27
                $handle,
28
                $locales ?: locales()
29
            );
30
        };
31
    }
32
}
33