<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Refresh extended operation helper</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ldap-exop-passwd.html">ldap_exop_passwd</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ldap-exop-whoami.html">ldap_exop_whoami</a></div>
<div class="up"><a href="ref.ldap.html">LDAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ldap-exop-refresh" class="refentry">
<div class="refnamediv">
<h1 class="refname">ldap_exop_refresh</h1>
<p class="verinfo">(PHP 7 >= 7.3.0)</p><p class="refpurpose"><span class="refname">ldap_exop_refresh</span> — <span class="dc-title">Refresh extended operation helper</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ldap-exop-refresh-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>ldap_exop_refresh</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$link</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$dn</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$ttl</code></span>
)</div>
<p class="para rdfs-comment">
Performs a Refresh extended operation and returns the data.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ldap-exop-refresh-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">link</code></dt>
<dd>
<p class="para">
An LDAP link identifier, returned by <span class="function"><a href="function.ldap-connect.html" class="function">ldap_connect()</a></span>.
</p>
</dd>
<dt>
<code class="parameter">dn</code></dt>
<dd>
<p class="para">
dn of the entry to refresh.
</p>
</dd>
<dt>
<code class="parameter">ttl</code></dt>
<dd>
<p class="para">
Time in seconds (between 1 and 31557600) that the
client requests that the entry exists in the directory before being
automatically removed.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ldap-exop-refresh-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
From RFC:
The responseTtl field is the time in seconds which the server chooses
to have as the time-to-live field for that entry. It must not be any
smaller than that which the client requested, and it may be larger.
However, to allow servers to maintain a relatively accurate
directory, and to prevent clients from abusing the dynamic
extensions, servers are permitted to shorten a client-requested
time-to-live value, down to a minimum of 86400 seconds (one day).
<strong><code>FALSE</code></strong> will be returned on error.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ldap-exop-refresh-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.ldap-exop.html" class="function" rel="rdfs-seeAlso">ldap_exop()</a> - Performs an extended operation</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ldap-exop-passwd.html">ldap_exop_passwd</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ldap-exop-whoami.html">ldap_exop_whoami</a></div>
<div class="up"><a href="ref.ldap.html">LDAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
