Total Complexity | 54 |
Total Lines | 226 |
Duplicated Lines | 0 % |
Changes | 0 |
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.
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\Xdonations\Common; |
||
18 | trait FilesManagement |
||
19 | { |
||
20 | /** |
||
21 | * Function responsible for checking if a directory exists, we can also write in and create an index.html file |
||
22 | * |
||
23 | * @param string $folder The full path of the directory to check |
||
24 | * |
||
25 | * @return void |
||
26 | */ |
||
27 | public static function createFolder($folder) |
||
28 | { |
||
29 | try { |
||
30 | if (!file_exists($folder)) { |
||
31 | if (!is_dir($folder) && !mkdir($folder) && !is_dir($folder)) { |
||
32 | throw new \RuntimeException(sprintf('Unable to create the %s directory', $folder)); |
||
33 | } |
||
34 | |||
35 | file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>'); |
||
36 | } |
||
37 | } catch (\Exception $e) { |
||
38 | echo 'Caught exception: ', $e->getMessage(), "\n", '<br>'; |
||
39 | } |
||
40 | } |
||
41 | |||
42 | /** |
||
43 | * @param $file |
||
44 | * @param $folder |
||
45 | * @return bool |
||
46 | */ |
||
47 | public static function copyFile($file, $folder) |
||
48 | { |
||
49 | return copy($file, $folder); |
||
50 | } |
||
51 | |||
52 | /** |
||
53 | * @param $src |
||
54 | * @param $dst |
||
55 | */ |
||
56 | public static function recurseCopy($src, $dst) |
||
57 | { |
||
58 | $dir = opendir($src); |
||
59 | // @mkdir($dst); |
||
60 | if (!@mkdir($dst) && !is_dir($dst)) { |
||
61 | throw new \RuntimeException('The directory ' . $dst . ' could not be created.'); |
||
62 | } |
||
63 | while (false !== ($file = readdir($dir))) { |
||
|
|||
64 | if (('.' !== $file) && ('..' !== $file)) { |
||
65 | if (is_dir($src . '/' . $file)) { |
||
66 | self::recurseCopy($src . '/' . $file, $dst . '/' . $file); |
||
67 | } else { |
||
68 | copy($src . '/' . $file, $dst . '/' . $file); |
||
69 | } |
||
70 | } |
||
71 | } |
||
72 | closedir($dir); |
||
73 | } |
||
74 | |||
75 | /** |
||
76 | * |
||
77 | * Remove files and (sub)directories |
||
78 | * |
||
79 | * @param string $src source directory to delete |
||
80 | * |
||
81 | * @uses \Xmf\Module\Helper::getHelper() |
||
82 | * @uses \Xmf\Module\Helper::isUserAdmin() |
||
83 | * |
||
84 | * @return bool true on success |
||
85 | */ |
||
86 | public static function deleteDirectory($src) |
||
87 | { |
||
88 | // Only continue if user is a 'global' Admin |
||
89 | if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) { |
||
90 | return false; |
||
91 | } |
||
92 | |||
93 | $success = true; |
||
94 | // remove old files |
||
95 | $dirInfo = new \SplFileInfo($src); |
||
96 | // validate is a directory |
||
97 | if ($dirInfo->isDir()) { |
||
98 | $fileList = array_diff(scandir($src, SCANDIR_SORT_NONE), ['..', '.']); |
||
99 | foreach ($fileList as $k => $v) { |
||
100 | $fileInfo = new \SplFileInfo("{$src}/{$v}"); |
||
101 | if ($fileInfo->isDir()) { |
||
102 | // recursively handle subdirectories |
||
103 | if (!$success = self::deleteDirectory($fileInfo->getRealPath())) { |
||
104 | break; |
||
105 | } |
||
106 | } else { |
||
107 | // delete the file |
||
108 | if (!($success = unlink($fileInfo->getRealPath()))) { |
||
109 | break; |
||
110 | } |
||
111 | } |
||
112 | } |
||
113 | // now delete this (sub)directory if all the files are gone |
||
114 | if ($success) { |
||
115 | $success = rmdir($dirInfo->getRealPath()); |
||
116 | } |
||
117 | } else { |
||
118 | // input is not a valid directory |
||
119 | $success = false; |
||
120 | } |
||
121 | return $success; |
||
122 | } |
||
123 | |||
124 | /** |
||
125 | * |
||
126 | * Recursively remove directory |
||
127 | * |
||
128 | * @todo currently won't remove directories with hidden files, should it? |
||
129 | * |
||
130 | * @param string $src directory to remove (delete) |
||
131 | * |
||
132 | * @return bool true on success |
||
133 | */ |
||
134 | public static function rrmdir($src) |
||
164 | } |
||
165 | |||
166 | /** |
||
167 | * Recursively move files from one directory to another |
||
168 | * |
||
169 | * @param string $src - Source of files being moved |
||
170 | * @param string $dest - Destination of files being moved |
||
171 | * |
||
172 | * @return bool true on success |
||
173 | */ |
||
174 | public static function rmove($src, $dest) |
||
175 | { |
||
176 | // Only continue if user is a 'global' Admin |
||
177 | if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) { |
||
178 | return false; |
||
179 | } |
||
180 | |||
181 | // If source is not a directory stop processing |
||
182 | if (!is_dir($src)) { |
||
183 | return false; |
||
184 | } |
||
185 | |||
186 | // If the destination directory does not exist and could not be created stop processing |
||
187 | if (!is_dir($dest) && !mkdir($dest) && !is_dir($dest)) { |
||
188 | return false; |
||
189 | } |
||
190 | |||
191 | // Open the source directory to read in files |
||
192 | $iterator = new \DirectoryIterator($src); |
||
193 | foreach ($iterator as $fObj) { |
||
194 | if ($fObj->isFile()) { |
||
195 | rename($fObj->getPathname(), "{$dest}/" . $fObj->getFilename()); |
||
196 | } elseif (!$fObj->isDot() && $fObj->isDir()) { |
||
197 | // Try recursively on directory |
||
198 | self::rmove($fObj->getPathname(), "{$dest}/" . $fObj->getFilename()); |
||
199 | // rmdir($fObj->getPath()); // now delete the directory |
||
200 | } |
||
201 | } |
||
202 | $iterator = null; // clear iterator Obj to close file/directory |
||
203 | return rmdir($src); // remove the directory & return results |
||
204 | } |
||
205 | |||
206 | /** |
||
207 | * Recursively copy directories and files from one directory to another |
||
208 | * |
||
209 | * @param string $src - Source of files being moved |
||
210 | * @param string $dest - Destination of files being moved |
||
211 | * |
||
212 | * @uses \Xmf\Module\Helper::getHelper() |
||
213 | * @uses \Xmf\Module\Helper::isUserAdmin() |
||
214 | * |
||
215 | * @return bool true on success |
||
216 | */ |
||
217 | public static function rcopy($src, $dest) |
||
244 | } |
||
245 | } |
||
246 |