mambax7 /
xoopsheadline
| Total Complexity | 64 |
| Total Lines | 258 |
| 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(string $folder): void |
||
| 39 | } |
||
| 40 | } |
||
| 41 | |||
| 42 | public static function copyFile(string $file, string $folder): bool |
||
| 43 | { |
||
| 44 | return \copy($file, $folder); |
||
| 45 | } |
||
| 46 | |||
| 47 | public static function recurseCopy(string $src, string $dst): void |
||
| 48 | { |
||
| 49 | $dir = \opendir($src); |
||
| 50 | // @mkdir($dst); |
||
| 51 | if (!@\mkdir($dst) && !\is_dir($dst)) { |
||
| 52 | throw new \RuntimeException('The directory ' . $dst . ' could not be created.'); |
||
| 53 | } |
||
| 54 | while (false !== ($file = \readdir($dir))) { |
||
| 55 | if (('.' !== $file) && ('..' !== $file)) { |
||
| 56 | if (\is_dir($src . '/' . $file)) { |
||
| 57 | self::recurseCopy($src . '/' . $file, $dst . '/' . $file); |
||
| 58 | } else { |
||
| 59 | \copy($src . '/' . $file, $dst . '/' . $file); |
||
| 60 | } |
||
| 61 | } |
||
| 62 | } |
||
| 63 | \closedir($dir); |
||
| 64 | } |
||
| 65 | |||
| 66 | /** |
||
| 67 | * Copy a file, or recursively copy a folder and its contents |
||
| 68 | * @param string $source Source path |
||
| 69 | * @param string $dest Destination path |
||
| 70 | * @return bool Returns true on success, false on failure |
||
| 71 | * @author Aidan Lister <[email protected]> |
||
| 72 | * @version 1.0.1 |
||
| 73 | * @link https://aidanlister.com/2004/04/recursively-copying-directories-in-php/ |
||
| 74 | */ |
||
| 75 | public static function xcopy(string $source, string $dest): bool |
||
| 76 | { |
||
| 77 | // Check for symlinks |
||
| 78 | if (\is_link($source)) { |
||
| 79 | return \symlink(\readlink($source), $dest); |
||
| 80 | } |
||
| 81 | |||
| 82 | // Simple copy for a file |
||
| 83 | if (\is_file($source)) { |
||
| 84 | return \copy($source, $dest); |
||
| 85 | } |
||
| 86 | |||
| 87 | // Make destination directory |
||
| 88 | if (!\is_dir($dest) && (!\mkdir($dest) && !\is_dir($dest))) { |
||
| 89 | throw new \RuntimeException(\sprintf('Directory "%s" was not created', $dest)); |
||
| 90 | } |
||
| 91 | |||
| 92 | // Loop through the folder |
||
| 93 | $dir = \dir($source); |
||
| 94 | if (@\is_dir((string)$dir)) { |
||
| 95 | while (false !== ($entry = $dir->read())) { |
||
| 96 | // Skip pointers |
||
| 97 | if ('.' === $entry || '..' === $entry) { |
||
| 98 | continue; |
||
| 99 | } |
||
| 100 | // Deep copy directories |
||
| 101 | self::xcopy("${source}/${entry}", "${dest}/${entry}"); |
||
| 102 | } |
||
| 103 | // Clean up |
||
| 104 | $dir->close(); |
||
| 105 | } |
||
| 106 | |||
| 107 | return true; |
||
| 108 | } |
||
| 109 | |||
| 110 | /** |
||
| 111 | * Remove files and (sub)directories |
||
| 112 | * |
||
| 113 | * @param string $src source directory to delete |
||
| 114 | * |
||
| 115 | * @return bool true on success |
||
| 116 | * @uses \Xmf\Module\Helper::isUserAdmin() |
||
| 117 | * |
||
| 118 | * @uses \Xmf\Module\Helper::getHelper() |
||
| 119 | */ |
||
| 120 | public static function deleteDirectory(string $src): bool |
||
| 154 | } |
||
| 155 | |||
| 156 | /** |
||
| 157 | * Recursively remove directory |
||
| 158 | * |
||
| 159 | * @todo currently won't remove directories with hidden files, should it? |
||
| 160 | * |
||
| 161 | * @param string $src directory to remove (delete) |
||
| 162 | * |
||
| 163 | * @return bool true on success |
||
| 164 | */ |
||
| 165 | public static function rrmdir(string $src): bool |
||
| 166 | { |
||
| 167 | // Only continue if user is a 'global' Admin |
||
| 168 | if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) { |
||
| 169 | return false; |
||
| 170 | } |
||
| 171 | |||
| 172 | // If source is not a directory stop processing |
||
| 173 | if (!\is_dir($src)) { |
||
| 174 | return false; |
||
| 175 | } |
||
| 176 | |||
| 177 | $success = true; |
||
|
Unused Code
introduced
by
|
|||
| 178 | |||
| 179 | // Open the source directory to read in files |
||
| 180 | $iterator = new \DirectoryIterator($src); |
||
| 181 | foreach ($iterator as $fObj) { |
||
| 182 | if ($fObj->isFile()) { |
||
| 183 | $filename = $fObj->getPathname(); |
||
| 184 | $fObj = null; // clear this iterator object to close the file |
||
| 185 | if (!\unlink($filename)) { |
||
| 186 | return false; // couldn't delete the file |
||
| 187 | } |
||
| 188 | } elseif (!$fObj->isDot() && $fObj->isDir()) { |
||
| 189 | // Try recursively on directory |
||
| 190 | self::rrmdir($fObj->getPathname()); |
||
| 191 | } |
||
| 192 | } |
||
| 193 | $iterator = null; // clear iterator Obj to close file/directory |
||
| 194 | |||
| 195 | return \rmdir($src); // remove the directory & return results |
||
| 196 | } |
||
| 197 | |||
| 198 | /** |
||
| 199 | * Recursively move files from one directory to another |
||
| 200 | * |
||
| 201 | * @param string $src - Source of files being moved |
||
| 202 | * @param string $dest - Destination of files being moved |
||
| 203 | * |
||
| 204 | * @return bool true on success |
||
| 205 | */ |
||
| 206 | public static function rmove(string $src, string $dest): bool |
||
| 207 | { |
||
| 208 | // Only continue if user is a 'global' Admin |
||
| 209 | if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) { |
||
| 210 | return false; |
||
| 211 | } |
||
| 212 | |||
| 213 | // If source is not a directory stop processing |
||
| 214 | if (!\is_dir($src)) { |
||
| 215 | return false; |
||
| 216 | } |
||
| 217 | |||
| 218 | // If the destination directory does not exist and could not be created stop processing |
||
| 219 | if (!\is_dir($dest) && !\mkdir($dest) && !\is_dir($dest)) { |
||
| 220 | return false; |
||
| 221 | } |
||
| 222 | |||
| 223 | // Open the source directory to read in files |
||
| 224 | $iterator = new \DirectoryIterator($src); |
||
| 225 | foreach ($iterator as $fObj) { |
||
| 226 | if ($fObj->isFile()) { |
||
| 227 | \rename($fObj->getPathname(), "{$dest}/" . $fObj->getFilename()); |
||
| 228 | } elseif (!$fObj->isDot() && $fObj->isDir()) { |
||
| 229 | // Try recursively on directory |
||
| 230 | self::rmove($fObj->getPathname(), "{$dest}/" . $fObj->getFilename()); |
||
| 231 | // rmdir($fObj->getPath()); // now delete the directory |
||
| 232 | } |
||
| 233 | } |
||
| 234 | $iterator = null; // clear iterator Obj to close file/directory |
||
| 235 | |||
| 236 | return \rmdir($src); // remove the directory & return results |
||
| 237 | } |
||
| 238 | |||
| 239 | /** |
||
| 240 | * Recursively copy directories and files from one directory to another |
||
| 241 | * |
||
| 242 | * @param string $src - Source of files being moved |
||
| 243 | * @param string $dest - Destination of files being moved |
||
| 244 | * |
||
| 245 | * @return bool true on success |
||
| 246 | * @uses \Xmf\Module\Helper::isUserAdmin() |
||
| 247 | * |
||
| 248 | * @uses \Xmf\Module\Helper::getHelper() |
||
| 249 | */ |
||
| 250 | public static function rcopy(string $src, string $dest): bool |
||
| 278 | } |
||
| 279 | } |
||
| 280 |
Loading history...