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 |
||
17 | class ConversationDB extends DB |
||
18 | { |
||
19 | /** |
||
20 | * Initilize conversation table |
||
21 | */ |
||
22 | 9 | public static function initializeConversation() |
|
23 | { |
||
24 | 9 | if (!defined('TB_CONVERSATION')) { |
|
25 | 1 | define('TB_CONVERSATION', self::$table_prefix . 'conversation'); |
|
26 | } |
||
27 | 9 | } |
|
28 | |||
29 | /** |
||
30 | * Select a conversation from the DB |
||
31 | * |
||
32 | * @param int $user_id |
||
33 | * @param int $chat_id |
||
34 | * @param bool $limit |
||
35 | * |
||
36 | * @return array|bool |
||
37 | * @throws \Longman\TelegramBot\Exception\TelegramException |
||
38 | */ |
||
39 | 9 | public static function selectConversation($user_id, $chat_id, $limit = null) |
|
40 | { |
||
41 | 9 | if (!self::isDbConnected()) { |
|
42 | return false; |
||
43 | } |
||
44 | |||
45 | try { |
||
46 | 9 | $query = 'SELECT * FROM `' . TB_CONVERSATION . '` '; |
|
47 | 9 | $query .= 'WHERE `status` = :status '; |
|
48 | 9 | $query .= 'AND `chat_id` = :chat_id '; |
|
49 | 9 | $query .= 'AND `user_id` = :user_id '; |
|
50 | |||
51 | 9 | if (!is_null($limit)) { |
|
52 | 9 | $query .= ' LIMIT :limit'; |
|
53 | } |
||
54 | 9 | $sth = self::$pdo->prepare($query); |
|
55 | |||
56 | 9 | $active = 'active'; |
|
57 | 9 | $sth->bindParam(':status', $active, PDO::PARAM_STR); |
|
58 | 9 | $sth->bindParam(':user_id', $user_id, PDO::PARAM_INT); |
|
59 | 9 | $sth->bindParam(':chat_id', $chat_id, PDO::PARAM_INT); |
|
60 | 9 | $sth->bindParam(':limit', $limit, PDO::PARAM_INT); |
|
61 | 9 | $sth->execute(); |
|
62 | |||
63 | 9 | $results = $sth->fetchAll(PDO::FETCH_ASSOC); |
|
64 | } catch (Exception $e) { |
||
65 | throw new TelegramException($e->getMessage()); |
||
66 | } |
||
67 | 9 | return $results; |
|
68 | } |
||
69 | |||
70 | /** |
||
71 | * Insert the conversation in the database |
||
72 | * |
||
73 | * @param int $user_id |
||
74 | * @param int $chat_id |
||
75 | * @param string $command |
||
76 | * |
||
77 | * @return bool |
||
78 | * @throws \Longman\TelegramBot\Exception\TelegramException |
||
79 | */ |
||
80 | 6 | public static function insertConversation($user_id, $chat_id, $command) |
|
81 | { |
||
82 | 6 | if (!self::isDbConnected()) { |
|
83 | return false; |
||
84 | } |
||
85 | |||
86 | try { |
||
87 | 6 | $sth = self::$pdo->prepare('INSERT INTO `' . TB_CONVERSATION . '` |
|
88 | ( |
||
89 | `status`, `user_id`, `chat_id`, `command`, `notes`, `created_at`, `updated_at` |
||
90 | ) |
||
91 | VALUES ( |
||
92 | :status, :user_id, :chat_id, :command, :notes, :date, :date |
||
93 | ) |
||
94 | 6 | '); |
|
95 | 6 | $active = 'active'; |
|
96 | 6 | $notes = '[]'; |
|
97 | 6 | $created_at = self::getTimestamp(); |
|
98 | |||
99 | 6 | $sth->bindParam(':status', $active); |
|
100 | 6 | $sth->bindParam(':command', $command); |
|
101 | 6 | $sth->bindParam(':user_id', $user_id); |
|
102 | 6 | $sth->bindParam(':chat_id', $chat_id); |
|
103 | 6 | $sth->bindParam(':notes', $notes); |
|
104 | 6 | $sth->bindParam(':date', $created_at); |
|
105 | |||
106 | 6 | $status = $sth->execute(); |
|
107 | 1 | } catch (Exception $e) { |
|
108 | 1 | throw new TelegramException($e->getMessage()); |
|
109 | } |
||
110 | 5 | return $status; |
|
111 | } |
||
112 | |||
113 | /** |
||
114 | * Update a specific conversation |
||
115 | * |
||
116 | * @param array $fields_values |
||
117 | * @param array $where_fields_values |
||
118 | * |
||
119 | * @return bool |
||
120 | */ |
||
121 | 3 | public static function updateConversation(array $fields_values, array $where_fields_values) |
|
125 | |||
126 | /** |
||
127 | * Update the conversation in the database |
||
128 | * |
||
129 | * @param string $table |
||
130 | * @param array $fields_values |
||
131 | * @param array $where_fields_values |
||
132 | * |
||
133 | * @todo This function is generic should be moved in DB.php |
||
134 | * |
||
135 | * @return bool |
||
136 | * @throws \Longman\TelegramBot\Exception\TelegramException |
||
137 | */ |
||
138 | 3 | public static function update($table, array $fields_values, array $where_fields_values) |
|
185 | } |
||
186 |
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.