mirror of
https://github.com/php-win-ext/phpredis.git
synced 2026-03-24 00:52:16 +01:00
Add initial docs (#2249)
Initial support for `doctum` generated documentation.
This commit is contained in:
Till Krüss
5
.gitattributes
vendored
Normal file
5
.gitattributes
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
/.github export-ignore
|
||||
/docs export-ignore
|
||||
.gitattributes export-ignore
|
||||
.gitignore export-ignore
|
||||
.gitmodules export-ignore
|
||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -1,6 +1,7 @@
|
||||
/.github
|
||||
/.idea
|
||||
/.vscode
|
||||
/docs/.cache
|
||||
.cquery
|
||||
*.deps
|
||||
*.libs
|
||||
@@ -19,4 +20,5 @@ autom4te.cache
|
||||
mkinstalldirs
|
||||
tags
|
||||
compile_commands.json
|
||||
run-tests.php
|
||||
doctum.phar
|
||||
run-tests.php
|
||||
1
docs/DOCTUM_VERSION
Normal file
1
docs/DOCTUM_VERSION
Normal file
@@ -0,0 +1 @@
|
||||
5.5.1
|
||||
1
docs/PROJECT_VERSION
Normal file
1
docs/PROJECT_VERSION
Normal file
@@ -0,0 +1 @@
|
||||
develop
|
||||
19133
docs/Redis.html
Normal file
19133
docs/Redis.html
Normal file
File diff suppressed because it is too large
Load Diff
1739
docs/RedisArray.html
Normal file
1739
docs/RedisArray.html
Normal file
File diff suppressed because it is too large
Load Diff
14846
docs/RedisCluster.html
Normal file
14846
docs/RedisCluster.html
Normal file
File diff suppressed because it is too large
Load Diff
103
docs/RedisClusterException.html
Normal file
103
docs/RedisClusterException.html
Normal file
@@ -0,0 +1,103 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="robots" content="index, follow, all" />
|
||||
<title>RedisClusterException | 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="search"
|
||||
type="application/opensearchdescription+xml"
|
||||
href="https://phpredis.github.io/opensearch.xml"
|
||||
title="PhpRedis API (develop)" />
|
||||
</head>
|
||||
|
||||
<body id="class" data-name="class:RedisClusterException" 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>RedisClusterException
|
||||
</h1>
|
||||
</div>
|
||||
|
||||
|
||||
<p> class
|
||||
<strong>RedisClusterException</strong> extends <a target="_blank" rel="noopener" href="https://www.php.net/RuntimeException">RuntimeException</a> (<a href="https://github.com/phpredis/phpredis/blob/develop/redis_cluster.stub.php">View source</a>)
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
103
docs/RedisException.html
Normal file
103
docs/RedisException.html
Normal file
@@ -0,0 +1,103 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="robots" content="index, follow, all" />
|
||||
<title>RedisException | 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="search"
|
||||
type="application/opensearchdescription+xml"
|
||||
href="https://phpredis.github.io/opensearch.xml"
|
||||
title="PhpRedis API (develop)" />
|
||||
</head>
|
||||
|
||||
<body id="class" data-name="class:RedisException" 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>RedisException
|
||||
</h1>
|
||||
</div>
|
||||
|
||||
|
||||
<p> class
|
||||
<strong>RedisException</strong> extends <a target="_blank" rel="noopener" href="https://www.php.net/RuntimeException">RuntimeException</a> (<a href="https://github.com/phpredis/phpredis/blob/develop/redis.stub.php">View source</a>)
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
748
docs/RedisSentinel.html
Normal file
748
docs/RedisSentinel.html
Normal file
@@ -0,0 +1,748 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="robots" content="index, follow, all" />
|
||||
<title>RedisSentinel | 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="search"
|
||||
type="application/opensearchdescription+xml"
|
||||
href="https://phpredis.github.io/opensearch.xml"
|
||||
title="PhpRedis API (develop)" />
|
||||
</head>
|
||||
|
||||
<body id="class" data-name="class:RedisSentinel" 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>RedisSentinel
|
||||
</h1>
|
||||
</div>
|
||||
|
||||
|
||||
<p> class
|
||||
<strong>RedisSentinel</strong> (<a href="https://github.com/phpredis/phpredis/blob/develop/redis_sentinel.stub.php">View source</a>)
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>Methods</h2>
|
||||
|
||||
<div class="container-fluid underlined">
|
||||
<div class="row">
|
||||
<div class="col-md-2 type">
|
||||
|
||||
</div>
|
||||
<div class="col-md-8">
|
||||
<a href="#method___construct">__construct</a>(string $host, int $port = 26379, float $timeout = 0, mixed $persistent = null, int $retry_interval = 0, float $read_timeout = 0, mixed $auth = null, array $context = null)
|
||||
|
||||
<p class="no-description">No description</p>
|
||||
</div>
|
||||
<div class="col-md-2"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-2 type">
|
||||
bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
</div>
|
||||
<div class="col-md-8">
|
||||
<a href="#method_ckquorum">ckquorum</a>(string $master)
|
||||
|
||||
<p class="no-description">No description</p>
|
||||
</div>
|
||||
<div class="col-md-2"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-2 type">
|
||||
bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
</div>
|
||||
<div class="col-md-8">
|
||||
<a href="#method_failover">failover</a>(string $master)
|
||||
|
||||
<p class="no-description">No description</p>
|
||||
</div>
|
||||
<div class="col-md-2"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-2 type">
|
||||
bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
</div>
|
||||
<div class="col-md-8">
|
||||
<a href="#method_flushconfig">flushconfig</a>()
|
||||
|
||||
<p class="no-description">No description</p>
|
||||
</div>
|
||||
<div class="col-md-2"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-2 type">
|
||||
array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
</div>
|
||||
<div class="col-md-8">
|
||||
<a href="#method_getMasterAddrByName">getMasterAddrByName</a>(string $master)
|
||||
|
||||
<p class="no-description">No description</p>
|
||||
</div>
|
||||
<div class="col-md-2"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-2 type">
|
||||
array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
</div>
|
||||
<div class="col-md-8">
|
||||
<a href="#method_master">master</a>(string $master)
|
||||
|
||||
<p class="no-description">No description</p>
|
||||
</div>
|
||||
<div class="col-md-2"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-2 type">
|
||||
array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
</div>
|
||||
<div class="col-md-8">
|
||||
<a href="#method_masters">masters</a>()
|
||||
|
||||
<p class="no-description">No description</p>
|
||||
</div>
|
||||
<div class="col-md-2"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-2 type">
|
||||
string
|
||||
</div>
|
||||
<div class="col-md-8">
|
||||
<a href="#method_myid">myid</a>()
|
||||
|
||||
<p class="no-description">No description</p>
|
||||
</div>
|
||||
<div class="col-md-2"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-2 type">
|
||||
bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
</div>
|
||||
<div class="col-md-8">
|
||||
<a href="#method_ping">ping</a>()
|
||||
|
||||
<p class="no-description">No description</p>
|
||||
</div>
|
||||
<div class="col-md-2"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-2 type">
|
||||
bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
</div>
|
||||
<div class="col-md-8">
|
||||
<a href="#method_reset">reset</a>(string $pattern)
|
||||
|
||||
<p class="no-description">No description</p>
|
||||
</div>
|
||||
<div class="col-md-2"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-2 type">
|
||||
array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
</div>
|
||||
<div class="col-md-8">
|
||||
<a href="#method_sentinels">sentinels</a>(string $master)
|
||||
|
||||
<p class="no-description">No description</p>
|
||||
</div>
|
||||
<div class="col-md-2"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-2 type">
|
||||
array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
</div>
|
||||
<div class="col-md-8">
|
||||
<a href="#method_slaves">slaves</a>(string $master)
|
||||
|
||||
<p class="no-description">No description</p>
|
||||
</div>
|
||||
<div class="col-md-2"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<h2>Details</h2>
|
||||
|
||||
<div id="method-details">
|
||||
<div class="method-item">
|
||||
<h3 id="method___construct">
|
||||
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/develop/redis_sentinel.stub.php#L11">at line 11</a></div>
|
||||
<code>
|
||||
<strong>__construct</strong>(string $host, int $port = 26379, float $timeout = 0, mixed $persistent = null, int $retry_interval = 0, float $read_timeout = 0, mixed $auth = null, array $context = null)
|
||||
</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
<p class="no-description">No description</p>
|
||||
|
||||
</div>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$host</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>int</td>
|
||||
<td>$port</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>float</td>
|
||||
<td>$timeout</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>mixed</td>
|
||||
<td>$persistent</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>int</td>
|
||||
<td>$retry_interval</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>float</td>
|
||||
<td>$read_timeout</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>mixed</td>
|
||||
<td>$auth</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>array</td>
|
||||
<td>$context</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="method-item">
|
||||
<h3 id="method_ckquorum">
|
||||
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/develop/redis_sentinel.stub.php#L14">at line 14</a></div>
|
||||
<code> bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
<strong>ckquorum</strong>(string $master)
|
||||
</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
<p class="no-description">No description</p>
|
||||
|
||||
</div>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$master</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="method-item">
|
||||
<h3 id="method_failover">
|
||||
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/develop/redis_sentinel.stub.php#L17">at line 17</a></div>
|
||||
<code> bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
<strong>failover</strong>(string $master)
|
||||
</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
<p class="no-description">No description</p>
|
||||
|
||||
</div>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$master</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="method-item">
|
||||
<h3 id="method_flushconfig">
|
||||
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/develop/redis_sentinel.stub.php#L20">at line 20</a></div>
|
||||
<code> bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
<strong>flushconfig</strong>()
|
||||
</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
<p class="no-description">No description</p>
|
||||
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="method-item">
|
||||
<h3 id="method_getMasterAddrByName">
|
||||
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/develop/redis_sentinel.stub.php#L23">at line 23</a></div>
|
||||
<code> array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
<strong>getMasterAddrByName</strong>(string $master)
|
||||
</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
<p class="no-description">No description</p>
|
||||
|
||||
</div>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$master</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>array|bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="method-item">
|
||||
<h3 id="method_master">
|
||||
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/develop/redis_sentinel.stub.php#L26">at line 26</a></div>
|
||||
<code> array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
<strong>master</strong>(string $master)
|
||||
</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
<p class="no-description">No description</p>
|
||||
|
||||
</div>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$master</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>array|bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="method-item">
|
||||
<h3 id="method_masters">
|
||||
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/develop/redis_sentinel.stub.php#L29">at line 29</a></div>
|
||||
<code> array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
<strong>masters</strong>()
|
||||
</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
<p class="no-description">No description</p>
|
||||
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>array|bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="method-item">
|
||||
<h3 id="method_myid">
|
||||
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/develop/redis_sentinel.stub.php#L31">at line 31</a></div>
|
||||
<code> string
|
||||
<strong>myid</strong>()
|
||||
</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
<p class="no-description">No description</p>
|
||||
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="method-item">
|
||||
<h3 id="method_ping">
|
||||
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/develop/redis_sentinel.stub.php#L34">at line 34</a></div>
|
||||
<code> bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
<strong>ping</strong>()
|
||||
</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
<p class="no-description">No description</p>
|
||||
|
||||
</div>
|
||||
<div class="tags">
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="method-item">
|
||||
<h3 id="method_reset">
|
||||
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/develop/redis_sentinel.stub.php#L37">at line 37</a></div>
|
||||
<code> bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
<strong>reset</strong>(string $pattern)
|
||||
</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
<p class="no-description">No description</p>
|
||||
|
||||
</div>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$pattern</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="method-item">
|
||||
<h3 id="method_sentinels">
|
||||
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/develop/redis_sentinel.stub.php#L40">at line 40</a></div>
|
||||
<code> array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
<strong>sentinels</strong>(string $master)
|
||||
</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
<p class="no-description">No description</p>
|
||||
|
||||
</div>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$master</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>array|bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="method-item">
|
||||
<h3 id="method_slaves">
|
||||
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/develop/redis_sentinel.stub.php#L43">at line 43</a></div>
|
||||
<code> array|bool|<a href="RedisSentinel.html">RedisSentinel</a>
|
||||
<strong>slaves</strong>(string $master)
|
||||
</code>
|
||||
</h3>
|
||||
<div class="details">
|
||||
|
||||
|
||||
|
||||
<div class="method-description">
|
||||
<p class="no-description">No description</p>
|
||||
|
||||
</div>
|
||||
<div class="tags">
|
||||
<h4>Parameters</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>string</td>
|
||||
<td>$master</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<h4>Return Value</h4>
|
||||
|
||||
<table class="table table-condensed">
|
||||
<tr>
|
||||
<td>array|bool|<a href="RedisSentinel.html">RedisSentinel</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</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>
|
||||
134
docs/[Global_Namespace].html
Normal file
134
docs/[Global_Namespace].html
Normal file
@@ -0,0 +1,134 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="robots" content="index, follow, all" />
|
||||
<title>[Global Namespace] | 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="search"
|
||||
type="application/opensearchdescription+xml"
|
||||
href="https://phpredis.github.io/opensearch.xml"
|
||||
title="PhpRedis API (develop)" />
|
||||
</head>
|
||||
|
||||
<body id="namespace" data-name="namespace:[Global_Namespace]" 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 class="namespace-breadcrumbs">
|
||||
<ol class="breadcrumb">
|
||||
<li><span class="label label-default">Namespace</span></li>
|
||||
<li><a href="[Global_Namespace].html"></a></li><li class="backslash">\</li>
|
||||
</ol>
|
||||
</div>
|
||||
<div id="page-content">
|
||||
<div class="page-header">
|
||||
<h1>[Global Namespace]</h1>
|
||||
</div>
|
||||
|
||||
<h2>Namespaces</h2>
|
||||
<div class="namespace-list">
|
||||
<a href="[Global_Namespace].html">[Global Namespace]</a> </div>
|
||||
|
||||
<h2>Classes</h2>
|
||||
<div class="container-fluid underlined">
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="Redis.html"><abbr title="Redis">Redis</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="RedisArray.html"><abbr title="RedisArray">RedisArray</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="RedisCluster.html"><abbr title="RedisCluster">RedisCluster</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="RedisClusterException.html"><abbr title="RedisClusterException">RedisClusterException</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="RedisException.html"><abbr title="RedisException">RedisException</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="RedisSentinel.html"><abbr title="RedisSentinel">RedisSentinel</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
120
docs/classes.html
Normal file
120
docs/classes.html
Normal file
@@ -0,0 +1,120 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="robots" content="index, follow, all" />
|
||||
<title>All Classes | 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="search"
|
||||
type="application/opensearchdescription+xml"
|
||||
href="https://phpredis.github.io/opensearch.xml"
|
||||
title="PhpRedis API (develop)" />
|
||||
</head>
|
||||
|
||||
<body id="classes" 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>Classes</h1>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="container-fluid underlined">
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="Redis.html"><abbr title="Redis">Redis</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="RedisArray.html"><abbr title="RedisArray">RedisArray</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="RedisCluster.html"><abbr title="RedisCluster">RedisCluster</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="RedisClusterException.html"><abbr title="RedisClusterException">RedisClusterException</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="RedisException.html"><abbr title="RedisException">RedisException</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="RedisSentinel.html"><abbr title="RedisSentinel">RedisSentinel</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
</div>
|
||||
</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>
|
||||
7
docs/css/bootstrap-theme.min.css
vendored
Normal file
7
docs/css/bootstrap-theme.min.css
vendored
Normal file
File diff suppressed because one or more lines are too long
7
docs/css/bootstrap.min.css
vendored
Normal file
7
docs/css/bootstrap.min.css
vendored
Normal file
File diff suppressed because one or more lines are too long
508
docs/css/doctum.css
Normal file
508
docs/css/doctum.css
Normal file
@@ -0,0 +1,508 @@
|
||||
html,
|
||||
body,
|
||||
#content {
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
/* Site menu */
|
||||
|
||||
#site-nav.navbar-default {
|
||||
margin: 0;
|
||||
border-radius: 0;
|
||||
border-bottom: 1px solid #ccc;
|
||||
background-color: #edf3fe;
|
||||
background-image: none;
|
||||
}
|
||||
|
||||
#site-nav.navbar-default .navbar-brand,
|
||||
#site-nav.navbar-default .navbar-nav > li > a {
|
||||
color: #000;
|
||||
}
|
||||
|
||||
#site-nav.navbar-default .navbar-nav > li > a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
#navbar-elements {
|
||||
float: right;
|
||||
}
|
||||
|
||||
@media (max-width: 768px) {
|
||||
#navbar-elements {
|
||||
float: none !important;
|
||||
}
|
||||
}
|
||||
|
||||
/* Namespace breadcrumbs */
|
||||
|
||||
.namespace-breadcrumbs .breadcrumb {
|
||||
margin: 0 0 12px;
|
||||
border-radius: 0 0 4px 4px;
|
||||
padding-left: 35px;
|
||||
}
|
||||
|
||||
.namespace-breadcrumbs .breadcrumb > li + li:before {
|
||||
content: "";
|
||||
}
|
||||
.namespace-breadcrumbs .breadcrumb > .backslash {
|
||||
color: #ccc;
|
||||
}
|
||||
|
||||
/* Site columns */
|
||||
|
||||
#right-column {
|
||||
margin-left: 20%;
|
||||
}
|
||||
|
||||
#page-content {
|
||||
padding: 0 30px;
|
||||
}
|
||||
|
||||
#left-column {
|
||||
width: 20%;
|
||||
position: fixed;
|
||||
height: 100%;
|
||||
border-right: 1px solid #ccc;
|
||||
line-height: 18px;
|
||||
font-size: 13px;
|
||||
display: flex;
|
||||
flex-flow: column;
|
||||
}
|
||||
|
||||
@media (max-width: 991px) {
|
||||
#left-column {
|
||||
display: none;
|
||||
}
|
||||
#right-column {
|
||||
width: 100%;
|
||||
margin-left: 0;
|
||||
}
|
||||
}
|
||||
|
||||
/* API Tree */
|
||||
|
||||
#api-tree {
|
||||
background: linear-gradient(to bottom, #fff, #fff 50%, #edf3fe 50%, #edf3fe);
|
||||
background-size: 100% 56px;
|
||||
overflow: auto;
|
||||
height: 100%;
|
||||
background-attachment: local;
|
||||
}
|
||||
|
||||
#api-tree ul {
|
||||
list-style-type: none;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
#api-tree ul li {
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
/* Prevents the menu from jittering on lad */
|
||||
#api-tree .icon-play {
|
||||
width: 26px;
|
||||
}
|
||||
|
||||
#api-tree ul li .hd {
|
||||
padding: 5px;
|
||||
}
|
||||
|
||||
#api-tree li .hd:nth-child(even) {
|
||||
background-color: #edf3fe;
|
||||
}
|
||||
|
||||
#api-tree ul li.opened > .hd span {
|
||||
-webkit-transform: rotate(90deg);
|
||||
-moz-transform: rotate(90deg);
|
||||
-o-transform: rotate(90deg);
|
||||
-ms-transform: rotate(90deg);
|
||||
transform: rotate(90deg);
|
||||
}
|
||||
|
||||
#api-tree .bd {
|
||||
display: none;
|
||||
}
|
||||
|
||||
#api-tree li.opened > .bd {
|
||||
display: block;
|
||||
}
|
||||
|
||||
#api-tree li .hd:hover {
|
||||
background-color: #eee;
|
||||
}
|
||||
|
||||
#api-tree li.active > .hd {
|
||||
background-color: #3875d7;
|
||||
}
|
||||
|
||||
#api-tree li.active > .hd a {
|
||||
color: #eee;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
#api-tree a {
|
||||
color: #222;
|
||||
}
|
||||
|
||||
#api-tree div.leaf a {
|
||||
margin-left: 20px;
|
||||
}
|
||||
|
||||
#api-tree .hd span {
|
||||
padding: 0px 8px;
|
||||
font-size: 15px;
|
||||
line-height: 85%;
|
||||
}
|
||||
|
||||
/* Control panel, search form, version drop-down */
|
||||
|
||||
#control-panel {
|
||||
background: #e8e8e8;
|
||||
border-bottom: 1px solid #666;
|
||||
padding: 4px;
|
||||
}
|
||||
|
||||
#control-panel form, #control-panel > .search-bar {
|
||||
margin: 4px 4px 5px 4px;
|
||||
}
|
||||
|
||||
#control-panel > .search-bar > .progress {
|
||||
height: 5px;
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
#control-panel > .search-bar > .progress > .progress-bar {
|
||||
background: #30a0e0;
|
||||
}
|
||||
|
||||
/* Source: https://stackoverflow.com/a/38229228/5155484 */
|
||||
|
||||
.progress-bar.indeterminate {
|
||||
position: relative;
|
||||
animation: progress-indeterminate 3s linear infinite;
|
||||
}
|
||||
|
||||
@keyframes progress-indeterminate {
|
||||
from { left: -25%; width: 25%; }
|
||||
to { left: 100%; width: 25%;}
|
||||
}
|
||||
|
||||
#search-form {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
#search-form input {
|
||||
width: 100%;
|
||||
padding-left: 28px;
|
||||
}
|
||||
|
||||
#search-form span.icon-search {
|
||||
position: absolute;
|
||||
left: 5px;
|
||||
top: 8px;
|
||||
font-size: 20px;
|
||||
z-index: 2;
|
||||
}
|
||||
|
||||
/** Typeahead */
|
||||
|
||||
.auto-complete-results {
|
||||
width: 100%;
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
.auto-complete-dropdown-menu {
|
||||
overflow: auto;
|
||||
max-height: 260px;
|
||||
margin-top: 9px;
|
||||
background-color: #fff;
|
||||
border: 1px solid #ccc;
|
||||
border-radius: 8px;
|
||||
box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2);
|
||||
padding: 8px;
|
||||
}
|
||||
|
||||
.auto-complete-result {
|
||||
padding: 8px;
|
||||
border-bottom: 1px solid #ccc;
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
.auto-complete-selected, .auto-complete-result:hover {
|
||||
background-color: #3875d7;
|
||||
color: #fff;
|
||||
}
|
||||
|
||||
.auto-complete-selected > mark.auto-complete-highlight, .auto-complete-result:hover > mark.auto-complete-highlight {
|
||||
color: #fff;
|
||||
}
|
||||
|
||||
.auto-complete-highlight {
|
||||
padding: 0px;
|
||||
font-weight: bold;
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
/** General typography **/
|
||||
|
||||
.navbar {
|
||||
border-bottom: 0;
|
||||
}
|
||||
|
||||
.page-header {
|
||||
margin: 0 0 20px;
|
||||
}
|
||||
|
||||
abbr[title],
|
||||
abbr[data-original-title],
|
||||
abbr {
|
||||
border-bottom: none;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
a abbr {
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.method-description table,
|
||||
.description table {
|
||||
border: solid 1px #ccc;
|
||||
padding: 1em;
|
||||
margin: 1em;
|
||||
}
|
||||
|
||||
.method-description td,
|
||||
.method-description th,
|
||||
.description td,
|
||||
.description th {
|
||||
padding: 0.75em 1.25em;
|
||||
}
|
||||
|
||||
.method-description tbody tr:nth-child(even),
|
||||
.description tbody tr:nth-child(even) {
|
||||
background: #edf3fe;
|
||||
}
|
||||
|
||||
.method-description tbody tr:nth-child(odd),
|
||||
.description tbody tr:nth-child(odd) {
|
||||
background: #fff;
|
||||
}
|
||||
|
||||
.method-description thead tr,
|
||||
.description thead tr {
|
||||
background: #edf3fe;
|
||||
}
|
||||
|
||||
/** General Doctum styling **/
|
||||
|
||||
.underlined > .row {
|
||||
padding: 8px 0;
|
||||
border-bottom: 1px solid #ddd;
|
||||
}
|
||||
|
||||
#footer {
|
||||
text-align: right;
|
||||
margin: 30px;
|
||||
font-size: 11px;
|
||||
}
|
||||
|
||||
.description {
|
||||
margin: 10px 0;
|
||||
padding: 10px;
|
||||
background-color: #efefef;
|
||||
}
|
||||
|
||||
.description p {
|
||||
padding: 0;
|
||||
margin: 8px 0;
|
||||
}
|
||||
|
||||
.method-description {
|
||||
margin: 0 0 24px 0;
|
||||
}
|
||||
|
||||
.details {
|
||||
padding-left: 30px;
|
||||
}
|
||||
|
||||
#method-details .method-item {
|
||||
margin-bottom: 30px;
|
||||
}
|
||||
|
||||
.method-item h3,
|
||||
.method-item h3 code {
|
||||
background-color: #eee;
|
||||
}
|
||||
|
||||
.method-item h3 {
|
||||
padding: 4px;
|
||||
margin-bottom: 20px;
|
||||
font-size: 20px;
|
||||
}
|
||||
|
||||
.location {
|
||||
font-size: 11px;
|
||||
float: right;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.namespace-list a {
|
||||
padding: 3px 8px;
|
||||
margin: 0 5px 5px 0;
|
||||
border: 1px solid #ddd;
|
||||
background-color: #f9f9f9;
|
||||
display: inline-block;
|
||||
border-radius: 4px;
|
||||
}
|
||||
|
||||
.no-description {
|
||||
color: #ccc;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
.type {
|
||||
overflow-wrap: break-word;
|
||||
}
|
||||
|
||||
/* Namespaces page */
|
||||
|
||||
.namespaces {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
.namespaces .namespace-container {
|
||||
float: left;
|
||||
margin: 0 14px 14px 0;
|
||||
min-width: 30%;
|
||||
}
|
||||
|
||||
.namespaces h2 {
|
||||
margin: 0 0 20px 0;
|
||||
}
|
||||
|
||||
.namespace-container > h2 {
|
||||
background-color: #edf3fe;
|
||||
padding: 4px 4px 4px 8px;
|
||||
font-size: 25px;
|
||||
margin: 20px 0;
|
||||
}
|
||||
|
||||
@media (max-width: 991px) {
|
||||
.namespaces .namespace-container {
|
||||
margin-right: 0;
|
||||
width: 100%;
|
||||
}
|
||||
}
|
||||
|
||||
/** Code and pre tags **/
|
||||
|
||||
tt,
|
||||
code,
|
||||
pre {
|
||||
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
|
||||
}
|
||||
|
||||
code {
|
||||
padding: 0;
|
||||
padding-top: 0.2em;
|
||||
padding-bottom: 0.2em;
|
||||
margin: 0;
|
||||
font-size: 85%;
|
||||
background-color: rgba(0, 0, 0, 0.04);
|
||||
border-radius: 3px;
|
||||
color: #333;
|
||||
}
|
||||
|
||||
pre {
|
||||
padding: 16px;
|
||||
overflow: auto;
|
||||
font-size: 85%;
|
||||
line-height: 1.45;
|
||||
background-color: #f7f7f7;
|
||||
border-radius: 3px;
|
||||
}
|
||||
|
||||
pre.examples {
|
||||
padding: 1rem;
|
||||
}
|
||||
|
||||
#page-content > h2 {
|
||||
background-color: #edf3fe;
|
||||
padding: 4px 4px 4px 8px;
|
||||
font-size: 25px;
|
||||
margin: 20px 0;
|
||||
}
|
||||
|
||||
|
||||
/** Doc index **/
|
||||
|
||||
dt {
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
dd {
|
||||
margin-left: 30px;
|
||||
line-height: 1.5em;
|
||||
}
|
||||
|
||||
#doc-index h2 {
|
||||
font-weight: bold;
|
||||
margin: 30px 0;
|
||||
}
|
||||
|
||||
#doc-index .pagination {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
/* Search page */
|
||||
|
||||
.search-results {
|
||||
list-style-type: none;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.search-results li {
|
||||
list-style-type: none;
|
||||
margin: 0;
|
||||
padding: 14px 0;
|
||||
border-bottom: 1px solid #ccc;
|
||||
}
|
||||
|
||||
.search-results > li > h2 {
|
||||
background: none;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
font-size: 18px;
|
||||
}
|
||||
|
||||
.search-results > li > h2 > a {
|
||||
float: left;
|
||||
display: block;
|
||||
margin: 0 0 4px 0;
|
||||
}
|
||||
|
||||
.search-results .search-type {
|
||||
float: right;
|
||||
margin: 0 0 4px 0;
|
||||
}
|
||||
|
||||
.search-results .search-from {
|
||||
margin: 0 0 12px 0;
|
||||
font-size: 12px;
|
||||
color: #999;
|
||||
}
|
||||
|
||||
.search-results .search-from a {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.search-results .search-description {
|
||||
margin: 8px 0 0 30px;
|
||||
}
|
||||
|
||||
.search-description {
|
||||
white-space: pre;
|
||||
}
|
||||
1187
docs/doc-index.html
Normal file
1187
docs/doc-index.html
Normal file
File diff suppressed because it is too large
Load Diff
1
docs/doctum-search.json
Normal file
1
docs/doctum-search.json
Normal file
File diff suppressed because one or more lines are too long
316
docs/doctum.js
Normal file
316
docs/doctum.js
Normal file
@@ -0,0 +1,316 @@
|
||||
var Doctum = {
|
||||
treeJson: {"tree":{"l":0,"n":"","p":"","c":[{"l":1,"n":"[Global Namespace]","p":"[Global_Namespace]","c":[{"l":2,"n":"Redis","p":"Redis"},{"l":2,"n":"RedisArray","p":"RedisArray"},{"l":2,"n":"RedisCluster","p":"RedisCluster"},{"l":2,"n":"RedisClusterException","p":"RedisClusterException"},{"l":2,"n":"RedisException","p":"RedisException"},{"l":2,"n":"RedisSentinel","p":"RedisSentinel"}]}]},"treeOpenLevel":2},
|
||||
/** @var boolean */
|
||||
treeLoaded: false,
|
||||
/** @var boolean */
|
||||
listenersRegistered: false,
|
||||
autoCompleteData: null,
|
||||
/** @var boolean */
|
||||
autoCompleteLoading: false,
|
||||
/** @var boolean */
|
||||
autoCompleteLoaded: false,
|
||||
/** @var string|null */
|
||||
rootPath: null,
|
||||
/** @var string|null */
|
||||
autoCompleteDataUrl: null,
|
||||
/** @var HTMLElement|null */
|
||||
doctumSearchAutoComplete: null,
|
||||
/** @var HTMLElement|null */
|
||||
doctumSearchAutoCompleteProgressBarContainer: null,
|
||||
/** @var HTMLElement|null */
|
||||
doctumSearchAutoCompleteProgressBar: null,
|
||||
/** @var number */
|
||||
doctumSearchAutoCompleteProgressBarPercent: 0,
|
||||
/** @var autoComplete|null */
|
||||
autoCompleteJS: null,
|
||||
querySearchSecurityRegex: /([^0-9a-zA-Z:\\\\_\s])/gi,
|
||||
buildTreeNode: function (treeNode, htmlNode, treeOpenLevel) {
|
||||
var ulNode = document.createElement('ul');
|
||||
for (var childKey in treeNode.c) {
|
||||
var child = treeNode.c[childKey];
|
||||
var liClass = document.createElement('li');
|
||||
var hasChildren = child.hasOwnProperty('c');
|
||||
var nodeSpecialName = (hasChildren ? 'namespace:' : 'class:') + child.p.replace(/\//g, '_');
|
||||
liClass.setAttribute('data-name', nodeSpecialName);
|
||||
|
||||
// Create the node that will have the text
|
||||
var divHd = document.createElement('div');
|
||||
var levelCss = child.l - 1;
|
||||
divHd.className = hasChildren ? 'hd' : 'hd leaf';
|
||||
divHd.style.paddingLeft = (hasChildren ? (levelCss * 18) : (8 + (levelCss * 18))) + 'px';
|
||||
if (hasChildren) {
|
||||
if (child.l <= treeOpenLevel) {
|
||||
liClass.className = 'opened';
|
||||
}
|
||||
var spanIcon = document.createElement('span');
|
||||
spanIcon.className = 'icon icon-play';
|
||||
divHd.appendChild(spanIcon);
|
||||
}
|
||||
var aLink = document.createElement('a');
|
||||
|
||||
// Edit the HTML link to work correctly based on the current depth
|
||||
aLink.href = Doctum.rootPath + child.p + '.html';
|
||||
aLink.innerText = child.n;
|
||||
divHd.appendChild(aLink);
|
||||
liClass.appendChild(divHd);
|
||||
|
||||
// It has children
|
||||
if (hasChildren) {
|
||||
var divBd = document.createElement('div');
|
||||
divBd.className = 'bd';
|
||||
Doctum.buildTreeNode(child, divBd, treeOpenLevel);
|
||||
liClass.appendChild(divBd);
|
||||
}
|
||||
ulNode.appendChild(liClass);
|
||||
}
|
||||
htmlNode.appendChild(ulNode);
|
||||
},
|
||||
initListeners: function () {
|
||||
if (Doctum.listenersRegistered) {
|
||||
// Quick exit, already registered
|
||||
return;
|
||||
}
|
||||
Doctum.listenersRegistered = true;
|
||||
},
|
||||
loadTree: function () {
|
||||
if (Doctum.treeLoaded) {
|
||||
// Quick exit, already registered
|
||||
return;
|
||||
}
|
||||
Doctum.rootPath = document.body.getAttribute('data-root-path');
|
||||
Doctum.buildTreeNode(Doctum.treeJson.tree, document.getElementById('api-tree'), Doctum.treeJson.treeOpenLevel);
|
||||
|
||||
// Toggle left-nav divs on click
|
||||
$('#api-tree .hd span').on('click', function () {
|
||||
$(this).parent().parent().toggleClass('opened');
|
||||
});
|
||||
|
||||
// Expand the parent namespaces of the current page.
|
||||
var expected = $('body').attr('data-name');
|
||||
|
||||
if (expected) {
|
||||
// Open the currently selected node and its parents.
|
||||
var container = $('#api-tree');
|
||||
var node = $('#api-tree li[data-name="' + expected + '"]');
|
||||
// Node might not be found when simulating namespaces
|
||||
if (node.length > 0) {
|
||||
node.addClass('active').addClass('opened');
|
||||
node.parents('li').addClass('opened');
|
||||
var scrollPos = node.offset().top - container.offset().top + container.scrollTop();
|
||||
// Position the item nearer to the top of the screen.
|
||||
scrollPos -= 200;
|
||||
container.scrollTop(scrollPos);
|
||||
}
|
||||
}
|
||||
Doctum.treeLoaded = true;
|
||||
},
|
||||
pagePartiallyLoaded: function (event) {
|
||||
Doctum.initListeners();
|
||||
Doctum.loadTree();
|
||||
Doctum.loadAutoComplete();
|
||||
},
|
||||
pageFullyLoaded: function (event) {
|
||||
// it may not have received DOMContentLoaded event
|
||||
Doctum.initListeners();
|
||||
Doctum.loadTree();
|
||||
Doctum.loadAutoComplete();
|
||||
// Fire the event in the search page too
|
||||
if (typeof DoctumSearch === 'object') {
|
||||
DoctumSearch.pageFullyLoaded();
|
||||
}
|
||||
},
|
||||
loadAutoComplete: function () {
|
||||
if (Doctum.autoCompleteLoaded) {
|
||||
// Quick exit, already loaded
|
||||
return;
|
||||
}
|
||||
Doctum.autoCompleteDataUrl = document.body.getAttribute('data-search-index-url');
|
||||
Doctum.doctumSearchAutoComplete = document.getElementById('doctum-search-auto-complete');
|
||||
Doctum.doctumSearchAutoCompleteProgressBarContainer = document.getElementById('search-progress-bar-container');
|
||||
Doctum.doctumSearchAutoCompleteProgressBar = document.getElementById('search-progress-bar');
|
||||
if (Doctum.doctumSearchAutoComplete !== null) {
|
||||
// Wait for it to be loaded
|
||||
Doctum.doctumSearchAutoComplete.addEventListener('init', function (_) {
|
||||
Doctum.autoCompleteLoaded = true;
|
||||
Doctum.doctumSearchAutoComplete.addEventListener('selection', function (event) {
|
||||
// Go to selection page
|
||||
window.location = Doctum.rootPath + event.detail.selection.value.p;
|
||||
});
|
||||
Doctum.doctumSearchAutoComplete.addEventListener('navigate', function (event) {
|
||||
// Set selection in text box
|
||||
if (typeof event.detail.selection.value === 'object') {
|
||||
Doctum.doctumSearchAutoComplete.value = event.detail.selection.value.n;
|
||||
}
|
||||
});
|
||||
Doctum.doctumSearchAutoComplete.addEventListener('results', function (event) {
|
||||
Doctum.markProgressFinished();
|
||||
});
|
||||
});
|
||||
}
|
||||
// Check if the lib is loaded
|
||||
if (typeof autoComplete === 'function') {
|
||||
Doctum.bootAutoComplete();
|
||||
}
|
||||
},
|
||||
markInProgress: function () {
|
||||
Doctum.doctumSearchAutoCompleteProgressBarContainer.className = 'search-bar';
|
||||
Doctum.doctumSearchAutoCompleteProgressBar.className = 'progress-bar indeterminate';
|
||||
if (typeof DoctumSearch === 'object' && DoctumSearch.pageFullyLoaded) {
|
||||
DoctumSearch.doctumSearchPageAutoCompleteProgressBarContainer.className = 'search-bar';
|
||||
DoctumSearch.doctumSearchPageAutoCompleteProgressBar.className = 'progress-bar indeterminate';
|
||||
}
|
||||
},
|
||||
markProgressFinished: function () {
|
||||
Doctum.doctumSearchAutoCompleteProgressBarContainer.className = 'search-bar hidden';
|
||||
Doctum.doctumSearchAutoCompleteProgressBar.className = 'progress-bar';
|
||||
if (typeof DoctumSearch === 'object' && DoctumSearch.pageFullyLoaded) {
|
||||
DoctumSearch.doctumSearchPageAutoCompleteProgressBarContainer.className = 'search-bar hidden';
|
||||
DoctumSearch.doctumSearchPageAutoCompleteProgressBar.className = 'progress-bar';
|
||||
}
|
||||
},
|
||||
makeProgess: function () {
|
||||
Doctum.makeProgressOnProgressBar(
|
||||
Doctum.doctumSearchAutoCompleteProgressBarPercent,
|
||||
Doctum.doctumSearchAutoCompleteProgressBar
|
||||
);
|
||||
if (typeof DoctumSearch === 'object' && DoctumSearch.pageFullyLoaded) {
|
||||
Doctum.makeProgressOnProgressBar(
|
||||
Doctum.doctumSearchAutoCompleteProgressBarPercent,
|
||||
DoctumSearch.doctumSearchPageAutoCompleteProgressBar
|
||||
);
|
||||
}
|
||||
},
|
||||
loadAutoCompleteData: function (query) {
|
||||
return new Promise(function (resolve, reject) {
|
||||
if (Doctum.autoCompleteData !== null) {
|
||||
resolve(Doctum.autoCompleteData);
|
||||
return;
|
||||
}
|
||||
Doctum.markInProgress();
|
||||
function reqListener() {
|
||||
Doctum.autoCompleteLoading = false;
|
||||
Doctum.autoCompleteData = JSON.parse(this.responseText).items;
|
||||
Doctum.markProgressFinished();
|
||||
|
||||
setTimeout(function () {
|
||||
resolve(Doctum.autoCompleteData);
|
||||
}, 50);// Let the UI render once before sending the results for processing. This gives time to the progress bar to hide
|
||||
}
|
||||
function reqError(err) {
|
||||
Doctum.autoCompleteLoading = false;
|
||||
Doctum.autoCompleteData = null;
|
||||
console.error(err);
|
||||
reject(err);
|
||||
}
|
||||
|
||||
var oReq = new XMLHttpRequest();
|
||||
oReq.onload = reqListener;
|
||||
oReq.onerror = reqError;
|
||||
oReq.onprogress = function (pe) {
|
||||
if (pe.lengthComputable) {
|
||||
Doctum.doctumSearchAutoCompleteProgressBarPercent = parseInt(pe.loaded / pe.total * 100, 10);
|
||||
Doctum.makeProgess();
|
||||
}
|
||||
};
|
||||
oReq.onloadend = function (_) {
|
||||
Doctum.markProgressFinished();
|
||||
};
|
||||
oReq.open('get', Doctum.autoCompleteDataUrl, true);
|
||||
oReq.send();
|
||||
});
|
||||
},
|
||||
/**
|
||||
* Make some progress on a progress bar
|
||||
*
|
||||
* @param number percentage
|
||||
* @param HTMLElement progressBar
|
||||
* @return void
|
||||
*/
|
||||
makeProgressOnProgressBar: function(percentage, progressBar) {
|
||||
progressBar.className = 'progress-bar';
|
||||
progressBar.style.width = percentage + '%';
|
||||
progressBar.setAttribute(
|
||||
'aria-valuenow', percentage
|
||||
);
|
||||
},
|
||||
searchEngine: function (query, record) {
|
||||
if (typeof query !== 'string') {
|
||||
return '';
|
||||
}
|
||||
// replace all (mode = g) spaces and non breaking spaces (\s) by pipes
|
||||
// g = global mode to mark also the second word searched
|
||||
// i = case insensitive
|
||||
// how this function works:
|
||||
// First: search if the query has the keywords in sequence
|
||||
// Second: replace the keywords by a mark and leave all the text in between non marked
|
||||
|
||||
if (record.match(new RegExp('(' + query.replace(/\s/g, ').*(') + ')', 'gi')) === null) {
|
||||
return '';// Does not match
|
||||
}
|
||||
|
||||
var replacedRecord = record.replace(new RegExp('(' + query.replace(/\s/g, '|') + ')', 'gi'), function (group) {
|
||||
return '<mark class="auto-complete-highlight">' + group + '</mark>';
|
||||
});
|
||||
|
||||
if (replacedRecord !== record) {
|
||||
return replacedRecord;// This should not happen but just in case there was no match done
|
||||
}
|
||||
|
||||
return '';
|
||||
},
|
||||
/**
|
||||
* Clean the search query
|
||||
*
|
||||
* @param string query
|
||||
* @return string
|
||||
*/
|
||||
cleanSearchQuery: function (query) {
|
||||
// replace any chars that could lead to injecting code in our regex
|
||||
// remove start or end spaces
|
||||
// replace backslashes by an escaped version, use case in search: \myRootFunction
|
||||
return query.replace(Doctum.querySearchSecurityRegex, '').trim().replace(/\\/g, '\\\\');
|
||||
},
|
||||
bootAutoComplete: function () {
|
||||
Doctum.autoCompleteJS = new autoComplete(
|
||||
{
|
||||
selector: '#doctum-search-auto-complete',
|
||||
searchEngine: function (query, record) {
|
||||
return Doctum.searchEngine(query, record);
|
||||
},
|
||||
submit: true,
|
||||
data: {
|
||||
src: function (q) {
|
||||
Doctum.markInProgress();
|
||||
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: 'auto-complete-dropdown-menu',
|
||||
destination: '#auto-complete-results',
|
||||
position: 'afterbegin',
|
||||
maxResults: 500,
|
||||
noResults: false,
|
||||
},
|
||||
resultItem: {
|
||||
tag: 'li',
|
||||
class: 'auto-complete-result',
|
||||
highlight: 'auto-complete-highlight',
|
||||
selected: 'auto-complete-selected'
|
||||
},
|
||||
}
|
||||
);
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
document.addEventListener('DOMContentLoaded', Doctum.pagePartiallyLoaded, false);
|
||||
window.addEventListener('load', Doctum.pageFullyLoaded, false);
|
||||
61
docs/fonts/doctum-font.css
Normal file
61
docs/fonts/doctum-font.css
Normal file
@@ -0,0 +1,61 @@
|
||||
@font-face {
|
||||
font-family: "doctum";
|
||||
src: url("./doctum.eot?39101248");
|
||||
src: url("./doctum.eot?39101248#iefix") format("embedded-opentype"),
|
||||
url("./doctum.woff2?39101248") format("woff2"), url("./doctum.woff?39101248") format("woff"),
|
||||
url("./doctum.ttf?39101248") format("truetype"), url("./doctum.svg?39101248#doctum") format("svg");
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
/* Chrome hack: SVG is rendered more smooth in Windozze. 100% magic, uncomment if you need it. */
|
||||
/* Note, that will break hinting! In other OS-es font will be not as sharp as it could be */
|
||||
/*
|
||||
@media screen and (-webkit-min-device-pixel-ratio:0) {
|
||||
@font-face {
|
||||
font-family: 'doctum';
|
||||
src: url('./doctum.svg?39101248#doctum') format('svg');
|
||||
}
|
||||
}
|
||||
*/
|
||||
|
||||
.icon {
|
||||
font-family: "doctum";
|
||||
font-style: normal;
|
||||
font-weight: normal;
|
||||
speak: never;
|
||||
|
||||
display: inline-block;
|
||||
text-decoration: inherit;
|
||||
width: 1em;
|
||||
margin-right: 0.2em;
|
||||
text-align: center;
|
||||
/* opacity: .8; */
|
||||
|
||||
/* For safety - reset parent styles, that can break glyph codes*/
|
||||
font-variant: normal;
|
||||
text-transform: none;
|
||||
|
||||
/* fix buttons height, for twitter bootstrap */
|
||||
line-height: 1em;
|
||||
|
||||
/* Animation center compensation - margins should be symmetric */
|
||||
/* remove if not needed */
|
||||
margin-left: 0.2em;
|
||||
|
||||
/* you can be more comfortable with increased icons size */
|
||||
/* font-size: 120%; */
|
||||
|
||||
/* Font smoothing. That was taken from TWBS */
|
||||
-webkit-font-smoothing: antialiased;
|
||||
-moz-osx-font-smoothing: grayscale;
|
||||
|
||||
/* Uncomment for 3D effect */
|
||||
/* text-shadow: 1px 1px 1px rgba(127, 127, 127, 0.3); */
|
||||
}
|
||||
|
||||
.icon-search:before {
|
||||
content: "\e800";
|
||||
} /* '' */
|
||||
.icon-play:before {
|
||||
content: "\e801";
|
||||
} /* '' */
|
||||
BIN
docs/fonts/doctum.eot
Normal file
BIN
docs/fonts/doctum.eot
Normal file
Binary file not shown.
14
docs/fonts/doctum.svg
Normal file
14
docs/fonts/doctum.svg
Normal file
@@ -0,0 +1,14 @@
|
||||
<?xml version="1.0" standalone="no"?>
|
||||
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
|
||||
<svg xmlns="http://www.w3.org/2000/svg">
|
||||
<metadata>Material Design Icons</metadata>
|
||||
<defs>
|
||||
<font id="doctum" horiz-adv-x="1000" >
|
||||
<font-face font-family="doctum" font-weight="400" font-stretch="normal" units-per-em="1000" ascent="850" descent="-150" />
|
||||
<missing-glyph horiz-adv-x="1000" />
|
||||
<glyph glyph-name="search" unicode="" d="M396 725c149 0 271-121 271-271 0-67-25-129-65-176l11-11h33l208-209-62-62-209 208v33l-11 11c-47-40-109-65-176-65-150 0-271 122-271 271 0 150 121 271 271 271m0-83c-104 0-188-84-188-188 0-104 84-187 188-187 104 0 187 83 187 187 0 104-83 188-187 188z" horiz-adv-x="1000" />
|
||||
|
||||
<glyph glyph-name="play" unicode="" d="M333 636v-583l459 291-459 292z" horiz-adv-x="1000" />
|
||||
</font>
|
||||
</defs>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 870 B |
BIN
docs/fonts/doctum.ttf
Normal file
BIN
docs/fonts/doctum.ttf
Normal file
Binary file not shown.
BIN
docs/fonts/doctum.woff
Normal file
BIN
docs/fonts/doctum.woff
Normal file
Binary file not shown.
BIN
docs/fonts/doctum.woff2
Normal file
BIN
docs/fonts/doctum.woff2
Normal file
Binary file not shown.
120
docs/index.html
Normal file
120
docs/index.html
Normal file
@@ -0,0 +1,120 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="robots" content="index, follow, all" />
|
||||
<title>All Classes | 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="search"
|
||||
type="application/opensearchdescription+xml"
|
||||
href="https://phpredis.github.io/opensearch.xml"
|
||||
title="PhpRedis API (develop)" />
|
||||
</head>
|
||||
|
||||
<body id="index" 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>Classes</h1>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="container-fluid underlined">
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="Redis.html"><abbr title="Redis">Redis</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="RedisArray.html"><abbr title="RedisArray">RedisArray</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="RedisCluster.html"><abbr title="RedisCluster">RedisCluster</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="RedisClusterException.html"><abbr title="RedisClusterException">RedisClusterException</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="RedisException.html"><abbr title="RedisException">RedisException</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
<div class="col-md-6">
|
||||
<a href="RedisSentinel.html"><abbr title="RedisSentinel">RedisSentinel</abbr></a> </div>
|
||||
<div class="col-md-6"></div>
|
||||
</div>
|
||||
</div>
|
||||
</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>
|
||||
90
docs/interfaces.html
Normal file
90
docs/interfaces.html
Normal file
@@ -0,0 +1,90 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="robots" content="index, follow, all" />
|
||||
<title>Interfaces | 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="search"
|
||||
type="application/opensearchdescription+xml"
|
||||
href="https://phpredis.github.io/opensearch.xml"
|
||||
title="PhpRedis API (develop)" />
|
||||
</head>
|
||||
|
||||
<body id="interfaces" 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>Interfaces</h1>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="container-fluid underlined">
|
||||
</div>
|
||||
</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>
|
||||
5
docs/js/autocomplete.min.js
vendored
Normal file
5
docs/js/autocomplete.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
11
docs/js/bootstrap.min.js
vendored
Normal file
11
docs/js/bootstrap.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
2
docs/js/jquery-3.5.1.slim.min.js
vendored
Normal file
2
docs/js/jquery-3.5.1.slim.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
93
docs/namespaces.html
Normal file
93
docs/namespaces.html
Normal file
@@ -0,0 +1,93 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="robots" content="index, follow, all" />
|
||||
<title>Namespaces | 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="search"
|
||||
type="application/opensearchdescription+xml"
|
||||
href="https://phpredis.github.io/opensearch.xml"
|
||||
title="PhpRedis API (develop)" />
|
||||
</head>
|
||||
|
||||
<body id="namespaces" 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>Namespaces</h1>
|
||||
</div>
|
||||
|
||||
<div class="namespaces clearfix">
|
||||
<li><a href="[Global_Namespace].html">[Global Namespace]</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</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>
|
||||
9
docs/opensearch.xml
Normal file
9
docs/opensearch.xml
Normal file
@@ -0,0 +1,9 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:referrer="http://a9.com/-/opensearch/extensions/referrer/">
|
||||
<ShortName>PhpRedis API (develop)</ShortName>
|
||||
<Description>Searches PhpRedis API (develop)</Description>
|
||||
<Tags>PhpRedis API</Tags>
|
||||
<Url type="text/html" method="GET" template="https://phpredis.github.io/search.html?search={searchTerms}&utm_source={referrer:source?}"/>
|
||||
<InputEncoding>UTF-8</InputEncoding>
|
||||
<AdultContent>false</AdultContent>
|
||||
</OpenSearchDescription>
|
||||
1
docs/renderer.index
Normal file
1
docs/renderer.index
Normal file
@@ -0,0 +1 @@
|
||||
O:21:"Doctum\Renderer\Index":3:{i:0;a:6:{s:5:"Redis";s:40:"65ebe68ff54586b8953ba135c8c8d5c1208cf563";s:10:"RedisArray";s:40:"fb17c785beccf1dbeedaa48afb4aa7d48fd8b655";s:12:"RedisCluster";s:40:"1783d14c476f95598062edb44dab7284b9b2680d";s:21:"RedisClusterException";s:40:"1783d14c476f95598062edb44dab7284b9b2680d";s:14:"RedisException";s:40:"65ebe68ff54586b8953ba135c8c8d5c1208cf563";s:13:"RedisSentinel";s:40:"4055ace9f1cf20bef89bdb5d3219470b4c8915e6";}i:1;a:1:{i:0;s:7:"develop";}i:2;a:1:{i:0;s:0:"";}}
|
||||
297
docs/search.html
Normal file
297
docs/search.html
Normal file
@@ -0,0 +1,297 @@
|
||||
<!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="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>
|
||||
89
docs/traits.html
Normal file
89
docs/traits.html
Normal file
@@ -0,0 +1,89 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<meta name="robots" content="index, follow, all" />
|
||||
<title>Traits | 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="search"
|
||||
type="application/opensearchdescription+xml"
|
||||
href="https://phpredis.github.io/opensearch.xml"
|
||||
title="PhpRedis API (develop)" />
|
||||
</head>
|
||||
|
||||
<body id="traits" 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>Traits</h1>
|
||||
</div>
|
||||
|
||||
<div class="container-fluid underlined">
|
||||
</div>
|
||||
</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>
|
||||
28
doctum-config.php
Normal file
28
doctum-config.php
Normal file
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
|
||||
use Doctum\Doctum;
|
||||
use Doctum\Version\GitVersionCollection;
|
||||
use Doctum\RemoteRepository\GitHubRemoteRepository;
|
||||
|
||||
use Symfony\Component\Finder\Finder;
|
||||
|
||||
$root = realpath(__DIR__);
|
||||
|
||||
$iterator = Finder::create()
|
||||
->files()
|
||||
->name('*.stub.php')
|
||||
->in($root);
|
||||
|
||||
$versions = GitVersionCollection::create($root)
|
||||
->add('develop', 'develop');
|
||||
|
||||
return new Doctum($iterator, [
|
||||
'title' => 'PhpRedis API',
|
||||
'language' => 'en',
|
||||
'source_dir' => $root,
|
||||
'build_dir' => "{$root}/docs",
|
||||
'cache_dir' => "{$root}/docs/.cache",
|
||||
'base_url' => 'https://phpredis.github.io/',
|
||||
'versions' => $versions,
|
||||
'remote_repository' => new GitHubRemoteRepository('phpredis/phpredis', $root),
|
||||
]);
|
||||
Reference in New Issue
Block a user