summaryrefslogtreecommitdiffstats
path: root/modules/doc/library/Doc/Search/DocSearch.php
blob: 20493e47eb6aba5d8eaadd3249b1fd24e280ad74 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
<?php
/* Icinga Web 2 | (c) 2015 Icinga Development Team | GPLv2+ */

namespace Icinga\Module\Doc\Search;

/**
 * Search documentation for a given search string
 */
class DocSearch
{
    /**
     * Search string
     *
     * @var string
     */
    protected $input;

    /**
     * Search criteria
     *
     * @var array
     */
    protected $search;

    /**
     * Create a new doc search from the given search string
     *
     * @param string $search
     */
    public function __construct($search)
    {
        $this->input = $search = (string) $search;
        $criteria = array();
        if (preg_match_all('/"(?P<search>[^"]*)"/', $search, $matches, PREG_SET_ORDER | PREG_OFFSET_CAPTURE)) {
            $unquoted = array();
            $offset = 0;
            foreach ($matches as $match) {
                $fullMatch = $match[0];
                $searchMatch = $match['search'];
                $unquoted[] = substr($search, $offset, $fullMatch[1] - $offset);
                $offset = $fullMatch[1] + strlen($fullMatch[0]);
                if (strlen($searchMatch[0]) > 0) {
                    $criteria[] = $searchMatch[0];
                }
            }
            $unquoted[] = substr($search, $offset);
            $search = implode(' ', $unquoted);
        }
        $this->search = array_map(
            'strtolower',
            array_unique(array_merge($criteria, array_filter(explode(' ', trim($search)))))
        );
    }

    /**
     * Get the search criteria
     *
     * @return array
     */
    public function getCriteria()
    {
        return $this->search;
    }

    /**
     * Get the search string
     *
     * @return string
     */
    public function getInput()
    {
        return $this->input;
    }

    /**
     * Search in the given line
     *
     * @param   string  $line
     *
     * @return  DocSearchMatch|null
     */
    public function search($line)
    {
        $match = new DocSearchMatch();
        $match->setLine($line);
        foreach ($this->search as $criteria) {
            $offset = 0;
            while (($position = stripos($line, $criteria, $offset)) !== false) {
                $match->appendMatch(substr($line, $position, strlen($criteria)), $position);
                $offset = $position + 1;
            }
        }
        return $match->isEmpty() ? null : $match;
    }
}