Complex classes like BaseFileHelper 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. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
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 BaseFileHelper, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 24 | class BaseFileHelper |
||
| 25 | { |
||
| 26 | const PATTERN_NODIR = 1; |
||
| 27 | const PATTERN_ENDSWITH = 4; |
||
| 28 | const PATTERN_MUSTBEDIR = 8; |
||
| 29 | const PATTERN_NEGATIVE = 16; |
||
| 30 | const PATTERN_CASE_INSENSITIVE = 32; |
||
| 31 | |||
| 32 | /** |
||
| 33 | * @var string the path (or alias) of a PHP file containing MIME type information. |
||
| 34 | */ |
||
| 35 | public static $mimeMagicFile = '@yii/helpers/mimeTypes.php'; |
||
| 36 | |||
| 37 | |||
| 38 | /** |
||
| 39 | * Normalizes a file/directory path. |
||
| 40 | * |
||
| 41 | * The normalization does the following work: |
||
| 42 | * |
||
| 43 | * - Convert all directory separators into `DIRECTORY_SEPARATOR` (e.g. "\a/b\c" becomes "/a/b/c") |
||
| 44 | * - Remove trailing directory separators (e.g. "/a/b/c/" becomes "/a/b/c") |
||
| 45 | * - Turn multiple consecutive slashes into a single one (e.g. "/a///b/c" becomes "/a/b/c") |
||
| 46 | * - Remove ".." and "." based on their meanings (e.g. "/a/./b/../c" becomes "/a/c") |
||
| 47 | * |
||
| 48 | * @param string $path the file/directory path to be normalized |
||
| 49 | * @param string $ds the directory separator to be used in the normalized result. Defaults to `DIRECTORY_SEPARATOR`. |
||
| 50 | * @return string the normalized file/directory path |
||
| 51 | */ |
||
| 52 | 34 | public static function normalizePath($path, $ds = DIRECTORY_SEPARATOR) |
|
| 72 | |||
| 73 | /** |
||
| 74 | * Returns the localized version of a specified file. |
||
| 75 | * |
||
| 76 | * The searching is based on the specified language code. In particular, |
||
| 77 | * a file with the same name will be looked for under the subdirectory |
||
| 78 | * whose name is the same as the language code. For example, given the file "path/to/view.php" |
||
| 79 | * and language code "zh-CN", the localized file will be looked for as |
||
| 80 | * "path/to/zh-CN/view.php". If the file is not found, it will try a fallback with just a language code that is |
||
| 81 | * "zh" i.e. "path/to/zh/view.php". If it is not found as well the original file will be returned. |
||
| 82 | * |
||
| 83 | * If the target and the source language codes are the same, |
||
| 84 | * the original file will be returned. |
||
| 85 | * |
||
| 86 | * @param string $file the original file |
||
| 87 | * @param string $language the target language that the file should be localized to. |
||
| 88 | * If not set, the value of [[\yii\base\Application::language]] will be used. |
||
| 89 | * @param string $sourceLanguage the language that the original file is in. |
||
| 90 | * If not set, the value of [[\yii\base\Application::sourceLanguage]] will be used. |
||
| 91 | * @return string the matching localized file, or the original file if the localized version is not found. |
||
| 92 | * If the target and the source language codes are the same, the original file will be returned. |
||
| 93 | */ |
||
| 94 | 71 | public static function localize($file, $language = null, $sourceLanguage = null) |
|
| 118 | |||
| 119 | /** |
||
| 120 | * Determines the MIME type of the specified file. |
||
| 121 | * This method will first try to determine the MIME type based on |
||
| 122 | * [finfo_open](http://php.net/manual/en/function.finfo-open.php). If the `fileinfo` extension is not installed, |
||
| 123 | * it will fall back to [[getMimeTypeByExtension()]] when `$checkExtension` is true. |
||
| 124 | * @param string $file the file name. |
||
| 125 | * @param string $magicFile name of the optional magic database file (or alias), usually something like `/path/to/magic.mime`. |
||
| 126 | * This will be passed as the second parameter to [finfo_open()](http://php.net/manual/en/function.finfo-open.php) |
||
| 127 | * when the `fileinfo` extension is installed. If the MIME type is being determined based via [[getMimeTypeByExtension()]] |
||
| 128 | * and this is null, it will use the file specified by [[mimeMagicFile]]. |
||
| 129 | * @param bool $checkExtension whether to use the file extension to determine the MIME type in case |
||
| 130 | * `finfo_open()` cannot determine it. |
||
| 131 | * @return string the MIME type (e.g. `text/plain`). Null is returned if the MIME type cannot be determined. |
||
| 132 | * @throws InvalidConfigException when the `fileinfo` PHP extension is not installed and `$checkExtension` is `false`. |
||
| 133 | */ |
||
| 134 | 12 | public static function getMimeType($file, $magicFile = null, $checkExtension = true) |
|
| 159 | |||
| 160 | /** |
||
| 161 | * Determines the MIME type based on the extension name of the specified file. |
||
| 162 | * This method will use a local map between extension names and MIME types. |
||
| 163 | * @param string $file the file name. |
||
| 164 | * @param string $magicFile the path (or alias) of the file that contains all available MIME type information. |
||
| 165 | * If this is not set, the file specified by [[mimeMagicFile]] will be used. |
||
| 166 | * @return string|null the MIME type. Null is returned if the MIME type cannot be determined. |
||
| 167 | */ |
||
| 168 | 8 | public static function getMimeTypeByExtension($file, $magicFile = null) |
|
| 181 | |||
| 182 | /** |
||
| 183 | * Determines the extensions by given MIME type. |
||
| 184 | * This method will use a local map between extension names and MIME types. |
||
| 185 | * @param string $mimeType file MIME type. |
||
| 186 | * @param string $magicFile the path (or alias) of the file that contains all available MIME type information. |
||
| 187 | * If this is not set, the file specified by [[mimeMagicFile]] will be used. |
||
| 188 | * @return array the extensions corresponding to the specified MIME type |
||
| 189 | */ |
||
| 190 | public static function getExtensionsByMimeType($mimeType, $magicFile = null) |
||
| 195 | |||
| 196 | private static $_mimeTypes = []; |
||
| 197 | |||
| 198 | /** |
||
| 199 | * Loads MIME types from the specified file. |
||
| 200 | * @param string $magicFile the path (or alias) of the file that contains all available MIME type information. |
||
| 201 | * If this is not set, the file specified by [[mimeMagicFile]] will be used. |
||
| 202 | * @return array the mapping from file extensions to MIME types |
||
| 203 | */ |
||
| 204 | 8 | protected static function loadMimeTypes($magicFile) |
|
| 216 | |||
| 217 | /** |
||
| 218 | * Copies a whole directory as another one. |
||
| 219 | * The files and sub-directories will also be copied over. |
||
| 220 | * @param string $src the source directory |
||
| 221 | * @param string $dst the destination directory |
||
| 222 | * @param array $options options for directory copy. Valid options are: |
||
| 223 | * |
||
| 224 | * - dirMode: integer, the permission to be set for newly copied directories. Defaults to 0775. |
||
| 225 | * - fileMode: integer, the permission to be set for newly copied files. Defaults to the current environment setting. |
||
| 226 | * - filter: callback, a PHP callback that is called for each directory or file. |
||
| 227 | * The signature of the callback should be: `function ($path)`, where `$path` refers the full path to be filtered. |
||
| 228 | * The callback can return one of the following values: |
||
| 229 | * |
||
| 230 | * * true: the directory or file will be copied (the "only" and "except" options will be ignored) |
||
| 231 | * * false: the directory or file will NOT be copied (the "only" and "except" options will be ignored) |
||
| 232 | * * null: the "only" and "except" options will determine whether the directory or file should be copied |
||
| 233 | * |
||
| 234 | * - only: array, list of patterns that the file paths should match if they want to be copied. |
||
| 235 | * A path matches a pattern if it contains the pattern string at its end. |
||
| 236 | * For example, '.php' matches all file paths ending with '.php'. |
||
| 237 | * Note, the '/' characters in a pattern matches both '/' and '\' in the paths. |
||
| 238 | * If a file path matches a pattern in both "only" and "except", it will NOT be copied. |
||
| 239 | * - except: array, list of patterns that the files or directories should match if they want to be excluded from being copied. |
||
| 240 | * A path matches a pattern if it contains the pattern string at its end. |
||
| 241 | * Patterns ending with '/' apply to directory paths only, and patterns not ending with '/' |
||
| 242 | * apply to file paths only. For example, '/a/b' matches all file paths ending with '/a/b'; |
||
| 243 | * and '.svn/' matches directory paths ending with '.svn'. Note, the '/' characters in a pattern matches |
||
| 244 | * both '/' and '\' in the paths. |
||
| 245 | * - caseSensitive: boolean, whether patterns specified at "only" or "except" should be case sensitive. Defaults to true. |
||
| 246 | * - recursive: boolean, whether the files under the subdirectories should also be copied. Defaults to true. |
||
| 247 | * - beforeCopy: callback, a PHP callback that is called before copying each sub-directory or file. |
||
| 248 | * If the callback returns false, the copy operation for the sub-directory or file will be cancelled. |
||
| 249 | * The signature of the callback should be: `function ($from, $to)`, where `$from` is the sub-directory or |
||
| 250 | * file to be copied from, while `$to` is the copy target. |
||
| 251 | * - afterCopy: callback, a PHP callback that is called after each sub-directory or file is successfully copied. |
||
| 252 | * The signature of the callback should be: `function ($from, $to)`, where `$from` is the sub-directory or |
||
| 253 | * file copied from, while `$to` is the copy target. |
||
| 254 | * - copyEmptyDirectories: boolean, whether to copy empty directories. Set this to false to avoid creating directories |
||
| 255 | * that do not contain files. This affects directories that do not contain files initially as well as directories that |
||
| 256 | * do not contain files at the target destination because files have been filtered via `only` or `except`. |
||
| 257 | * Defaults to true. This option is available since version 2.0.12. Before 2.0.12 empty directories are always copied. |
||
| 258 | * @throws \yii\base\InvalidParamException if unable to open directory |
||
| 259 | */ |
||
| 260 | 17 | public static function copyDirectory($src, $dst, $options = []) |
|
| 316 | |||
| 317 | /** |
||
| 318 | * Removes a directory (and all its content) recursively. |
||
| 319 | * |
||
| 320 | * @param string $dir the directory to be deleted recursively. |
||
| 321 | * @param array $options options for directory remove. Valid options are: |
||
| 322 | * |
||
| 323 | * - traverseSymlinks: boolean, whether symlinks to the directories should be traversed too. |
||
| 324 | * Defaults to `false`, meaning the content of the symlinked directory would not be deleted. |
||
| 325 | * Only symlink would be removed in that default case. |
||
| 326 | * |
||
| 327 | * @throws ErrorException in case of failure |
||
| 328 | */ |
||
| 329 | 112 | public static function removeDirectory($dir, $options = []) |
|
| 367 | |||
| 368 | /** |
||
| 369 | * Returns the files found under the specified directory and subdirectories. |
||
| 370 | * @param string $dir the directory under which the files will be looked for. |
||
| 371 | * @param array $options options for file searching. Valid options are: |
||
| 372 | * |
||
| 373 | * - `filter`: callback, a PHP callback that is called for each directory or file. |
||
| 374 | * The signature of the callback should be: `function ($path)`, where `$path` refers the full path to be filtered. |
||
| 375 | * The callback can return one of the following values: |
||
| 376 | * |
||
| 377 | * * `true`: the directory or file will be returned (the `only` and `except` options will be ignored) |
||
| 378 | * * `false`: the directory or file will NOT be returned (the `only` and `except` options will be ignored) |
||
| 379 | * * `null`: the `only` and `except` options will determine whether the directory or file should be returned |
||
| 380 | * |
||
| 381 | * - `except`: array, list of patterns excluding from the results matching file or directory paths. |
||
| 382 | * Patterns ending with slash ('/') apply to directory paths only, and patterns not ending with '/' |
||
| 383 | * apply to file paths only. For example, '/a/b' matches all file paths ending with '/a/b'; |
||
| 384 | * and `.svn/` matches directory paths ending with `.svn`. |
||
| 385 | * If the pattern does not contain a slash (`/`), it is treated as a shell glob pattern |
||
| 386 | * and checked for a match against the pathname relative to `$dir`. |
||
| 387 | * Otherwise, the pattern is treated as a shell glob suitable for consumption by `fnmatch(3)` |
||
| 388 | * with the `FNM_PATHNAME` flag: wildcards in the pattern will not match a `/` in the pathname. |
||
| 389 | * For example, `views/*.php` matches `views/index.php` but not `views/controller/index.php`. |
||
| 390 | * A leading slash matches the beginning of the pathname. For example, `/*.php` matches `index.php` but not `views/start/index.php`. |
||
| 391 | * An optional prefix `!` which negates the pattern; any matching file excluded by a previous pattern will become included again. |
||
| 392 | * If a negated pattern matches, this will override lower precedence patterns sources. Put a backslash (`\`) in front of the first `!` |
||
| 393 | * for patterns that begin with a literal `!`, for example, `\!important!.txt`. |
||
| 394 | * Note, the '/' characters in a pattern matches both '/' and '\' in the paths. |
||
| 395 | * - `only`: array, list of patterns that the file paths should match if they are to be returned. Directory paths |
||
| 396 | * are not checked against them. Same pattern matching rules as in the `except` option are used. |
||
| 397 | * If a file path matches a pattern in both `only` and `except`, it will NOT be returned. |
||
| 398 | * - `caseSensitive`: boolean, whether patterns specified at `only` or `except` should be case sensitive. Defaults to `true`. |
||
| 399 | * - `recursive`: boolean, whether the files under the subdirectories should also be looked for. Defaults to `true`. |
||
| 400 | * @return array files found under the directory, in no particular order. Ordering depends on the files system used. |
||
| 401 | * @throws InvalidParamException if the dir is invalid. |
||
| 402 | */ |
||
| 403 | 65 | public static function findFiles($dir, $options = []) |
|
| 436 | |||
| 437 | /** |
||
| 438 | * Checks if the given file path satisfies the filtering options. |
||
| 439 | * @param string $path the path of the file or directory to be checked |
||
| 440 | * @param array $options the filtering options. See [[findFiles()]] for explanations of |
||
| 441 | * the supported options. |
||
| 442 | * @return bool whether the file or directory satisfies the filtering options. |
||
| 443 | */ |
||
| 444 | 74 | public static function filterPath($path, $options) |
|
| 476 | |||
| 477 | /** |
||
| 478 | * Creates a new directory. |
||
| 479 | * |
||
| 480 | * This method is similar to the PHP `mkdir()` function except that |
||
| 481 | * it uses `chmod()` to set the permission of the created directory |
||
| 482 | * in order to avoid the impact of the `umask` setting. |
||
| 483 | * |
||
| 484 | * @param string $path path of the directory to be created. |
||
| 485 | * @param int $mode the permission to be set for the created directory. |
||
| 486 | * @param bool $recursive whether to create parent directories if they do not exist. |
||
| 487 | * @return bool whether the directory is created successfully |
||
| 488 | * @throws \yii\base\Exception if the directory could not be created (i.e. php error due to parallel changes) |
||
| 489 | */ |
||
| 490 | 164 | public static function createDirectory($path, $mode = 0775, $recursive = true) |
|
| 515 | |||
| 516 | /** |
||
| 517 | * Performs a simple comparison of file or directory names. |
||
| 518 | * |
||
| 519 | * Based on match_basename() from dir.c of git 1.8.5.3 sources. |
||
| 520 | * |
||
| 521 | * @param string $baseName file or directory name to compare with the pattern |
||
| 522 | * @param string $pattern the pattern that $baseName will be compared against |
||
| 523 | * @param int|bool $firstWildcard location of first wildcard character in the $pattern |
||
| 524 | * @param int $flags pattern flags |
||
| 525 | * @return bool whether the name matches against pattern |
||
| 526 | */ |
||
| 527 | 53 | private static function matchBasename($baseName, $pattern, $firstWildcard, $flags) |
|
| 548 | |||
| 549 | /** |
||
| 550 | * Compares a path part against a pattern with optional wildcards. |
||
| 551 | * |
||
| 552 | * Based on match_pathname() from dir.c of git 1.8.5.3 sources. |
||
| 553 | * |
||
| 554 | * @param string $path full path to compare |
||
| 555 | * @param string $basePath base of path that will not be compared |
||
| 556 | * @param string $pattern the pattern that path part will be compared against |
||
| 557 | * @param int|bool $firstWildcard location of first wildcard character in the $pattern |
||
| 558 | * @param int $flags pattern flags |
||
| 559 | * @return bool whether the path part matches against pattern |
||
| 560 | */ |
||
| 561 | 37 | private static function matchPathname($path, $basePath, $pattern, $firstWildcard, $flags) |
|
| 602 | |||
| 603 | /** |
||
| 604 | * Scan the given exclude list in reverse to see whether pathname |
||
| 605 | * should be ignored. The first match (i.e. the last on the list), if |
||
| 606 | * any, determines the fate. Returns the element which |
||
| 607 | * matched, or null for undecided. |
||
| 608 | * |
||
| 609 | * Based on last_exclude_matching_from_list() from dir.c of git 1.8.5.3 sources. |
||
| 610 | * |
||
| 611 | * @param string $basePath |
||
| 612 | * @param string $path |
||
| 613 | * @param array $excludes list of patterns to match $path against |
||
| 614 | * @return array|null null or one of $excludes item as an array with keys: 'pattern', 'flags' |
||
| 615 | * @throws InvalidParamException if any of the exclude patterns is not a string or an array with keys: pattern, flags, firstWildcard. |
||
| 616 | */ |
||
| 617 | 54 | private static function lastExcludeMatchingFromList($basePath, $path, $excludes) |
|
| 644 | |||
| 645 | /** |
||
| 646 | * Processes the pattern, stripping special characters like / and ! from the beginning and settings flags instead. |
||
| 647 | * @param string $pattern |
||
| 648 | * @param bool $caseSensitive |
||
| 649 | * @throws \yii\base\InvalidParamException |
||
| 650 | * @return array with keys: (string) pattern, (int) flags, (int|bool) firstWildcard |
||
| 651 | */ |
||
| 652 | 54 | private static function parseExcludePattern($pattern, $caseSensitive) |
|
| 691 | |||
| 692 | /** |
||
| 693 | * Searches for the first wildcard character in the pattern. |
||
| 694 | * @param string $pattern the pattern to search in |
||
| 695 | * @return int|bool position of first wildcard character or false if not found |
||
| 696 | */ |
||
| 697 | 54 | private static function firstWildcardInPattern($pattern) |
|
| 708 | |||
| 709 | /** |
||
| 710 | * @param array $options raw options |
||
| 711 | * @return array normalized options |
||
| 712 | * @since 2.0.12 |
||
| 713 | */ |
||
| 714 | 76 | protected static function normalizeOptions(array $options) |
|
| 736 | } |
||
| 737 |
If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:
If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.