GitHub Access Token became invalid

It seems like the GitHub access token used for retrieving details about this repository from GitHub became invalid. This might prevent certain types of inspections from being run (in particular, everything related to pull requests).
Please ask an admin of your repository to re-new the access token on this website.

Blueprint::index()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 9

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 9
c 0
b 0
f 0
rs 9.9666
cc 1
nc 1
nop 3
1
<?php
2
3
namespace duxet\RethinkDB\Schema;
4
5
use Illuminate\Database\Connection;
6
use Illuminate\Database\Schema\Grammars\Grammar;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, duxet\RethinkDB\Schema\Grammar.

Let’s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let’s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
7
use r;
8
9
class Blueprint extends \Illuminate\Database\Schema\Blueprint
10
{
11
    /**
12
     * Create a new schema blueprint.
13
     *
14
     * @param Connection $connection
15
     * @param string     $table
16
     */
17
    public function __construct(Connection $connection, $table)
18
    {
19
        $this->connection = $connection;
0 ignored issues
show
Bug introduced by
The property connection 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...
20
        $this->table = $table;
21
    }
22
23
    /**
24
     * Execute the blueprint against the database.
25
     *
26
     * @param \Illuminate\Database\Connection              $connection
27
     * @param \Illuminate\Database\Schema\Grammars\Grammar $grammar
28
     *
29
     * @return void
30
     */
31
    public function build(Connection $connection, Grammar $grammar)
32
    {
33
    }
34
35
    /**
36
     * Indicate that the table needs to be created.
37
     *
38
     * @return bool
39
     */
40
    public function create()
41
    {
42
        $conn = $this->connection->getConnection();
43
        $db = r\db($this->connection->getDatabaseName());
44
        $db->tableCreate($this->table)->run($conn);
45
    }
46
47
    /**
48
     * Indicate that the collection should be dropped.
49
     *
50
     * @return bool
51
     */
52
    public function drop()
53
    {
54
        $conn = $this->connection->getConnection();
55
        $db = r\db($this->connection->getDatabaseName());
56
        $db->tableDrop($this->table)->run($conn);
57
    }
58
59
    /**
60
     * Specify an index for the collection.
61
     *
62
     * @param string $column
0 ignored issues
show
Documentation introduced by
There is no parameter named $column. Did you maybe mean $columns?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit.

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

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

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

Loading history...
63
     * @param mixed  $options
0 ignored issues
show
Bug introduced by
There is no parameter named $options. 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...
64
     *
65
     * @return Blueprint
66
     */
67
    public function index($columns, $name = NULL, $algorithm = NULL)
0 ignored issues
show
Unused Code introduced by
The parameter $algorithm 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...
68
    {
69
        $conn = $this->connection->getConnection();
70
        $db = r\db($this->connection->getDatabaseName());
71
        $db->table($this->table)->indexCreate($column)
0 ignored issues
show
Bug introduced by
The variable $column does not exist. Did you mean $columns?

This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name.

The variable may have been renamed without also renaming all references.

Loading history...
72
            ->run($conn);
73
74
        return $this;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $this; (duxet\RethinkDB\Schema\Blueprint) is incompatible with the return type of the parent method Illuminate\Database\Schema\Blueprint::index of type Illuminate\Support\Fluent.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
75
    }
76
}
77