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 | final class SqliteConnection implements Connection |
||
10 | { |
||
11 | use DatabaseTransactionsTrait; |
||
12 | |||
13 | /** |
||
14 | * $_pdo The PDO instance of the connection. |
||
15 | * |
||
16 | * @var PDO |
||
17 | */ |
||
18 | private $_pdo; |
||
19 | |||
20 | /** |
||
21 | * $columns Columns of the database table. |
||
22 | * |
||
23 | * @var array |
||
24 | */ |
||
25 | private $columns = []; |
||
26 | |||
27 | /** |
||
28 | * $keys Keys of the database table. |
||
29 | * |
||
30 | * @var array |
||
31 | */ |
||
32 | private $keys = []; |
||
33 | |||
34 | /** |
||
35 | * The method called in the constructor. |
||
36 | * |
||
37 | * @return void |
||
|
|||
38 | */ |
||
39 | public function __construct() |
||
40 | { |
||
41 | $dsn = 'sqlite:../../potatodb.sq3'; |
||
42 | |||
43 | try { |
||
44 | $this->_pdo = new PDO($dsn); |
||
45 | } catch (PDOException $e) { |
||
46 | } |
||
47 | } |
||
48 | |||
49 | /** |
||
50 | * Returns the columns of a table. |
||
51 | * |
||
52 | * @param string $table The table inspected for its columns. |
||
53 | * |
||
54 | * @return array The columns of the table. |
||
55 | */ |
||
56 | 7 | View Code Duplication | public function getColumns($table) |
57 | { |
||
58 | 7 | if (gettype($table) !== 'string') { |
|
59 | throw new InvalidArgumentException("The parameter {$table} is not an string. A string is required instead."); |
||
60 | } |
||
61 | |||
62 | 7 | $this->loadColumnInfo($table); |
|
63 | |||
64 | 7 | return $this->columns[$table]; |
|
65 | } |
||
66 | |||
67 | /** |
||
68 | * Returns the Connection's PDO. |
||
69 | * |
||
70 | * @return PDO PHP Data Objects |
||
71 | */ |
||
72 | 4 | public function getPdo() |
|
76 | |||
77 | /** |
||
78 | * Returns the primary key of a table. |
||
79 | * |
||
80 | * @param string $table The table inspected for its primary key. |
||
81 | * |
||
82 | * @return string The primary key of the table. |
||
83 | */ |
||
84 | 8 | View Code Duplication | public function getPrimaryKey($table) |
94 | |||
95 | 8 | private function loadColumnInfo($table) |
|
112 | } |
||
113 |
Adding a
@return
annotation to a constructor is not recommended, since a constructor does not have a meaningful return value.Please refer to the PHP core documentation on constructors.