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