refactoaaar
[mdref/mdref] / mdref / Finder.php
1 <?php
2
3 namespace mdref;
4
5 /**
6 * Find markdown reference files in several REFPATH paths.
7 *
8 * The base URL is used to extract the relative identifier out of the request
9 * url in Finder::find().
10 *
11 * Use the created Path of Finder::find() for Finder::glob() to find subrefs.
12 */
13 class Finder
14 {
15 /**
16 * Base URL
17 * @var \http\Controller\Url
18 */
19 protected $baseUrl;
20
21 /**
22 * Reference paths
23 * @var array
24 */
25 protected $refs = array();
26
27 /**
28 * @param \http\Controller\Url $baseUrl
29 * @param mixed $paths array or string of paths with markdown references
30 */
31 function __construct(\http\Controller\Url $baseUrl, $paths = ".") {
32 if (!is_array($paths)) {
33 $paths = explode(PATH_SEPARATOR, $paths);
34 }
35 $this->refs = $paths;
36 $this->baseUrl = $baseUrl;
37 }
38
39 /**
40 * Find a markdown reference file in one REFPATH. If nothing could be found
41 * an empty Path will be returned.
42 *
43 * @param \http\Url $requestUrl
44 * @return Path
45 */
46 function find(\http\Url $requestUrl, $ext = ".md") {
47 $file = implode(DIRECTORY_SEPARATOR, $this->baseUrl->params($requestUrl));
48
49 foreach ($this->refs as $base) {
50 $path = new Path($base, $file);
51 if ($path->isFile($ext)) {
52 return $path;
53 }
54 }
55
56 return new Path;
57 }
58
59 /**
60 * Glob either in a Path's base dir, or, if the path does not have a base
61 * dir set, in each REFPATH paths.
62 *
63 * @param \mdref\Path $path
64 * @param string $pattern glob pattern
65 * @param int $flags glob flags
66 * @return array glob result
67 */
68 function glob(Path $path, $pattern, $flags = GLOB_BRACE) {
69 if (strlen($path->getBaseDir())) {
70 return glob($path->getFullPath($pattern), $flags);
71 }
72 $glob = array();
73 foreach ($this->refs as $ref) {
74 $glob = array_merge($glob, array_map(function ($fn) use ($ref) {
75 return substr($fn, strlen($ref));
76 }, glob($ref . $pattern, $flags)));
77 }
78 return $glob;
79 }
80 }