mirror of
https://github.com/php-win-ext/phpredis.git
synced 2026-03-24 09:02:07 +01:00
1740 lines
52 KiB
HTML
1740 lines
52 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<meta name="robots" content="index, follow, all" />
|
|
<title>RedisArray | 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 (main)" />
|
|
</head>
|
|
|
|
<body id="class" data-name="class:RedisArray" 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>RedisArray
|
|
</h1>
|
|
</div>
|
|
|
|
|
|
<p> class
|
|
<strong>RedisArray</strong> (<a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php">View source</a>)
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Methods</h2>
|
|
|
|
<div class="container-fluid underlined">
|
|
<div class="row">
|
|
<div class="col-md-2 type">
|
|
mixed
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method___call">__call</a>(string $function_name, array $arguments)
|
|
|
|
<p class="no-description">No description</p>
|
|
</div>
|
|
<div class="col-md-2"></div>
|
|
</div>
|
|
<div class="row">
|
|
<div class="col-md-2 type">
|
|
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method___construct">__construct</a>(string|array $name_or_hosts, array $options = 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|array
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method__continuum">_continuum</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|callable
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method__distributor">_distributor</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|callable
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method__function">_function</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|array
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method__hosts">_hosts</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|null|Redis
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method__instance">_instance</a>(string $host)
|
|
|
|
<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|null
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method__rehash">_rehash</a>(callable $fn = 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|string|null
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method__target">_target</a>(string $key)
|
|
|
|
<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
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_bgsave">bgsave</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|int
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_del">del</a>(string|array $key, string ...$otherkeys)
|
|
|
|
<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|null
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_discard">discard</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|null
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_exec">exec</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|array
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_flushall">flushall</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|array
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_flushdb">flushdb</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|array
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_getOption">getOption</a>(int $opt)
|
|
|
|
<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|array
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_hscan">hscan</a>(string $key, int|null $iterator, string|null $pattern = null, int $count = 0)
|
|
|
|
<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|array
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_info">info</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|array
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_keys">keys</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">
|
|
bool|array
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_mget">mget</a>(array $keys)
|
|
|
|
<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
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_mset">mset</a>(array $pairs)
|
|
|
|
<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|RedisArray
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_multi">multi</a>(string $host, int $mode = 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|array
|
|
</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|array
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_save">save</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|array
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_scan">scan</a>(int|null $iterator, string $node, string|null $pattern = null, int $count = 0)
|
|
|
|
<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|array
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_select">select</a>(int $index)
|
|
|
|
<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|array
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_setOption">setOption</a>(int $opt, string $value)
|
|
|
|
<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|array
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_sscan">sscan</a>(string $key, int|null $iterator, string|null $pattern = null, int $count = 0)
|
|
|
|
<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|int
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_unlink">unlink</a>(string|array $key, string ...$otherkeys)
|
|
|
|
<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|null
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_unwatch">unwatch</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|array
|
|
</div>
|
|
<div class="col-md-8">
|
|
<a href="#method_zscan">zscan</a>(string $key, int|null $iterator, string|null $pattern = null, int $count = 0)
|
|
|
|
<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___call">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L11">at line 11</a></div>
|
|
<code> mixed
|
|
<strong>__call</strong>(string $function_name, array $arguments)
|
|
</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>$function_name</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>array</td>
|
|
<td>$arguments</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>mixed</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method___construct">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L13">at line 13</a></div>
|
|
<code>
|
|
<strong>__construct</strong>(string|array $name_or_hosts, array $options = 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|array</td>
|
|
<td>$name_or_hosts</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>array</td>
|
|
<td>$options</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method__continuum">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L15">at line 15</a></div>
|
|
<code> bool|array
|
|
<strong>_continuum</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|array</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method__distributor">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L17">at line 17</a></div>
|
|
<code> bool|callable
|
|
<strong>_distributor</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|callable</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method__function">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L19">at line 19</a></div>
|
|
<code> bool|callable
|
|
<strong>_function</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|callable</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method__hosts">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L21">at line 21</a></div>
|
|
<code> bool|array
|
|
<strong>_hosts</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|array</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method__instance">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L23">at line 23</a></div>
|
|
<code> bool|null|Redis
|
|
<strong>_instance</strong>(string $host)
|
|
</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>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|null|Redis</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method__rehash">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L25">at line 25</a></div>
|
|
<code> bool|null
|
|
<strong>_rehash</strong>(callable $fn = 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>callable</td>
|
|
<td>$fn</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|null</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method__target">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L27">at line 27</a></div>
|
|
<code> bool|string|null
|
|
<strong>_target</strong>(string $key)
|
|
</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>$key</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|string|null</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_bgsave">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L29">at line 29</a></div>
|
|
<code> array
|
|
<strong>bgsave</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</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_del">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L31">at line 31</a></div>
|
|
<code> bool|int
|
|
<strong>del</strong>(string|array $key, string ...$otherkeys)
|
|
</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|array</td>
|
|
<td>$key</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>string</td>
|
|
<td>...$otherkeys</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|int</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_discard">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L33">at line 33</a></div>
|
|
<code> bool|null
|
|
<strong>discard</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|null</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_exec">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L35">at line 35</a></div>
|
|
<code> bool|null
|
|
<strong>exec</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|null</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_flushall">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L37">at line 37</a></div>
|
|
<code> bool|array
|
|
<strong>flushall</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|array</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_flushdb">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L39">at line 39</a></div>
|
|
<code> bool|array
|
|
<strong>flushdb</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|array</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_getOption">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L41">at line 41</a></div>
|
|
<code> bool|array
|
|
<strong>getOption</strong>(int $opt)
|
|
</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>int</td>
|
|
<td>$opt</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|array</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_hscan">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L43">at line 43</a></div>
|
|
<code> bool|array
|
|
<strong>hscan</strong>(string $key, int|null $iterator, string|null $pattern = null, int $count = 0)
|
|
</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>$key</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>int|null</td>
|
|
<td>$iterator</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>string|null</td>
|
|
<td>$pattern</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>int</td>
|
|
<td>$count</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|array</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_info">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L45">at line 45</a></div>
|
|
<code> bool|array
|
|
<strong>info</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|array</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_keys">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L47">at line 47</a></div>
|
|
<code> bool|array
|
|
<strong>keys</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|array</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_mget">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L49">at line 49</a></div>
|
|
<code> bool|array
|
|
<strong>mget</strong>(array $keys)
|
|
</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>array</td>
|
|
<td>$keys</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|array</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_mset">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L51">at line 51</a></div>
|
|
<code> bool
|
|
<strong>mset</strong>(array $pairs)
|
|
</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>array</td>
|
|
<td>$pairs</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_multi">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L53">at line 53</a></div>
|
|
<code> bool|RedisArray
|
|
<strong>multi</strong>(string $host, int $mode = 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>$mode</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|RedisArray</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/main/redis_array.stub.php#L55">at line 55</a></div>
|
|
<code> bool|array
|
|
<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|array</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_save">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L57">at line 57</a></div>
|
|
<code> bool|array
|
|
<strong>save</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|array</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_scan">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L59">at line 59</a></div>
|
|
<code> bool|array
|
|
<strong>scan</strong>(int|null $iterator, string $node, string|null $pattern = null, int $count = 0)
|
|
</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>int|null</td>
|
|
<td>$iterator</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>string</td>
|
|
<td>$node</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>string|null</td>
|
|
<td>$pattern</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>int</td>
|
|
<td>$count</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|array</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_select">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L61">at line 61</a></div>
|
|
<code> bool|array
|
|
<strong>select</strong>(int $index)
|
|
</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>int</td>
|
|
<td>$index</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|array</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_setOption">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L63">at line 63</a></div>
|
|
<code> bool|array
|
|
<strong>setOption</strong>(int $opt, string $value)
|
|
</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>int</td>
|
|
<td>$opt</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>string</td>
|
|
<td>$value</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|array</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_sscan">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L65">at line 65</a></div>
|
|
<code> bool|array
|
|
<strong>sscan</strong>(string $key, int|null $iterator, string|null $pattern = null, int $count = 0)
|
|
</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>$key</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>int|null</td>
|
|
<td>$iterator</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>string|null</td>
|
|
<td>$pattern</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>int</td>
|
|
<td>$count</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|array</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_unlink">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L67">at line 67</a></div>
|
|
<code> bool|int
|
|
<strong>unlink</strong>(string|array $key, string ...$otherkeys)
|
|
</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|array</td>
|
|
<td>$key</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>string</td>
|
|
<td>...$otherkeys</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|int</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_unwatch">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L69">at line 69</a></div>
|
|
<code> bool|null
|
|
<strong>unwatch</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|null</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="method-item">
|
|
<h3 id="method_zscan">
|
|
<div class="location"><a href="https://github.com/phpredis/phpredis/blob/main/redis_array.stub.php#L71">at line 71</a></div>
|
|
<code> bool|array
|
|
<strong>zscan</strong>(string $key, int|null $iterator, string|null $pattern = null, int $count = 0)
|
|
</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>$key</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>int|null</td>
|
|
<td>$iterator</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>string|null</td>
|
|
<td>$pattern</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td>int</td>
|
|
<td>$count</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h4>Return Value</h4>
|
|
|
|
<table class="table table-condensed">
|
|
<tr>
|
|
<td>bool|array</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>
|