webmozart /
glob
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like Glob 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 Glob, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 75 | final class Glob |
||
| 76 | { |
||
| 77 | /** |
||
| 78 | * Flag: Filter the values in {@link Glob::filter()}. |
||
| 79 | */ |
||
| 80 | const FILTER_VALUE = 1; |
||
| 81 | |||
| 82 | /** |
||
| 83 | * Flag: Filter the keys in {@link Glob::filter()}. |
||
| 84 | */ |
||
| 85 | const FILTER_KEY = 2; |
||
| 86 | |||
| 87 | /** |
||
| 88 | * Globs the file system paths matching the glob. |
||
| 89 | * |
||
| 90 | * The glob may contain the wildcard "*". This wildcard matches any number |
||
| 91 | * of characters, *including* directory separators. |
||
| 92 | * |
||
| 93 | * ```php |
||
| 94 | * foreach (Glob::glob('/project/**.twig') as $path) { |
||
| 95 | * // do something... |
||
| 96 | * } |
||
| 97 | * ``` |
||
| 98 | * |
||
| 99 | * @param string $glob The canonical glob. The glob should contain forward |
||
| 100 | * slashes as directory separators only. It must not |
||
| 101 | * contain any "." or ".." segments. Use the |
||
| 102 | * "webmozart/path-util" utility to canonicalize globs |
||
| 103 | * prior to calling this method. |
||
| 104 | * @param int $flags A bitwise combination of the flag constants in this |
||
| 105 | * class. |
||
| 106 | * |
||
| 107 | * @return string[] The matching paths. The keys of the array are |
||
| 108 | * incrementing integers. |
||
| 109 | */ |
||
| 110 | 8 | public static function glob($glob, $flags = 0) |
|
| 118 | |||
| 119 | /** |
||
| 120 | * Matches a path against a glob. |
||
| 121 | * |
||
| 122 | * ```php |
||
| 123 | * if (Glob::match('/project/views/index.html.twig', '/project/**.twig')) { |
||
| 124 | * // path matches |
||
| 125 | * } |
||
| 126 | * ``` |
||
| 127 | * |
||
| 128 | * @param string $path The path to match. |
||
| 129 | * @param string $glob The canonical glob. The glob should contain forward |
||
| 130 | * slashes as directory separators only. It must not |
||
| 131 | * contain any "." or ".." segments. Use the |
||
| 132 | * "webmozart/path-util" utility to canonicalize globs |
||
| 133 | * prior to calling this method. |
||
| 134 | * @param int $flags A bitwise combination of the flag constants in |
||
| 135 | * this class. |
||
| 136 | * |
||
| 137 | * @return bool Returns `true` if the path is matched by the glob. |
||
| 138 | */ |
||
| 139 | 12 | public static function match($path, $glob, $flags = 0) |
|
| 155 | |||
| 156 | /** |
||
| 157 | * Filters an array for paths matching a glob. |
||
| 158 | * |
||
| 159 | * The filtered array is returned. This array preserves the keys of the |
||
| 160 | * passed array. |
||
| 161 | * |
||
| 162 | * ```php |
||
| 163 | * $filteredPaths = Glob::filter($paths, '/project/**.twig'); |
||
| 164 | * ``` |
||
| 165 | * |
||
| 166 | * @param string[] $paths A list of paths. |
||
| 167 | * @param string $glob The canonical glob. The glob should contain |
||
| 168 | * forward slashes as directory separators only. It |
||
| 169 | * must not contain any "." or ".." segments. Use the |
||
| 170 | * "webmozart/path-util" utility to canonicalize |
||
| 171 | * globs prior to calling this method. |
||
| 172 | * @param int $flags A bitwise combination of the flag constants in |
||
| 173 | * this class. |
||
| 174 | * |
||
| 175 | * @return string[] The paths matching the glob indexed by their original |
||
| 176 | * keys. |
||
| 177 | */ |
||
| 178 | 9 | public static function filter(array $paths, $glob, $flags = self::FILTER_VALUE) |
|
| 179 | { |
||
| 180 | 9 | if (($flags & self::FILTER_VALUE) && ($flags & self::FILTER_KEY)) { |
|
| 181 | 1 | throw new InvalidArgumentException('The flags Glob::FILTER_VALUE and Glob::FILTER_KEY cannot be passed at the same time.'); |
|
| 182 | } |
||
| 183 | |||
| 184 | 8 | if (!self::isDynamic($glob)) { |
|
| 185 | 2 | if ($flags & self::FILTER_KEY) { |
|
| 186 | 1 | return isset($paths[$glob]) ? array($glob => $paths[$glob]) : array(); |
|
| 187 | } |
||
| 188 | |||
| 189 | 1 | $key = array_search($glob, $paths); |
|
| 190 | |||
| 191 | 1 | return false !== $key ? array($key => $glob) : array(); |
|
| 192 | } |
||
| 193 | |||
| 194 | 6 | $staticPrefix = self::getStaticPrefix($glob, $flags); |
|
| 195 | 4 | $regExp = self::toRegEx($glob, $flags); |
|
| 196 | 4 | $filter = function ($path) use ($staticPrefix, $regExp) { |
|
| 197 | 4 | return 0 === strpos($path, $staticPrefix) && preg_match($regExp, $path); |
|
| 198 | 4 | }; |
|
| 199 | |||
| 200 | 4 | if (PHP_VERSION_ID >= 50600) { |
|
| 201 | 4 | $filterFlags = ($flags & self::FILTER_KEY) ? ARRAY_FILTER_USE_KEY : 0; |
|
| 202 | |||
| 203 | 4 | return array_filter($paths, $filter, $filterFlags); |
|
| 204 | } |
||
| 205 | |||
| 206 | // No support yet for the third argument of array_filter() |
||
| 207 | if ($flags & self::FILTER_KEY) { |
||
| 208 | $result = array(); |
||
| 209 | |||
| 210 | foreach ($paths as $path => $value) { |
||
| 211 | if ($filter($path)) { |
||
| 212 | $result[$path] = $value; |
||
| 213 | } |
||
| 214 | } |
||
| 215 | |||
| 216 | return $result; |
||
| 217 | } |
||
| 218 | |||
| 219 | return array_filter($paths, $filter); |
||
| 220 | } |
||
| 221 | |||
| 222 | /** |
||
| 223 | * Returns the base path of a glob. |
||
| 224 | * |
||
| 225 | * This method returns the most specific directory that contains all files |
||
| 226 | * matched by the glob. If this directory does not exist on the file system, |
||
| 227 | * it's not necessary to execute the glob algorithm. |
||
| 228 | * |
||
| 229 | * More specifically, the "base path" is the longest path trailed by a "/" |
||
| 230 | * on the left of the first wildcard "*". If the glob does not contain |
||
| 231 | * wildcards, the directory name of the glob is returned. |
||
| 232 | * |
||
| 233 | * ```php |
||
| 234 | * Glob::getBasePath('/css/*.css'); |
||
| 235 | * // => /css |
||
| 236 | * |
||
| 237 | * Glob::getBasePath('/css/style.css'); |
||
| 238 | * // => /css |
||
| 239 | * |
||
| 240 | * Glob::getBasePath('/css/st*.css'); |
||
| 241 | * // => /css |
||
| 242 | * |
||
| 243 | * Glob::getBasePath('/*.css'); |
||
| 244 | * // => / |
||
| 245 | * ``` |
||
| 246 | * |
||
| 247 | * @param string $glob The canonical glob. The glob should contain forward |
||
| 248 | * slashes as directory separators only. It must not |
||
| 249 | * contain any "." or ".." segments. Use the |
||
| 250 | * "webmozart/path-util" utility to canonicalize globs |
||
| 251 | * prior to calling this method. |
||
| 252 | * @param int $flags A bitwise combination of the flag constants in this |
||
| 253 | * class. |
||
| 254 | * |
||
| 255 | * @return string The base path of the glob. |
||
| 256 | */ |
||
| 257 | 42 | public static function getBasePath($glob, $flags = 0) |
|
| 281 | |||
| 282 | /** |
||
| 283 | * Converts a glob to a regular expression. |
||
| 284 | * |
||
| 285 | * Use this method if you need to match many paths against a glob: |
||
| 286 | * |
||
| 287 | * ```php |
||
| 288 | * $staticPrefix = Glob::getStaticPrefix('/project/**.twig'); |
||
| 289 | * $regEx = Glob::toRegEx('/project/**.twig'); |
||
| 290 | * |
||
| 291 | * if (0 !== strpos($path, $staticPrefix)) { |
||
| 292 | * // no match |
||
| 293 | * } |
||
| 294 | * |
||
| 295 | * if (!preg_match($regEx, $path)) { |
||
| 296 | * // no match |
||
| 297 | * } |
||
| 298 | * ``` |
||
| 299 | * |
||
| 300 | * You should always test whether a path contains the static prefix of the |
||
| 301 | * glob returned by {@link getStaticPrefix()} to reduce the number of calls |
||
| 302 | * to the expensive {@link preg_match()}. |
||
| 303 | * |
||
| 304 | * @param string $glob The canonical glob. The glob should contain forward |
||
| 305 | * slashes as directory separators only. It must not |
||
| 306 | * contain any "." or ".." segments. Use the |
||
| 307 | * "webmozart/path-util" utility to canonicalize globs |
||
| 308 | * prior to calling this method. |
||
| 309 | * @param int $flags A bitwise combination of the flag constants in this |
||
| 310 | * class. |
||
| 311 | * |
||
| 312 | * @return string The regular expression for matching the glob. |
||
| 313 | */ |
||
| 314 | 75 | public static function toRegEx($glob, $flags = 0, $delimiter = '~') |
|
| 442 | |||
| 443 | /** |
||
| 444 | * Returns the static prefix of a glob. |
||
| 445 | * |
||
| 446 | * The "static prefix" is the part of the glob up to the first wildcard "*". |
||
| 447 | * If the glob does not contain wildcards, the full glob is returned. |
||
| 448 | * |
||
| 449 | * @param string $glob The canonical glob. The glob should contain forward |
||
| 450 | * slashes as directory separators only. It must not |
||
| 451 | * contain any "." or ".." segments. Use the |
||
| 452 | * "webmozart/path-util" utility to canonicalize globs |
||
| 453 | * prior to calling this method. |
||
| 454 | * @param int $flags A bitwise combination of the flag constants in this |
||
| 455 | * class. |
||
| 456 | * |
||
| 457 | * @return string The static prefix of the glob. |
||
| 458 | */ |
||
| 459 | 81 | public static function getStaticPrefix($glob, $flags = 0) |
|
| 516 | |||
| 517 | /** |
||
| 518 | * Returns whether the glob contains a dynamic part. |
||
| 519 | * |
||
| 520 | * The glob contains a dynamic part if it contains an unescaped "*" or |
||
| 521 | * "{" character. |
||
| 522 | * |
||
| 523 | * @param string $glob The glob to test. |
||
| 524 | * |
||
| 525 | * @return bool Returns `true` if the glob contains a dynamic part and |
||
| 526 | * `false` otherwise. |
||
| 527 | */ |
||
| 528 | 40 | public static function isDynamic($glob) |
|
| 532 | |||
| 533 | private function __construct() |
||
| 536 | } |
||
| 537 |
Loading history...