Total Complexity | 58 |
Total Lines | 331 |
Duplicated Lines | 0 % |
Changes | 11 | ||
Bugs | 4 | Features | 1 |
Complex classes like LfmPath 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 LfmPath, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
11 | class LfmPath |
||
12 | { |
||
13 | private $working_dir; |
||
14 | private $item_name; |
||
15 | private $is_thumb = false; |
||
16 | |||
17 | private $helper; |
||
18 | |||
19 | public function __construct(Lfm $lfm = null) |
||
20 | { |
||
21 | $this->helper = $lfm; |
||
22 | } |
||
23 | |||
24 | public function __get($var_name) |
||
25 | { |
||
26 | if ($var_name == 'storage') { |
||
27 | return $this->helper->getStorage($this->path('url')); |
||
|
|||
28 | } |
||
29 | } |
||
30 | |||
31 | public function __call($function_name, $arguments) |
||
32 | { |
||
33 | return $this->storage->$function_name(...$arguments); |
||
34 | } |
||
35 | |||
36 | public function dir($working_dir) |
||
41 | } |
||
42 | |||
43 | public function thumb($is_thumb = true) |
||
44 | { |
||
45 | $this->is_thumb = $is_thumb; |
||
46 | |||
47 | return $this; |
||
48 | } |
||
49 | |||
50 | public function setName($item_name) |
||
51 | { |
||
52 | $this->item_name = $item_name; |
||
53 | |||
54 | return $this; |
||
55 | } |
||
56 | |||
57 | public function getName() |
||
60 | } |
||
61 | |||
62 | public function path($type = 'storage') |
||
63 | { |
||
64 | if ($type == 'working_dir') { |
||
65 | // working directory: /{user_slug} |
||
66 | return $this->translateToLfmPath($this->normalizeWorkingDir()); |
||
67 | } elseif ($type == 'url') { |
||
68 | // storage: files/{user_slug} |
||
69 | return $this->helper->getCategoryName() . $this->path('working_dir'); |
||
70 | } elseif ($type == 'storage') { |
||
71 | // storage: files/{user_slug} |
||
72 | // storage on windows: files\{user_slug} |
||
73 | return str_replace(Lfm::DS, $this->helper->ds(), $this->path('url')); |
||
74 | } else { |
||
75 | // absolute: /var/www/html/project/storage/app/files/{user_slug} |
||
76 | // absolute on windows: C:\project\storage\app\files\{user_slug} |
||
77 | return $this->storage->rootPath() . $this->path('storage'); |
||
78 | } |
||
79 | } |
||
80 | |||
81 | public function translateToLfmPath($path) |
||
84 | } |
||
85 | |||
86 | public function url() |
||
87 | { |
||
88 | return $this->storage->url($this->path('url')); |
||
89 | } |
||
90 | |||
91 | public function folders() |
||
92 | { |
||
93 | $all_folders = array_map(function ($directory_path) { |
||
94 | return $this->pretty($directory_path, true); |
||
95 | }, $this->storage->directories()); |
||
96 | |||
97 | $folders = array_filter($all_folders, function ($directory) { |
||
98 | return $directory->name !== $this->helper->getThumbFolderName(); |
||
99 | }); |
||
100 | |||
101 | return $this->sortByColumn($folders); |
||
102 | } |
||
103 | |||
104 | public function files() |
||
111 | } |
||
112 | |||
113 | public function pretty($item_path, $isDirectory = false) |
||
114 | { |
||
115 | return Container::getInstance()->makeWith(LfmItem::class, [ |
||
116 | 'lfm' => (clone $this)->setName($this->helper->getNameFromPath($item_path)), |
||
117 | 'helper' => $this->helper, |
||
118 | 'isDirectory' => $isDirectory |
||
119 | ]); |
||
120 | } |
||
121 | |||
122 | public function delete() |
||
128 | } |
||
129 | } |
||
130 | |||
131 | /** |
||
132 | * Create folder if not exist. |
||
133 | * |
||
134 | * @param string $path Real path of a directory. |
||
135 | * @return bool |
||
136 | */ |
||
137 | public function createFolder() |
||
138 | { |
||
139 | if ($this->storage->exists($this)) { |
||
140 | return false; |
||
141 | } |
||
142 | |||
143 | $this->storage->makeDirectory(0777, true, true); |
||
144 | } |
||
145 | |||
146 | public function isDirectory() |
||
147 | { |
||
148 | $working_dir = $this->path('working_dir'); |
||
149 | $parent_dir = substr($working_dir, 0, strrpos($working_dir, '/')); |
||
150 | |||
151 | $parent_directories = array_map(function ($directory_path) { |
||
152 | return app(static::class)->translateToLfmPath($directory_path); |
||
153 | }, app(static::class)->dir($parent_dir)->directories()); |
||
154 | |||
155 | return in_array($this->path('url'), $parent_directories); |
||
156 | } |
||
157 | |||
158 | /** |
||
159 | * Check a folder and its subfolders is empty or not. |
||
160 | * |
||
161 | * @param string $directory_path Real path of a directory. |
||
162 | * @return bool |
||
163 | */ |
||
164 | public function directoryIsEmpty() |
||
167 | } |
||
168 | |||
169 | public function normalizeWorkingDir() |
||
170 | { |
||
171 | $path = $this->working_dir |
||
172 | ?: $this->helper->input('working_dir') |
||
173 | ?: $this->helper->getRootFolder(); |
||
174 | |||
175 | if ($this->is_thumb) { |
||
176 | // Prevent if working dir is "/" normalizeWorkingDir will add double "//" that breaks S3 functionality |
||
177 | $path = rtrim($path, Lfm::DS) . Lfm::DS . $this->helper->getThumbFolderName(); |
||
178 | } |
||
179 | |||
180 | if ($this->getName()) { |
||
181 | // Prevent if working dir is "/" normalizeWorkingDir will add double "//" that breaks S3 functionality |
||
182 | $path = rtrim($path, Lfm::DS) . Lfm::DS . $this->getName(); |
||
183 | } |
||
184 | |||
185 | return $path; |
||
186 | } |
||
187 | |||
188 | /** |
||
189 | * Sort files and directories. |
||
190 | * |
||
191 | * @param mixed $arr_items Array of files or folders or both. |
||
192 | * @return array of object |
||
193 | */ |
||
194 | public function sortByColumn($arr_items) |
||
195 | { |
||
196 | $sort_by = $this->helper->input('sort_type'); |
||
197 | if (in_array($sort_by, ['name', 'time'])) { |
||
198 | $key_to_sort = $sort_by; |
||
199 | } else { |
||
200 | $key_to_sort = 'name'; |
||
201 | } |
||
202 | |||
203 | uasort($arr_items, function ($a, $b) use ($key_to_sort) { |
||
204 | return strcmp($a->{$key_to_sort}, $b->{$key_to_sort}); |
||
205 | }); |
||
206 | |||
207 | return $arr_items; |
||
208 | } |
||
209 | |||
210 | public function error($error_type, $variables = []) |
||
211 | { |
||
212 | throw new \Exception($this->helper->error($error_type, $variables)); |
||
213 | } |
||
214 | |||
215 | // Upload section |
||
216 | public function upload($file) |
||
233 | } |
||
234 | |||
235 | private function uploadValidator($file) |
||
236 | { |
||
237 | if (empty($file)) { |
||
238 | return $this->error('file-empty'); |
||
239 | } elseif (! $file instanceof UploadedFile) { |
||
240 | return $this->error('instance'); |
||
241 | } elseif ($file->getError() == UPLOAD_ERR_INI_SIZE) { |
||
242 | return $this->error('file-size', ['max' => ini_get('upload_max_filesize')]); |
||
243 | } elseif ($file->getError() != UPLOAD_ERR_OK) { |
||
244 | throw new \Exception('File failed to upload. Error code: ' . $file->getError()); |
||
245 | } |
||
246 | |||
247 | $new_file_name = $this->getNewName($file); |
||
248 | |||
249 | if ($this->setName($new_file_name)->exists() && !config('lfm.over_write_on_duplicate')) { |
||
250 | return $this->error('file-exist'); |
||
251 | } |
||
252 | |||
253 | $mimetype = $file->getMimeType(); |
||
254 | |||
255 | $excutable = ['text/x-php']; |
||
256 | |||
257 | if (in_array($mimetype, $excutable)) { |
||
258 | throw new \Exception('Invalid file detected'); |
||
259 | } |
||
260 | |||
261 | if (config('lfm.should_validate_mime', false)) { |
||
262 | if (false === in_array($mimetype, $this->helper->availableMimeTypes())) { |
||
263 | return $this->error('mime') . $mimetype; |
||
264 | } |
||
265 | } |
||
266 | |||
267 | if (config('lfm.should_validate_size', false)) { |
||
268 | // size to kb unit is needed |
||
269 | $file_size = $file->getSize() / 1000; |
||
270 | if ($file_size > $this->helper->maxUploadSize()) { |
||
271 | return $this->error('size') . $file_size; |
||
272 | } |
||
273 | } |
||
274 | |||
275 | return 'pass'; |
||
276 | } |
||
277 | |||
278 | private function getNewName($file) |
||
279 | { |
||
280 | $new_file_name = $this->helper |
||
281 | ->translateFromUtf8(trim(pathinfo($file->getClientOriginalName(), PATHINFO_FILENAME))); |
||
282 | |||
283 | $extension = $file->getClientOriginalExtension(); |
||
284 | |||
285 | if (config('lfm.rename_file') === true) { |
||
286 | $new_file_name = uniqid(); |
||
287 | } elseif (config('lfm.alphanumeric_filename') === true) { |
||
288 | $new_file_name = preg_replace('/[^A-Za-z0-9\-\']/', '_', $new_file_name); |
||
289 | } |
||
290 | |||
291 | if ($extension) { |
||
292 | $new_file_name_with_extention = $new_file_name . '.' . $extension; |
||
293 | } |
||
294 | |||
295 | if (config('lfm.rename_duplicates') === true) { |
||
296 | $counter = 1; |
||
297 | $file_name_without_extentions = $new_file_name; |
||
298 | while ($this->setName(($extension) ? $new_file_name_with_extention : $new_file_name)->exists()) { |
||
299 | if (config('lfm.alphanumeric_filename') === true) { |
||
300 | $suffix = '_'.$counter; |
||
301 | } else { |
||
302 | $suffix = " ({$counter})"; |
||
303 | } |
||
304 | $new_file_name = $file_name_without_extentions.$suffix; |
||
305 | |||
306 | if ($extension) { |
||
307 | $new_file_name_with_extention = $new_file_name . '.' . $extension; |
||
308 | } |
||
309 | $counter++; |
||
310 | } |
||
311 | } |
||
312 | |||
313 | return ($extension) ? $new_file_name_with_extention : $new_file_name; |
||
314 | } |
||
315 | |||
316 | private function saveFile($file, $new_file_name) |
||
323 | } |
||
324 | |||
325 | public function makeThumbnail($file_name) |
||
342 | } |
||
343 | } |
||
344 |
This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.
This is most likely a typographical error or the method has been renamed.