-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Expand file tree
/
Copy pathsearch.html
More file actions
686 lines (586 loc) · 27.9 KB
/
Copy pathsearch.html
File metadata and controls
686 lines (586 loc) · 27.9 KB
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Search | PhpRedis API</title>
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="css/doctum.css">
<link rel="stylesheet" type="text/css" href="fonts/doctum-font.css">
<script src="js/jquery-3.5.1.slim.min.js"></script>
<script async defer src="doctum.js"></script>
<script async defer src="js/bootstrap.min.js"></script>
<script async defer src="js/autocomplete.min.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
<link rel="stylesheet" type="text/css" href="css/highlight-github.min.css">
<script defer src="js/highlight.min.js"></script>
<script>
window.addEventListener('load', function () {
if (!window.hljs) {
return;
}
function ensureCustomClassesAreBuiltIn() {
var classesToAdd = ['Redis', 'RedisCluster', 'RedisArray'];
if (!hljs.getLanguage) {
return;
}
var phpLanguage = hljs.getLanguage('php');
if (!phpLanguage || !phpLanguage.keywords) {
return;
}
var builtIns = phpLanguage.keywords.built_in;
if (!builtIns) {
phpLanguage.keywords.built_in = classesToAdd.join(' ');
return;
}
if (Array.isArray(builtIns)) {
classesToAdd.forEach(function (className) {
if (builtIns.indexOf(className) === -1) {
builtIns.push(className);
}
});
return;
}
if (typeof builtIns === 'string') {
classesToAdd.forEach(function (className) {
if (builtIns.indexOf(className) === -1) {
builtIns += ' ' + className;
}
});
phpLanguage.keywords.built_in = builtIns;
}
}
function collectLinkMetadata(container, typeText) {
var anchors = container.querySelectorAll('a');
var lastIndex = 0;
var meta = [];
for (var i = 0; i < anchors.length; i++) {
var anchor = anchors[i];
var text = anchor.textContent.trim();
if (!text) {
continue;
}
var href = anchor.getAttribute('href');
var start = typeText.indexOf(text, lastIndex);
if (start === -1) {
start = typeText.indexOf(text);
if (start === -1) {
continue;
}
}
meta.push({
start: start,
end: start + text.length,
href: href
});
lastIndex = start + text.length;
}
return meta;
}
function findTextPosition(container, targetIndex) {
var walker = document.createTreeWalker(
container,
NodeFilter.SHOW_TEXT,
null
);
var currentIndex = 0;
var currentNode;
while ((currentNode = walker.nextNode())) {
var nextIndex = currentIndex + currentNode.textContent.length;
if (targetIndex <= nextIndex) {
return {
node: currentNode,
offset: targetIndex - currentIndex
};
}
currentIndex = nextIndex;
}
return null;
}
function restoreLinks(codeElement, meta) {
var sorted = meta.slice().sort(function (a, b) {
return b.start - a.start;
});
for (var i = 0; i < sorted.length; i++) {
var info = sorted[i];
var startPos = findTextPosition(codeElement, info.start);
var endPos = findTextPosition(codeElement, info.end);
if (!startPos || !endPos) {
continue;
}
var range = document.createRange();
range.setStart(startPos.node, startPos.offset);
range.setEnd(endPos.node, endPos.offset);
var anchor = document.createElement('a');
anchor.setAttribute('href', info.href);
anchor.appendChild(range.extractContents());
range.insertNode(anchor);
range.detach();
}
}
function highlightAndRestore(codeElement, metadata) {
hljs.highlightElement(codeElement);
if (metadata && metadata.length) {
restoreLinks(codeElement, metadata);
}
}
ensureCustomClassesAreBuiltIn();
var exampleBlocks = document.querySelectorAll('pre.examples');
exampleBlocks.forEach(function (block) {
if (!block.dataset.language) {
block.dataset.language = 'php';
}
block.classList.add('language-php');
hljs.highlightElement(block);
});
var signatureBlocks = document.querySelectorAll('code.method-signature');
signatureBlocks.forEach(function (block) {
if (!block.classList.contains('language-php')) {
block.classList.add('language-php');
}
hljs.highlightElement(block);
});
var phpCodeBlocks = document.querySelectorAll('pre code.language-php');
phpCodeBlocks.forEach(function (block) {
if (block.classList.contains('method-signature')) {
return;
}
if (block.closest('pre.examples')) {
return;
}
if (block.parentElement && !block.parentElement.classList.contains('language-php')) {
block.parentElement.classList.add('language-php');
}
hljs.highlightElement(block);
});
highlightReturnTypes();
highlightMethodParameters();
highlightApiIndex();
function highlightReturnTypes() {
if (!document.createTreeWalker || !window.NodeFilter) {
return;
}
var containers = document.querySelectorAll('.return-value-content');
containers.forEach(function (container) {
var table = container.querySelector('table');
if (!table) {
return;
}
table.querySelectorAll('tr').forEach(function (row) {
var typeCell = row.querySelector('td');
if (!typeCell || typeCell.querySelector('code.return-type')) {
return;
}
var typeText = typeCell.textContent.trim();
if (!typeText) {
return;
}
var linkMeta = collectLinkMetadata(typeCell, typeText);
var code = document.createElement('code');
code.className = 'return-type language-php';
code.textContent = typeText;
typeCell.innerHTML = '';
typeCell.appendChild(code);
highlightAndRestore(code, linkMeta);
});
});
}
function highlightMethodParameters() {
if (!document.createTreeWalker || !window.NodeFilter) {
return;
}
var headings = document.querySelectorAll('.tags > h4');
headings.forEach(function (heading) {
if (!heading.textContent || heading.textContent.trim() !== 'Parameters') {
return;
}
var table = heading.nextElementSibling;
while (table && table.tagName !== 'TABLE') {
table = table.nextElementSibling;
}
if (!table) {
return;
}
table.querySelectorAll('tr').forEach(function (row) {
var cells = row.querySelectorAll('td');
if (!cells.length) {
return;
}
enhanceParameterCell(cells[0], 'parameter-type');
if (cells.length > 1) {
enhanceParameterCell(cells[1], 'parameter-name');
}
});
});
function enhanceParameterCell(cell, className) {
if (!cell || cell.querySelector('code.' + className)) {
return;
}
var cellText = cell.textContent.trim();
if (!cellText) {
return;
}
var meta = collectLinkMetadata(cell, cellText);
var code = document.createElement('code');
code.className = className + ' language-php';
code.textContent = cellText;
cell.innerHTML = '';
cell.appendChild(code);
highlightAndRestore(code, meta);
}
}
function highlightApiIndex() {
if (!document.createTreeWalker || !window.NodeFilter) {
return;
}
var potentialContainers = document.querySelectorAll('.container-fluid.underlined');
var containers = [];
var anchorSelector = '.row .col-md-8 > a[href^="#method_"]';
for (var i = 0; i < potentialContainers.length; i++) {
var candidate = potentialContainers[i];
if (!candidate.querySelector(anchorSelector)) {
continue;
}
var heading = candidate.previousElementSibling;
if (heading && heading.tagName === 'H2' && heading.textContent && heading.textContent.trim() === 'Methods') {
containers.push(candidate);
}
}
if (!containers.length) {
return;
}
for (var j = 0; j < containers.length; j++) {
var container = containers[j];
var rows = container.querySelectorAll('.row');
for (var k = 0; k < rows.length; k++) {
var row = rows[k];
enhanceTypeCell(row.querySelector('.col-md-2.type'));
enhanceSignatureCell(row.querySelector('.col-md-8'));
}
}
function enhanceTypeCell(typeCell) {
if (!typeCell || typeCell.querySelector('code.method-index-type')) {
return;
}
var typeText = typeCell.textContent.trim();
if (!typeText) {
return;
}
var meta = collectLinkMetadata(typeCell, typeText);
var code = document.createElement('code');
code.className = 'method-index-type language-php';
code.textContent = typeText;
typeCell.innerHTML = '';
typeCell.appendChild(code);
highlightAndRestore(code, meta);
}
function enhanceSignatureCell(signatureCell) {
if (!signatureCell || signatureCell.querySelector('code.method-index-signature')) {
return;
}
var descriptionStart = null;
for (var i = 0; i < signatureCell.children.length; i++) {
var child = signatureCell.children[i];
if (child.tagName === 'P') {
descriptionStart = child;
break;
}
}
var nodesToProcess = [];
var current = signatureCell.firstChild;
while (current && current !== descriptionStart) {
nodesToProcess.push(current);
current = current.nextSibling;
}
if (!nodesToProcess.length) {
return;
}
var signatureText = '';
for (var j = 0; j < nodesToProcess.length; j++) {
signatureText += nodesToProcess[j].textContent || '';
}
signatureText = signatureText.replace(/\s+/g, ' ').trim();
if (!signatureText) {
return;
}
var tempWrapper = document.createElement('div');
for (var k = 0; k < nodesToProcess.length; k++) {
tempWrapper.appendChild(nodesToProcess[k].cloneNode(true));
}
var meta = collectLinkMetadata(tempWrapper, signatureText);
for (var l = 0; l < nodesToProcess.length; l++) {
if (nodesToProcess[l].parentNode === signatureCell) {
signatureCell.removeChild(nodesToProcess[l]);
}
}
var code = document.createElement('code');
code.className = 'method-index-signature language-php';
code.textContent = signatureText;
signatureCell.insertBefore(code, descriptionStart);
highlightAndRestore(code, meta);
}
}
});
</script>
<link rel="search"
type="application/opensearchdescription+xml"
href="https://phpredis.github.io/opensearch.xml"
title="PhpRedis API (develop)" />
</head>
<body id="search-page" data-name="" data-root-path="" data-search-index-url="doctum-search.json">
<div id="content">
<div id="left-column">
<div id="control-panel">
<div class="search-bar hidden" id="search-progress-bar-container">
<div class="progress">
<div class="progress-bar" role="progressbar" id="search-progress-bar"
aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%"></div>
</div>
</div>
<form id="search-form" action="search.html">
<span class="icon icon-search"></span>
<input name="search"
id="doctum-search-auto-complete"
class="typeahead form-control"
type="search"
placeholder="Search"
spellcheck="false"
autocorrect="off"
autocomplete="off"
autocapitalize="off">
<div class="auto-complete-results" id="auto-complete-results"></div>
</form>
</div>
<div id="api-tree"></div>
</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="index.html">PhpRedis API</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="classes.html">Classes</a></li>
<li><a href="interfaces.html">Interfaces</a></li>
<li><a href="traits.html">Traits</a></li>
<li><a href="doc-index.html">Index</a></li>
<li><a href="search.html">Search</a></li>
</ul>
</div>
</div>
</nav>
<div id="page-content">
<div class="page-header">
<h1>Search</h1>
</div>
<p>This page allows you to search through the API documentation for
specific terms. Enter your search words into the box below and click
"submit". The search will be performed on namespaces, classes, interfaces,
traits, functions, and methods.</p>
<form class="form-inline" role="form" action="search.html">
<div class="form-group">
<label class="sr-only" for="search">Search</label>
<input type="search" class="form-control" name="search" id="search" placeholder="Search" spellcheck="false" autocorrect="off" autocomplete="off" autocapitalize="off">
</div>
<button type="submit" class="btn btn-default">submit</button>
</form>
<h2 id="search-results-header">Search Results</h2>
<div class="search-bar hidden" id="search-page-progress-bar-container">
<div class="progress">
<div class="progress-bar" role="progressbar" id="search-page-progress-bar"
aria-valuenow="0" aria-valuemin="0" aria-valuemax="100" style="width: 0%"></div>
</div>
</div>
<div class="container-fluid" id="search-results-container">
</div>
<script type="text/javascript">
var DoctumSearch = {
/** @var boolean */
pageFullyLoaded: false,
/** @var string|null */
searchTerm: null,
/** @var autoComplete|null */
autoCompleteJS: null,
/** @var HTMLElement|null */
doctumSearchPageAutoCompleteProgressBarContainer: null,
/** @var HTMLElement|null */
doctumSearchPageAutoCompleteProgressBar: null,
searchTypeClasses: {
'Namespace': 'label-default',
'Class': 'label-info',
'Trait': 'label-success',
'Interface': 'label-primary',
'Method': 'label-danger',
'Function': 'label-danger',
'_': 'label-warning'
},
longTypes: {
'N': 'Namespace',
'C': 'Class',
'T': 'Trait',
'I': 'Interface',
'M': 'Method',
'F': 'Function',
'_': 'label-warning'
},
/**
* Cleans the provided term. If no term is provided, then one is
* grabbed from the query string "search" parameter.
*/
cleanSearchTerm: function(term) {
// Grab from the query string
if (typeof term === 'undefined') {
var name = 'search';
var regex = new RegExp("[\\?&]" + name + "=([^&#]*)");
var results = regex.exec(location.search);
if (results === null) {
return null;
}
term = decodeURIComponent(results[1].replace(/\+/g, " "));
}
return term.replace(/<(?:.|\n)*?>/gm, '');
},
/**
* Get a search class for a specific type
*/
getSearchClass: function(type) {
return DoctumSearch.searchTypeClasses[type] || DoctumSearch.searchTypeClasses['_'];
},
/**
* Get the long type name
*/
getLongType: function(type) {
return DoctumSearch.longTypes[type] || DoctumSearch.longTypes['_'];
},
pageFullyLoaded: function (event) {// Will get fired by the main doctum.js script
DoctumSearch.searchTerm = DoctumSearch.cleanSearchTerm();
DoctumSearch.searchTermForEngine = Doctum.cleanSearchQuery(DoctumSearch.searchTerm);
DoctumSearch.doctumSearchPageAutoCompleteProgressBarContainer = document.getElementById('search-page-progress-bar-container');
DoctumSearch.doctumSearchPageAutoCompleteProgressBar = document.getElementById('search-page-progress-bar');
DoctumSearch.pageFullyLoaded = true;
DoctumSearch.launchSearch();
},
showNoResults: function() {
document.getElementById('search-results-container').innerText = 'No\u0020results\u0020were\u0020found';
},
launchSearch: function (event) {
if (
DoctumSearch.searchTermForEngine === null
|| (typeof DoctumSearch.searchTermForEngine === 'string' && DoctumSearch.searchTermForEngine.length === 0)
|| typeof DoctumSearch.searchTermForEngine !== 'string'
) {
document.getElementById('search-results-header').className = 'hidden';
// Stop the process here
return;
}
// Set back backslashes to non escaped backslashes
document.getElementById('search').value = DoctumSearch.searchTermForEngine.replace(/\\\\/g, '\\');
// Check if the lib is loaded
if (typeof autoComplete === 'function') {
DoctumSearch.bootAutoComplete();
}
},
bootAutoComplete: function () {
DoctumSearch.autoCompleteJS = new autoComplete(
{
selector: '#search',
searchEngine: function (query, record) {
return Doctum.searchEngine(query, record);
},
submit: true,
data: {
src: function (q) {
return Doctum.loadAutoCompleteData(q);
},
keys: ['n'],// Data 'Object' key to be searched
cache: false, // Is not compatible with async fetch of data
},
query: (input) => {
return Doctum.cleanSearchQuery(input);
},
trigger: (query) => {
return Doctum.cleanSearchQuery(query).length > 0;
},
resultsList: {
tag: 'ul',
class: 'search-results',
destination: '#search-results-container',
position: 'afterbegin',
maxResults: 500,
noResults: false,
},
resultItem: {
tag: 'li',
class: 'search-results-result',
highlight: 'search-results-highlight',
selected: 'search-results-selected',
element: function (item, data) {
item.innerHTML = '';// Clean up the content
var elementH2 = document.createElement('h2');
elementH2.className = 'clearfix';
var elementLink = document.createElement('a');
elementLink.innerText = data.value.n;
elementLink.href = data.value.p;
elementH2.appendChild(elementLink);
var longType = DoctumSearch.getLongType(data.value.t);
var className = DoctumSearch.getSearchClass(longType);
var divElement = document.createElement('div');
divElement.className = 'search-type type-' + longType;
var divSpanElement = document.createElement('span');
divSpanElement.className = 'pull-right label ' + className;
divSpanElement.innerText = longType;
divElement.appendChild(divSpanElement);
elementH2.appendChild(divElement);
item.appendChild(elementH2);
if (typeof data.value.f === 'object') {
var fromElement = document.createElement('div');
fromElement.className = 'search-from';
fromElement.innerText = 'from\u0020';
var fromElementLink = document.createElement('a');
fromElementLink.href = data.value.f.p;
fromElementLink.innerText = data.value.f.n;
fromElement.appendChild(fromElementLink);
item.appendChild(fromElement);
}
var divSearchDescription = document.createElement('div');
divSearchDescription.className = 'search-description';
if (data.value.t === 'N') {// Is a namespace
data.value.d = 'Namespace\u0020\u0025s'.replace('%s', data.value.n);
}
if (typeof data.value.d === 'string') {
var paragraphElement = document.createElement('p');
paragraphElement.innerHTML = data.value.d;
divSearchDescription.appendChild(paragraphElement);
}
item.appendChild(divSearchDescription);
},
},
}
);
Doctum.markInProgress();
DoctumSearch.autoCompleteJS.start(DoctumSearch.searchTerm);
DoctumSearch.autoCompleteJS.unInit();// Stop the work, wait for the user to hit submit
document.getElementById('search').addEventListener('results', function (event) {
Doctum.markProgressFinished();
if (event.detail.results.length === 0) {
DoctumSearch.showNoResults();
}
});
}
};
</script>
</div><div id="footer">
Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>.</div></div>
</div>
</body>
</html>