Total Complexity | 54 |
Total Lines | 227 |
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\Extcal\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 | * @throws \RuntimeException |
||
27 | */ |
||
28 | public static function createFolder($folder) |
||
29 | { |
||
30 | try { |
||
31 | if (!file_exists($folder)) { |
||
32 | if (!is_dir($folder) && !mkdir($folder) && !is_dir($folder)) { |
||
33 | throw new \RuntimeException(sprintf('Unable to create the %s directory', $folder)); |
||
34 | } |
||
35 | |||
36 | file_put_contents($folder . '/index.html', '<script>history.go(-1);</script>'); |
||
37 | } |
||
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) |
||
50 | { |
||
51 | return copy($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 | 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 | } |
||
73 | closedir($dir); |
||
74 | } |
||
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) |
||
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 | } else { |
||
108 | // delete the file |
||
109 | if (!($success = unlink($fileInfo->getRealPath()))) { |
||
110 | break; |
||
111 | } |
||
112 | } |
||
113 | } |
||
114 | // now delete this (sub)directory if all the files are gone |
||
115 | if ($success) { |
||
116 | $success = rmdir($dirInfo->getRealPath()); |
||
117 | } |
||
118 | } else { |
||
119 | // input is not a valid directory |
||
120 | $success = false; |
||
121 | } |
||
122 | return $success; |
||
123 | } |
||
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) |
||
136 | { |
||
137 | // Only continue if user is a 'global' Admin |
||
138 | if (!($GLOBALS['xoopsUser'] instanceof \XoopsUser) || !$GLOBALS['xoopsUser']->isAdmin()) { |
||
139 | return false; |
||
140 | } |
||
141 | |||
142 | // If source is not a directory stop processing |
||
143 | if (!is_dir($src)) { |
||
144 | return false; |
||
145 | } |
||
146 | |||
147 | $success = true; |
||
148 | |||
149 | // Open the source directory to read in files |
||
150 | $iterator = new \DirectoryIterator($src); |
||
151 | foreach ($iterator as $fObj) { |
||
152 | if ($fObj->isFile()) { |
||
153 | $filename = $fObj->getPathname(); |
||
154 | $fObj = null; // clear this iterator object to close the file |
||
155 | if (!unlink($filename)) { |
||
156 | return false; // couldn't delete the file |
||
157 | } |
||
158 | } elseif (!$fObj->isDot() && $fObj->isDir()) { |
||
159 | // Try recursively on directory |
||
160 | self::rrmdir($fObj->getPathname()); |
||
161 | } |
||
162 | } |
||
163 | $iterator = null; // clear iterator Obj to close file/directory |
||
164 | return rmdir($src); // remove the directory & return results |
||
165 | } |
||
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 | public static function rmove($src, $dest) |
||
205 | } |
||
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 | public static function rcopy($src, $dest) |
||
247 |