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 declare(strict_types=1); |
||
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 | public static function createFolder($folder): void |
||
39 | } |
||
40 | } |
||
41 | |||
42 | /** |
||
43 | * @param string $file |
||
44 | * @param string $folder |
||
45 | * @return bool |
||
46 | */ |
||
47 | public static function copyFile(string $file, string $folder): bool |
||
48 | { |
||
49 | return \copy($file, $folder); |
||
50 | } |
||
51 | |||
52 | /** |
||
53 | * @param $src |
||
54 | * @param $dst |
||
55 | */ |
||
56 | public static function recurseCopy($src, $dst): void |
||
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 | * Remove files and (sub)directories |
||
77 | * |
||
78 | * @param string $src source directory to delete |
||
79 | * |
||
80 | * @return bool true on success |
||
81 | * @uses \Xmf\Module\Helper::isUserAdmin() |
||
82 | * |
||
83 | * @uses \Xmf\Module\Helper::getHelper() |
||
84 | */ |
||
85 | public static function deleteDirectory($src): bool |
||
86 | { |
||
87 | // Only continue if user is a 'global' Admin |
||
88 | if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) { |
||
89 | return false; |
||
90 | } |
||
91 | |||
92 | $success = true; |
||
93 | // remove old files |
||
94 | $dirInfo = new \SplFileInfo($src); |
||
95 | // validate is a directory |
||
96 | if ($dirInfo->isDir()) { |
||
97 | $fileList = \array_diff(\scandir($src, \SCANDIR_SORT_NONE), ['..', '.']); |
||
98 | foreach ($fileList as $k => $v) { |
||
99 | $fileInfo = new \SplFileInfo("{$src}/{$v}"); |
||
100 | if ($fileInfo->isDir()) { |
||
101 | // recursively handle subdirectories |
||
102 | if (!$success = self::deleteDirectory($fileInfo->getRealPath())) { |
||
103 | break; |
||
104 | } |
||
105 | } elseif (!($success = \unlink($fileInfo->getRealPath()))) { |
||
106 | break; |
||
107 | } |
||
108 | } |
||
109 | // now delete this (sub)directory if all the files are gone |
||
110 | if ($success) { |
||
111 | $success = \rmdir($dirInfo->getRealPath()); |
||
112 | } |
||
113 | } else { |
||
114 | // input is not a valid directory |
||
115 | $success = false; |
||
116 | } |
||
117 | |||
118 | return $success; |
||
119 | } |
||
120 | |||
121 | /** |
||
122 | * Recursively remove directory |
||
123 | * |
||
124 | * @todo currently won't remove directories with hidden files, should it? |
||
125 | * |
||
126 | * @param string $src directory to remove (delete) |
||
127 | * |
||
128 | * @return bool true on success |
||
129 | */ |
||
130 | public static function rrmdir($src): bool |
||
161 | } |
||
162 | |||
163 | /** |
||
164 | * Recursively move files from one directory to another |
||
165 | * |
||
166 | * @param string $src - Source of files being moved |
||
167 | * @param string $dest - Destination of files being moved |
||
168 | * |
||
169 | * @return bool true on success |
||
170 | */ |
||
171 | public static function rmove($src, $dest): bool |
||
172 | { |
||
173 | // Only continue if user is a 'global' Admin |
||
174 | if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) { |
||
175 | return false; |
||
176 | } |
||
177 | |||
178 | // If source is not a directory stop processing |
||
179 | if (!\is_dir($src)) { |
||
180 | return false; |
||
181 | } |
||
182 | |||
183 | // If the destination directory does not exist and could not be created stop processing |
||
184 | if (!\is_dir($dest) && !\mkdir($dest) && !\is_dir($dest)) { |
||
185 | return false; |
||
186 | } |
||
187 | |||
188 | // Open the source directory to read in files |
||
189 | $iterator = new \DirectoryIterator($src); |
||
190 | foreach ($iterator as $fObj) { |
||
191 | if ($fObj->isFile()) { |
||
192 | \rename($fObj->getPathname(), "{$dest}/" . $fObj->getFilename()); |
||
193 | } elseif (!$fObj->isDot() && $fObj->isDir()) { |
||
194 | // Try recursively on directory |
||
195 | self::rmove($fObj->getPathname(), "{$dest}/" . $fObj->getFilename()); |
||
196 | // rmdir($fObj->getPath()); // now delete the directory |
||
197 | } |
||
198 | } |
||
199 | $iterator = null; // clear iterator Obj to close file/directory |
||
200 | |||
201 | return \rmdir($src); // remove the directory & return results |
||
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): bool |
||
243 | } |
||
244 | } |
||
245 |