<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ldap.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.ldap-exop-refresh.php',
    1 => 'ldap_exop_refresh',
    2 => 'Refresh extended operation helper',
  ),
  'up' => 
  array (
    0 => 'ref.ldap.php',
    1 => 'LDAP Functions',
  ),
  'prev' => 
  array (
    0 => 'function.ldap-exop-passwd.php',
    1 => 'ldap_exop_passwd',
  ),
  'next' => 
  array (
    0 => 'function.ldap-exop-sync.php',
    1 => 'ldap_exop_sync',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/ldap/functions/ldap-exop-refresh.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ldap-exop-refresh" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ldap_exop_refresh</h1>
  <p class="verinfo">(PHP 7 &gt;= 7.3.0, PHP 8)</p><p class="refpurpose"><span class="refname">ldap_exop_refresh</span> &mdash; <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="methodname"><strong>ldap_exop_refresh</strong></span>(<span class="methodparam"><span class="type"><a href="class.ldap-connection.php" class="type LDAP\Connection">LDAP\Connection</a></span> <code class="parameter">$ldap</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$dn</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$ttl</code></span>): <span class="type"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></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">ldap</code></dt>
    <dd>
     <p class="para">
      An <span class="classname"><a href="class.ldap-connection.php" class="classname">LDAP\Connection</a></span> instance, returned by <span class="function"><a href="function.ldap-connect.php" 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><a href="reserved.constants.php#constant.false">false</a></code></strong> will be returned on error.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.ldap-exop-refresh-changelog">
  <h3 class="title">Changelog</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Version</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.1.0</td>
 <td>
  The <code class="parameter">ldap</code> parameter expects an <span class="classname"><a href="class.ldap-connection.php" class="classname">LDAP\Connection</a></span>
  instance now; previously, a valid <code class="literal">ldap link</code> <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> was expected.
 </td>
</tr>

    </tbody>
   
  </table>

 </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><span class="function"><a href="function.ldap-exop.php" class="function" rel="rdfs-seeAlso">ldap_exop()</a> - Performs an extended operation</span></li>
   </ul>
  </p>
 </div>



</div><?php manual_footer($setup); ?>