summaryrefslogtreecommitdiffstats
path: root/modules/doc/library/Doc/Search/DocSearchMatch.php
blob: 0f217480fd7b472640b77a259ecd60b17676699e (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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
<?php
/* Icinga Web 2 | (c) 2015 Icinga Development Team | GPLv2+ */

namespace Icinga\Module\Doc\Search;

use UnexpectedValueException;
use Icinga\Application\Icinga;
use Icinga\Web\View;

/**
 * A doc search match
 */
class DocSearchMatch
{
    /**
     * CSS class for highlighting matches
     *
     * @var string
     */
    const HIGHLIGHT_CSS_CLASS = 'search-highlight';

    /**
     * Header match
     *
     * @var int
     */
    const MATCH_HEADER = 1;

    /**
     * Content match
     *
     * @var int
     */
    const MATCH_CONTENT = 2;

    /**
     * Line
     *
     * @var string
     */
    protected $line;

    /**
     * Line number
     *
     * @var int
     */
    protected $lineno;

    /**
     * Type of the match
     *
     * @var int
     */
    protected $matchType;

    /**
     * Matches
     *
     * @var array
     */
    protected $matches = array();

    /**
     * View
     *
     * @var View|null
     */
    protected $view;

    /**
     * Set the line
     *
     * @param   string  $line
     *
     * @return  $this
     */
    public function setLine($line)
    {
        $this->line = (string) $line;
        return $this;
    }

    /**
     * Get the line
     *
     * @return string
     */
    public function getLine()
    {
        return $this->line;
    }

    /**
     * Set the line number
     *
     * @param   int $lineno
     *
     * @return  $this
     */
    public function setLineno($lineno)
    {
        $this->lineno = (int) $lineno;
        return $this;
    }

    /**
     * Set the match type
     *
     * @param   int $matchType
     *
     * @return  $this
     */
    public function setMatchType($matchType)
    {
        $matchType = (int) $matchType;
        if ($matchType !== static::MATCH_HEADER && $matchType !== static::MATCH_CONTENT) {
            throw new UnexpectedValueException();
        }
        $this->matchType = $matchType;
        return $this;
    }

    /**
     * Get the match type
     *
     * @return int
     */
    public function getMatchType()
    {
        return $this->matchType;
    }

    /**
     * Append a match
     *
     * @param   string  $match
     * @param   int     $position
     *
     * @return  $this
     */
    public function appendMatch($match, $position)
    {
        $this->matches[(int) $position] = (string) $match;
        return $this;
    }

    /**
     * Get the matches
     *
     * @return array
     */
    public function getMatches()
    {
        return $this->matches;
    }

    /**
     * Set the view
     *
     * @param   View    $view
     *
     * @return  $this
     */
    public function setView(View $view)
    {
        $this->view = $view;
        return $this;
    }

    /**
     * Get the view
     *
     * @return View
     */
    public function getView()
    {
        if ($this->view === null) {
            $this->view = Icinga::app()->getViewRenderer()->view;
        }
        return $this->view;
    }

    /**
     * Get the line having matches highlighted
     *
     * @return string
     */
    public function highlight()
    {
        $highlighted = '';
        $offset = 0;
        $matches = $this->getMatches();
        ksort($matches);
        foreach ($matches as $position => $match) {
            $highlighted .= $this->getView()->escape(substr($this->line, $offset, $position - $offset))
                . '<span class="' . static::HIGHLIGHT_CSS_CLASS .'">'
                . $this->getView()->escape($match)
                . '</span>';
            $offset = $position + strlen($match);
        }
        $highlighted .= $this->getView()->escape(substr($this->line, $offset));
        return $highlighted;
    }

    /**
     * Whether the match is empty
     *
     * @return bool
     */
    public function isEmpty()
    {
        return empty($this->matches);
    }
}