Completed
Pull Request — master (#1339)
by José
01:55
created

DropForeignKey::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 3

Duplication

Lines 5
Ratio 100 %

Importance

Changes 0
Metric Value
dl 5
loc 5
rs 9.4285
c 0
b 0
f 0
cc 1
eloc 3
nc 1
nop 2
1
<?php
2
/**
3
 * Phinx
4
 *
5
 * (The MIT license)
6
 *
7
 * Permission is hereby granted, free of charge, to any person obtaining a copy
8
 * of this software and associated * documentation files (the "Software"), to
9
 * deal in the Software without restriction, including without limitation the
10
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
11
 * sell copies of the Software, and to permit persons to whom the Software is
12
 * furnished to do so, subject to the following conditions:
13
 *
14
 * The above copyright notice and this permission notice shall be included in
15
 * all copies or substantial portions of the Software.
16
 *
17
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
23
 * IN THE SOFTWARE.
24
 */
25
namespace Phinx\Db\Action;
26
27
use InvalidArgumentException;
28
use Phinx\Db\Table\ForeignKey;
29
use Phinx\Db\Table\Table;
30
31 View Code Duplication
class DropForeignKey extends Action
0 ignored issues
show
Duplication introduced by
This class 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...
32
{
33
34
    /**
35
     * The foreing key to remove
36
     *
37
     * @var ForeignKey
38
     */
39
    protected $foreignKey;
40
41
    /**
42
     * Constructor
43
     *
44
     * @param Table $table The table to remove the constraint from
45
     * @param ForeignKey $foreignKey The foreign key to remove
46
     */
47
    public function __construct(Table $table, ForeignKey $foreignKey)
48
    {
49
        parent::__construct($table);
50
        $this->foreignKey = $foreignKey;
51
    }
52
53
    /**
54
     * Creates a new DropForeignKey object after building the ForeignKey
55
     * definition out of the passed arguments.
56
     *
57
     * @param Table $table The table to dele the foreign key from
58
     * @param string|string[] $columns The columns participating in the foreign key
59
     * @param string|null $constraint The constraint name
60
     * @return DropForeignKey
61
     */
62
    public static function build(Table $table, $columns, $constraint = null)
63
    {
64
        if (is_string($columns)) {
65
            $columns = [$columns];
66
        }
67
68
        $foreignKey = new ForeignKey();
69
        $foreignKey->setColumns($columns);
70
71
        if ($constraint) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $constraint of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
72
            $foreignKey->setConstraint($constraint);
73
        }
74
75
        return new static($table, $foreignKey);
76
    }
77
78
    /**
79
     * Returns the  foreign key to remove
80
     *
81
     * @return ForeignKey
82
     */
83
    public function getForeignKey()
84
    {
85
        return $this->foreignKey;
86
    }
87
}
88