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:
Complex classes like FilesManagement often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use FilesManagement, and based on these observations, apply Extract Interface, too.
1 | <?php namespace Xoopsmodules\xsitemap\common; |
||
17 | trait FilesManagement |
||
18 | { |
||
19 | /** |
||
20 | * Function responsible for checking if a directory exists, we can also write in and create an index.html file |
||
21 | * |
||
22 | * @param string $folder The full path of the directory to check |
||
23 | * |
||
24 | * @return void |
||
25 | * @throws \RuntimeException |
||
26 | */ |
||
27 | public static function createFolder($folder) |
||
42 | |||
43 | /** |
||
44 | * @param $file |
||
45 | * @param $folder |
||
46 | * @return bool |
||
47 | */ |
||
48 | public static function copyFile($file, $folder) |
||
52 | |||
53 | /** |
||
54 | * @param $src |
||
55 | * @param $dst |
||
56 | */ |
||
57 | public static function recurseCopy($src, $dst) |
||
75 | |||
76 | /** |
||
77 | * |
||
78 | * Remove files and (sub)directories |
||
79 | * |
||
80 | * @param string $src source directory to delete |
||
81 | * |
||
82 | * @uses \Xmf\Module\Helper::getHelper() |
||
83 | * @uses \Xmf\Module\Helper::isUserAdmin() |
||
84 | * |
||
85 | * @return bool true on success |
||
86 | */ |
||
87 | public static function deleteDirectory($src) |
||
124 | |||
125 | /** |
||
126 | * |
||
127 | * Recursively remove directory |
||
128 | * |
||
129 | * @todo currently won't remove directories with hidden files, should it? |
||
130 | * |
||
131 | * @param string $src directory to remove (delete) |
||
132 | * |
||
133 | * @return bool true on success |
||
134 | */ |
||
135 | public static function rrmdir($src) |
||
166 | |||
167 | /** |
||
168 | * Recursively move files from one directory to another |
||
169 | * |
||
170 | * @param string $src - Source of files being moved |
||
171 | * @param string $dest - Destination of files being moved |
||
172 | * |
||
173 | * @return bool true on success |
||
174 | */ |
||
175 | View Code Duplication | public static function rmove($src, $dest) |
|
206 | |||
207 | /** |
||
208 | * Recursively copy directories and files from one directory to another |
||
209 | * |
||
210 | * @param string $src - Source of files being moved |
||
211 | * @param string $dest - Destination of files being moved |
||
212 | * |
||
213 | * @uses \Xmf\Module\Helper::getHelper() |
||
214 | * @uses \Xmf\Module\Helper::isUserAdmin() |
||
215 | * |
||
216 | * @return bool true on success |
||
217 | */ |
||
218 | View Code Duplication | public static function rcopy($src, $dest) |
|
246 | } |
||
247 |
Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: