Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
1 | <?php |
||
9 | class OracleBuilder extends Builder |
||
10 | { |
||
11 | /** |
||
12 | * @var \Yajra\Oci8\Schema\OracleAutoIncrementHelper |
||
13 | */ |
||
14 | public $helper; |
||
15 | |||
16 | /** |
||
17 | * @var \Yajra\Oci8\Schema\Comment |
||
18 | */ |
||
19 | public $comment; |
||
20 | |||
21 | /** |
||
22 | * @param Connection $connection |
||
23 | */ |
||
24 | public function __construct(Connection $connection) |
||
25 | { |
||
26 | parent::__construct($connection); |
||
27 | $this->helper = new OracleAutoIncrementHelper($connection); |
||
28 | $this->comment = new Comment($connection); |
||
29 | } |
||
30 | |||
31 | /** |
||
32 | * Create a new table on the schema. |
||
33 | * |
||
34 | * @param string $table |
||
35 | * @param Closure $callback |
||
36 | * @return \Illuminate\Database\Schema\Blueprint |
||
37 | */ |
||
38 | View Code Duplication | public function create($table, Closure $callback) |
|
39 | { |
||
40 | $blueprint = $this->createBlueprint($table); |
||
41 | |||
42 | $blueprint->create(); |
||
43 | |||
44 | $callback($blueprint); |
||
45 | |||
46 | $this->build($blueprint); |
||
47 | |||
48 | $this->comment->setComments($blueprint); |
||
49 | |||
50 | $this->helper->createAutoIncrementObjects($blueprint, $table); |
||
51 | } |
||
52 | |||
53 | /** |
||
54 | * Create a new command set with a Closure. |
||
55 | * |
||
56 | * @param string $table |
||
57 | * @param Closure $callback |
||
58 | * @return \Illuminate\Database\Schema\Blueprint |
||
59 | */ |
||
60 | protected function createBlueprint($table, Closure $callback = null) |
||
61 | { |
||
62 | $blueprint = new OracleBlueprint($table, $callback); |
||
63 | $blueprint->setTablePrefix($this->connection->getTablePrefix()); |
||
64 | |||
65 | return $blueprint; |
||
66 | } |
||
67 | |||
68 | /** |
||
69 | * Changes an existing table on the schema. |
||
70 | * |
||
71 | * @param string $table |
||
72 | * @param Closure $callback |
||
73 | * @return \Illuminate\Database\Schema\Blueprint |
||
74 | */ |
||
75 | View Code Duplication | public function table($table, Closure $callback) |
|
76 | { |
||
77 | $blueprint = $this->createBlueprint($table); |
||
78 | |||
79 | $callback($blueprint); |
||
80 | |||
81 | foreach ($blueprint->getCommands() as $command) { |
||
82 | if ($command->get('name') == 'drop') { |
||
83 | $this->helper->dropAutoIncrementObjects($table); |
||
84 | } |
||
85 | } |
||
86 | |||
87 | $this->build($blueprint); |
||
88 | |||
89 | $this->comment->setComments($blueprint); |
||
90 | } |
||
91 | |||
92 | /** |
||
93 | * Drop a table from the schema. |
||
94 | * |
||
95 | * @param string $table |
||
96 | * @return \Illuminate\Database\Schema\Blueprint |
||
97 | */ |
||
98 | public function drop($table) |
||
103 | |||
104 | /** |
||
105 | * Drop all tables from the database. |
||
106 | * |
||
107 | * @return void |
||
108 | */ |
||
109 | public function dropAllTables() |
||
113 | |||
114 | /** |
||
115 | * Indicate that the table should be dropped if it exists. |
||
116 | * |
||
117 | * @param string $table |
||
118 | * @return \Illuminate\Support\Fluent |
||
119 | */ |
||
120 | public function dropIfExists($table) |
||
125 | |||
126 | /** |
||
127 | * Determine if the given table exists. |
||
128 | * |
||
129 | * @param string $table |
||
130 | * @return bool |
||
131 | */ |
||
132 | public function hasTable($table) |
||
146 | |||
147 | /** |
||
148 | * Get the column listing for a given table. |
||
149 | * |
||
150 | * @param string $table |
||
151 | * @return array |
||
152 | */ |
||
153 | public function getColumnListing($table) |
||
163 | } |
||
164 |
Let’s take a look at an example:
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break.
Available Fixes
Change the type-hint for the parameter:
Add an additional type-check:
Add the method to the parent class: