# functions

name: eval
purpose: Evaluate a string as PHP code
manual_id: function.eval
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   <span class="function">eval</span> returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> unless 
   <code class="literal">return</code> is called in the evaluated code, in which case
   the value passed to <code class="literal">return</code> is returned. As of PHP 7, if there is a
   parse error in the evaluated code, <span class="function">eval</span> throws a ParseError exception.
   Before PHP 7, in this case <span class="function">eval</span> returned
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> and execution of the following code continued normally. It is
   not possible to catch a parse error in <span class="function">eval</span>
   using <span class="function">set_error_handler</span>.
  </p>


name: get_browser
purpose: Tells what the user's browser is capable of
manual_id: function.get-browser
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The information is returned in an object or an array which will contain
   various data elements representing, for instance, the browser&#039;s major and
   minor version numbers and ID string; <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>/<strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> values for features
   such as frames, JavaScript, and cookies; and so forth.
  </p>
  <p class="para">
   The <code class="literal">cookies</code> value simply means that the browser
   itself is capable of accepting cookies and does not mean the user has
   enabled the browser to accept cookies or not. The only way to test if
   cookies are accepted is to set one with <span class="function">setcookie</span>,
   reload, and check for the value.
  </p>
  <p class="para">
    Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> when no information can be retrieved, such as when the
    <a href="misc.configuration.html#ini.browscap" class="link">browscap</a> configuration setting in 
    <var class="filename">php.ini</var> has not been set.
  </p>


name: highlight_file
purpose: Syntax highlighting of a file
manual_id: function.highlight-file
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   If <code class="parameter">return</code> is set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, returns the highlighted
   code as a string instead of printing it out. Otherwise, it will return
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: hrtime
purpose: Get the system's high resolution time
manual_id: function.hrtime
version: PHP 7 >= 7.3.0, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of integers in the form [seconds, nanoseconds], if the
   parameter <code class="parameter">as_number</code> is false. Otherwise the nanoseconds
   are returned as <span class="type">int</span> (64bit platforms) or <span class="type">float</span>
   (32bit platforms).
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: php_strip_whitespace
purpose: Return source with stripped comments and whitespace
manual_id: function.php-strip-whitespace
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The stripped source code will be returned on success, or an empty string
   on failure.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    This function respects the value of the
    <a href="ini.core.html#ini.short-open-tag" class="link">short_open_tag</a>
    ini directive.
   </p>
  </p></blockquote>


name: sapi_windows_cp_conv
purpose: Convert string from one codepage to another
manual_id: function.sapi-windows-cp-conv
version: PHP 7 >= 7.1.0, PHP 8
return_type: null
return_description:
<p class="para">
   The <code class="parameter">subject</code> string converted to
   <code class="parameter">out_codepage</code>, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   This function issues E_WARNING level errors, if invalid codepages are given,
   or if the subject is not valid for <code class="parameter">in_codepage</code>.
  </p>


name: sapi_windows_cp_get
purpose: Get current codepage
manual_id: function.sapi-windows-cp-get
version: PHP 7 >= 7.1.0, PHP 8
return_type: int
return_description:
<p class="para">
   If <code class="parameter">kind</code> is <code class="literal">&#039;ansi&#039;</code>,
   the current <acronym class="acronym">ANSI</acronym> code page of the operating system is returned.
   If <code class="parameter">kind</code> is <code class="literal">&#039;oem&#039;</code>,
   the current <acronym class="acronym">OEM</acronym> code page of the operating system is returned.
   Otherwise, the current codepage of the process is returned.
  </p>


name: sapi_windows_vt100_support
manual_id: function.sapi-windows-vt100-support
version: PHP 7 >= 7.2.0, PHP 8
return_type: bool
purpose:
Get or set VT100 support for the specified stream associated to an output buffer of a Windows console.

return_description:
<p class="para">
   If <code class="parameter">enable</code> is <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>: returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the VT100 feature is enabled, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>
  <p class="para">
   If <code class="parameter">enable</code> is a <span class="type">bool</span>: Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: sleep
purpose: Delay execution
manual_id: function.sleep
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns zero on success.
  </p>
  <p class="para">
   If the call was interrupted by a signal, <span class="function">sleep</span> returns
   a non-zero value. On Windows, this value will always be
   <code class="literal">192</code> (the value of the
   <strong><code>WAIT_IO_COMPLETION</code></strong> constant within the Windows API).
   On other platforms, the return value will be the number of seconds left to
   sleep.
  </p>

errors:
<p class="para">
   If the specified number of <code class="parameter">seconds</code> is negative,
   this function will throw a <span class="classname">ValueError</span>.
  </p>


name: sys_getloadavg
purpose: Gets system load average
manual_id: function.sys-getloadavg
version: PHP 5 >= 5.1.3, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="type">array</span> with three samples (last 1, 5 and 15
   minutes).
  </p>


name: time_nanosleep
purpose: Delay for a number of seconds and nanoseconds
manual_id: function.time-nanosleep
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   If the delay was interrupted by a signal, an associative array will be
   returned with the components:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      <code class="literal">seconds</code> - number of seconds remaining in
      the delay
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">nanoseconds</code> - number of nanoseconds
      remaining in the delay
     </span>
    </li>
   </ul>
  </p>


name: time_sleep_until
purpose: Make the script sleep until the specified time
manual_id: function.time-sleep-until
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   If the specified <code class="parameter">timestamp</code> is in the past, this
   function will generate a <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong>.
  </p>


name: uniqid
purpose: Generate a unique ID
manual_id: function.uniqid
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns timestamp based unique identifier as a string.
  </p>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="para">
     This function tries to create unique identifier, but it does not
     guarantee 100% uniqueness of return value.
   </p>
  </div>


name: unpack
purpose: Unpack data from binary string
manual_id: function.unpack
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an associative array containing unpacked elements of binary
   string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: getrandmax
purpose: Show largest possible random value
manual_id: function.getrandmax
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The largest possible random value returned by <span class="function">rand</span>
  </p>


name: mt_getrandmax
purpose: Show largest possible random value
manual_id: function.mt-getrandmax
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the maximum random value returned by a call to
   <span class="function">mt_rand</span> without arguments, which is the maximum value
   that can be used for its <code class="parameter">max</code> parameter without the
   result being scaled up (and therefore less random).
  </p>


name: mt_rand
purpose: Generate a random value via the Mersenne Twister Random Number Generator
manual_id: function.mt-rand
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   A random integer value between <code class="parameter">min</code> (or 0)
   and <code class="parameter">max</code> (or <span class="function">mt_getrandmax</span>, inclusive),
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">max</code> is less than <code class="parameter">min</code>.
  </p>


name: rand
purpose: Generate a random integer
manual_id: function.rand
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   A pseudo random value between <code class="parameter">min</code>
   (or 0) and <code class="parameter">max</code> (or <span class="function">getrandmax</span>, inclusive).
  </p>


name: random_bytes
purpose: Get cryptographically secure random bytes
manual_id: function.random-bytes
version: PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A string containing the requested number of cryptographically
   secure random bytes.
  </p>

errors:
<ul class="itemizedlist">
   
 <li class="listitem">
  <span class="simpara">
   If an appropriate source of randomness cannot be found,
   a <span class="classname">Random\RandomException</span> will be thrown.
  </span>
 </li>

   <li class="listitem">
    <span class="simpara">
     If the value of <code class="parameter">length</code> is less than <code class="literal">1</code>,
     a <span class="classname">ValueError</span> will be thrown.
    </span>
   </li>
  </ul>


name: random_int
purpose: Get a cryptographically secure, uniformly selected integer
manual_id: function.random-int
version: PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   A cryptographically secure, uniformly selected integer from the closed interval
   [<code class="parameter">min</code>, <code class="parameter">max</code>]. Both
   <code class="parameter">min</code> and <code class="parameter">max</code> are
   possible return values.
  </p>

errors:
<ul class="itemizedlist">
   
 <li class="listitem">
  <span class="simpara">
   If an appropriate source of randomness cannot be found,
   a <span class="classname">Random\RandomException</span> will be thrown.
  </span>
 </li>

   <li class="listitem">
    <span class="simpara">
     If <code class="parameter">max</code> is less than <code class="parameter">min</code>, a
     <span class="classname">ValueError</span> will be thrown.
    </span>
   </li>
  </ul>


name: Random\Randomizer.getBytes
purpose: Get random bytes
manual_id: random-randomizer.getbytes
version: PHP 8 >= 8.2.0
return_type: string
return_description:
<p class="para">
   A <span class="type">string</span> containing the requested number of random bytes.
  </p>

errors:
<ul class="itemizedlist">
   <li class="listitem">
    <span class="simpara">
     If the value of <code class="parameter">length</code> is less than <code class="literal">1</code>,
     a <span class="classname">ValueError</span> will be thrown.
    </span>
   </li>
   
 <li class="listitem">
  <span class="simpara">
   Any <span class="classname">Throwable</span>s thrown by the  <span class="methodname">Random\Engine::generate</span> method
   of the underlying <a href="class.random-randomizer.html#random-randomizer.props.engine" class="link"><code class="literal">Random\Randomizer::$engine</code></a>.
  </span>
 </li>

  </ul>


name: Random\Randomizer.getBytesFromString
purpose: Get random bytes from a source string
manual_id: random-randomizer.getbytesfromstring
version: PHP 8 >= 8.3.0
return_type: string
return_description:
<p class="para">
   A <span class="type">string</span> containing the requested number of random bytes taken from the input <code class="parameter">string</code>.
  </p>

errors:
<ul class="itemizedlist">
   <li class="listitem">
    <span class="simpara">
     If <code class="parameter">string</code> is empty,
     a <span class="classname">ValueError</span> will be thrown.
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     If the value of <code class="parameter">length</code> is less than <code class="literal">1</code>,
     a <span class="classname">ValueError</span> will be thrown.
    </span>
   </li>
   
 <li class="listitem">
  <span class="simpara">
   Any <span class="classname">Throwable</span>s thrown by the  <span class="methodname">Random\Engine::generate</span> method
   of the underlying <a href="class.random-randomizer.html#random-randomizer.props.engine" class="link"><code class="literal">Random\Randomizer::$engine</code></a>.
  </span>
 </li>

  </ul>


name: Random\Randomizer.getFloat
purpose: Get a uniformly selected float
manual_id: random-randomizer.getfloat
version: PHP 8 >= 8.3.0
return_type: float
return_description:
<p class="para">
   A uniformly selected, equidistributed float from the interval specified by <code class="parameter">min</code>,
   <code class="parameter">max</code>, and <code class="parameter">boundary</code>.

   Whether <code class="parameter">min</code> and <code class="parameter">max</code> are possible return values depends
   on the value of <code class="parameter">boundary</code>.
  </p>

errors:
<ul class="itemizedlist">
   <li class="listitem">
    <span class="simpara">
     If the value of <code class="parameter">min</code> is not finite (<span class="function">is_finite</span>),
     a <span class="classname">ValueError</span> will be thrown.
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     If the value of <code class="parameter">max</code> is not finite (<span class="function">is_finite</span>),
     a <span class="classname">ValueError</span> will be thrown.
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     If the requested interval does not contain any values,
     a <span class="classname">ValueError</span> will be thrown.
    </span>
   </li>
   
 <li class="listitem">
  <span class="simpara">
   Any <span class="classname">Throwable</span>s thrown by the  <span class="methodname">Random\Engine::generate</span> method
   of the underlying <a href="class.random-randomizer.html#random-randomizer.props.engine" class="link"><code class="literal">Random\Randomizer::$engine</code></a>.
  </span>
 </li>

  </ul>


name: Random\Randomizer.getInt
purpose: Get a uniformly selected integer
manual_id: random-randomizer.getint
version: PHP 8 >= 8.2.0
return_type: int
return_description:
<p class="para">
   A uniformly selected integer from the closed interval
   [<code class="parameter">min</code>, <code class="parameter">max</code>]. Both
   <code class="parameter">min</code> and <code class="parameter">max</code> are
   possible return values.
  </p>

errors:
<ul class="itemizedlist">
   <li class="listitem">
    <span class="simpara">
     If <code class="parameter">max</code> is less than <code class="parameter">min</code>, a
     <span class="classname">ValueError</span> will be thrown.
    </span>
   </li>
   
 <li class="listitem">
  <span class="simpara">
   Any <span class="classname">Throwable</span>s thrown by the  <span class="methodname">Random\Engine::generate</span> method
   of the underlying <a href="class.random-randomizer.html#random-randomizer.props.engine" class="link"><code class="literal">Random\Randomizer::$engine</code></a>.
  </span>
 </li>

  </ul>


name: Random\Randomizer.nextFloat
purpose: Get a float from the right-open interval [0.0, 1.0)
manual_id: random-randomizer.nextfloat
version: PHP 8 >= 8.3.0
return_type: float
return_description:
<p class="para">
   A uniformly selected, equidistributed float from the right-open (<code class="literal">IntervalBoundary::ClosedOpen</code>)
   interval [0.0, 1.0).

   <code class="literal">0.0</code> is a possible return value, <code class="literal">1.0</code> is not.
  </p>

errors:
<ul class="itemizedlist">
   
 <li class="listitem">
  <span class="simpara">
   Any <span class="classname">Throwable</span>s thrown by the  <span class="methodname">Random\Engine::generate</span> method
   of the underlying <a href="class.random-randomizer.html#random-randomizer.props.engine" class="link"><code class="literal">Random\Randomizer::$engine</code></a>.
  </span>
 </li>

  </ul>


name: Random\Randomizer.nextInt
purpose: Get a positive integer
manual_id: random-randomizer.nextint
version: PHP 8 >= 8.2.0
return_type: int
return_description:
<p class="para">
    A positive integer between 0 and a maximum value depending on the number of bytes
    returned from  <span class="methodname">Random\Engine::generate</span>.
    The exact maximum can be calculated as 2<sup class="superscript">$engine_bytes * 8 - 1</sup> - 1.
  </p>

errors:
<ul class="itemizedlist">
   <li class="listitem">
    <span class="simpara">
      To avoid inconsistencies, 32 bit PHP will throw <span class="classname">Random\RandomException</span>
      if the output size of  <span class="methodname">Random\Engine::generate</span> exceeds 32 bits,
      as the selected integer cannot be returned losslessly.
      This affects the native 64 bit engines <span class="classname">Random\Engine\PcgOneseq128XslRr64</span> and
      <span class="classname">Random\Engine\Xoshiro256StarStar</span>. Any userland engine
      returning more than 4 bytes of randomness is also affected.
    </span>
   </li>
   
 <li class="listitem">
  <span class="simpara">
   Any <span class="classname">Throwable</span>s thrown by the  <span class="methodname">Random\Engine::generate</span> method
   of the underlying <a href="class.random-randomizer.html#random-randomizer.props.engine" class="link"><code class="literal">Random\Randomizer::$engine</code></a>.
  </span>
 </li>

  </ul>


name: Random\Randomizer.pickArrayKeys
purpose: Select random array keys
manual_id: random-randomizer.pickarraykeys
version: PHP 8 >= 8.2.0
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span> containing <code class="parameter">num</code> distinct array keys of <code class="parameter">array</code>.
  </p>
  <p class="para">
   The returned <span class="type">array</span> will be a list (<span class="function">array_is_list</span>). It will be a subset
   of the <span class="type">array</span> returned by <span class="function">array_keys</span>.
  </p>

errors:
<ul class="itemizedlist">
   <li class="listitem">
    <span class="simpara">
     If <code class="parameter">num</code> is less than <code class="literal">1</code> or
     greater than the number of elements in <code class="parameter">array</code>, a
     <span class="classname">ValueError</span> will be thrown.
    </span>
   </li>
   
 <li class="listitem">
  <span class="simpara">
   Any <span class="classname">Throwable</span>s thrown by the  <span class="methodname">Random\Engine::generate</span> method
   of the underlying <a href="class.random-randomizer.html#random-randomizer.props.engine" class="link"><code class="literal">Random\Randomizer::$engine</code></a>.
  </span>
 </li>

  </ul>


name: Random\Randomizer.shuffleArray
purpose: Get a permutation of an array
manual_id: random-randomizer.shufflearray
version: PHP 8 >= 8.2.0
return_type: array
return_description:
<p class="para">
   A permutation of the values of <code class="parameter">array</code>.
  </p>
  <p class="para">
   Array keys of the input <code class="parameter">array</code> will not be preserved;
   the returned <span class="type">array</span> will be a list (<span class="function">array_is_list</span>).
  </p>

errors:
<ul class="itemizedlist">
   
 <li class="listitem">
  <span class="simpara">
   Any <span class="classname">Throwable</span>s thrown by the  <span class="methodname">Random\Engine::generate</span> method
   of the underlying <a href="class.random-randomizer.html#random-randomizer.props.engine" class="link"><code class="literal">Random\Randomizer::$engine</code></a>.
  </span>
 </li>

  </ul>


name: Random\Engine.generate
purpose: Generates randomness
manual_id: random-engine.generate
version: PHP 8 >= 8.2.0
return_type: string
return_description:
<p class="para">
   A non-empty string containing random bytes.
  </p>

  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    The <span class="classname">Random\Randomizer</span> works with unsigned 64 bit integers internally.
    If the returned string contains more than 64 bit (8 byte) of randomness the exceeding
    bytes will be ignored. Other applications may be able to process more than 64 bit at once.
   </span>
  </p></blockquote>

errors:
<ul class="itemizedlist">
   <li class="listitem">
    <span class="simpara">
     If generating randomness fails, a <span class="classname">Random\RandomException</span> should
     be thrown. Any other <span class="classname">Exception</span> thrown during generation should
     be caught and wrapped into a <span class="classname">Random\RandomException</span>.
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     If the returned string is empty, a <span class="classname">Random\BrokenRandomEngineError</span>
     will be thrown by the <span class="classname">Random\Randomizer</span>.
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     If the implemented algorithm is severely biased, a <span class="classname">Random\BrokenRandomEngineError</span>
     may be thrown by the <span class="classname">Random\Randomizer</span> to prevent infinite loops
     if rejection sampling is required to return unbiased results.
    </span>
   </li>
  </ul>


name: Random\Engine\Secure.generate
purpose: Generate cryptographically secure randomness
manual_id: random-engine-secure.generate
version: PHP 8 >= 8.2.0
return_type: string
return_description:
<p class="para">
   A string containing <strong><code><a href="reserved.constants.html#constant.php-int-size">PHP_INT_SIZE</a></code></strong> cryptographically secure random bytes.
  </p>

errors:
<ul class="itemizedlist">
   
 <li class="listitem">
  <span class="simpara">
   If an appropriate source of randomness cannot be found,
   a <span class="classname">Random\RandomException</span> will be thrown.
  </span>
 </li>

  </ul>


name: Random\Engine\PcgOneseq128XslRr64.__construct
purpose: Constructs a new PCG Oneseq 128 XSL RR 64 engine
manual_id: random-engine-pcgoneseq128xslrr64.construct
version: PHP 8 >= 8.2.0
errors:
<ul class="itemizedlist">
   <li class="listitem">
    <span class="simpara">
     If the length of a <span class="type">string</span> <code class="parameter">seed</code> is
     not 16 bytes, a <span class="classname">ValueError</span> will be thrown.
    </span>
   </li>
  </ul>


name: Random\Engine\PcgOneseq128XslRr64.jump
purpose: Efficiently move the engine ahead multiple steps
manual_id: random-engine-pcgoneseq128xslrr64.jump
version: PHP 8 >= 8.2.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<ul class="itemizedlist">
   <li class="listitem">
    <span class="simpara">
     If <code class="parameter">advance</code> is less than <code class="literal">0</code>,
     a <span class="classname">ValueError</span> will be thrown.
    </span>
   </li>
  </ul>


name: Random\Engine\Xoshiro256StarStar.__construct
purpose: Constructs a new xoshiro256** engine
manual_id: random-engine-xoshiro256starstar.construct
version: PHP 8 >= 8.2.0
errors:
<ul class="itemizedlist">
   <li class="listitem">
    <span class="simpara">
     If the length of a <span class="type">string</span> <code class="parameter">seed</code> is
     not 32 bytes, a <span class="classname">ValueError</span> will be thrown.
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     If a <span class="type">string</span> <code class="parameter">seed</code> consists of
     32 NUL bytes (<code class="literal">&quot;\x00&quot;</code>), a <span class="classname">ValueError</span>
     will be thrown.
    </span>
   </li>
  </ul>


name: SeasLog.analyzerCount
purpose: Get log count by level, log_path and key_word
manual_id: seaslog.analyzercount
version: PECL seaslog >=1.1.6
return_type: mixed
return_description:
<p class="para">
   If `level` is SEASLOG_ALL or Empty, return all levels count as `array`.
   If `level` is SEASLOG_INFO or the other level, return count as `int`.
  </p>


name: SeasLog.analyzerDetail
purpose: Get log detail by level, log_path, key_word, start, limit, order
manual_id: seaslog.analyzerdetail
version: PECL seaslog >=1.1.6
return_type: mixed
return_description:
<p class="para">
   Return results as array.
   <blockquote class="note"><p><strong class="note">Note</strong>: 
    <p class="para">
     When `start`,`limit` is not NULL and in Windows, 
     SeasLog will threw exception with message &#039;Param start and limit don&#039;t support Windows&#039;.
    </p>
   </p></blockquote>
  </p>


name: SeasLog.getBasePath
purpose: Get SeasLog base path.
manual_id: seaslog.getbasepath
version: PECL seaslog >=1.0.0
return_type: string
return_description:
<p class="para">
   Return <a href="seaslog.configuration.html#ini.seaslog.default-basepath" class="link">seaslog.default_basepath</a> as string.
  </p>


name: SeasLog.getBufferEnabled
purpose: Determin if buffer enabled
manual_id: seaslog.getbufferenabled
version: PECL seaslog >=1.0.0
return_type: bool
return_description:
<p class="para">
   Return TRUE on <a href="seaslog.configuration.html#ini.seaslog.use-buffer" class="link">seaslog.use_buffer</a> is true.
   If switch <a href="seaslog.configuration.html#ini.seaslog.buffer-disabled-in-cli" class="link">seaslog.buffer_disabled_in_cli</a> on, and running in cli, 
   seaslog.use_buffer setting will be discarded, Seaslog write to the Data Store IMMEDIATELY.
  </p>


name: SeasLog.getDatetimeFormat
purpose: Get SeasLog datetime format style
manual_id: seaslog.getdatetimeformat
version: PECL seaslog >=1.0.0
return_type: string
return_description:
<p class="para">
    Get SeasLog datetime format style of 
    <a href="seaslog.configuration.html#ini.seaslog.default-datetime-format" class="link">seaslog.default_datetime_format</a>.
    Use the Function  <span class="methodname">SeasLog::setDatetimeFormat</span> 
    will change this value.
  </p>


name: SeasLog.getLastLogger
purpose: Get SeasLog last logger path
manual_id: seaslog.getlastlogger
version: PECL seaslog >=1.0.0
return_type: string
return_description:
<p class="para">
   Use the Function  <span class="methodname">SeasLog::setLogger</span> 
   will change the value of function  <span class="methodname">SeasLog::getLastLogger</span>.
  </p>


name: SeasLog.getRequestID
purpose: Get SeasLog request_id differentiated requests
manual_id: seaslog.getrequestid
version: PECL seaslog >=1.0.0
return_type: string
return_description:
<p class="para">
   Return string generated by the built-in `static char *get_uniqid ()` function,
   or setted by  <span class="methodname">SeasLog::setRequestId</span> function.
  </p>


name: SplDoublyLinkedList.add
purpose: Add/insert a new value at the specified index
manual_id: spldoublylinkedlist.add
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Throws <span class="classname">OutOfRangeException</span> when 
   <code class="parameter">index</code> is out of bounds or when 
   <code class="parameter">index</code> cannot be parsed as an integer.
  </p>


name: SplDoublyLinkedList.bottom
purpose: Peeks at the node from the beginning of the doubly linked list
manual_id: spldoublylinkedlist.bottom
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: mixed
return_description: <p class="para"> The value of the first node. </p>
errors:
<p class="para">
    Throws <span class="classname">RuntimeException</span> when the data-structure is empty.
   </p>


name: SplDoublyLinkedList.offsetExists
purpose: Returns whether the requested $index exists
manual_id: spldoublylinkedlist.offsetexists
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the requested <code class="parameter">index</code> exists, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: SplDoublyLinkedList.offsetGet
purpose: Returns the value at the specified $index
manual_id: spldoublylinkedlist.offsetget
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: mixed
return_description: <p class="para"> The value at the specified <code class="parameter">index</code>. </p>
errors:
<p class="para">
  Throws <span class="classname">OutOfRangeException</span> when <code class="parameter">index</code> is out of bounds
  or when <code class="parameter">index</code> cannot be parsed as an integer.
 </p>


name: SplDoublyLinkedList.offsetSet
purpose: Sets the value at the specified $index to $value
manual_id: spldoublylinkedlist.offsetset
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Throws <span class="classname">OutOfRangeException</span> when <code class="parameter">index</code> is out of bounds or when <code class="parameter">index</code> cannot be parsed as an integer.
  </p>


name: SplDoublyLinkedList.offsetUnset
purpose: Unsets the value at the specified $index
manual_id: spldoublylinkedlist.offsetunset
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Throws <span class="classname">OutOfRangeException</span> when <code class="parameter">index</code> is out of bounds
   or when <code class="parameter">index</code> cannot be parsed as an integer.
  </p>


name: SplDoublyLinkedList.pop
purpose: Pops a node from the end of the doubly linked list
manual_id: spldoublylinkedlist.pop
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: mixed
return_description: <p class="para"> The value of the popped node. </p>
errors:
<p class="para">
   Throws <span class="classname">RuntimeException</span> when the data-structure is empty.
  </p>


name: SplDoublyLinkedList.valid
purpose: Check whether the doubly linked list contains more nodes
manual_id: spldoublylinkedlist.valid
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the doubly linked list contains any more nodes, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SplHeap.compare
purpose: Compare elements in order to place them correctly in the heap while sifting up
manual_id: splheap.compare
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Result of the comparison, positive integer if <code class="parameter">value1</code> is greater than <code class="parameter">value2</code>, 0 if they are equal, negative integer otherwise.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    Having multiple elements with the same value in a Heap is not recommended. They will end up in an arbitrary relative position.
   </p>
  </p></blockquote>


name: SplHeap.isCorrupted
purpose: Tells if the heap is in a corrupted state
manual_id: splheap.iscorrupted
version: PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the heap is corrupted, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SplHeap.valid
purpose: Check whether the heap contains more nodes
manual_id: splheap.valid
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the heap contains any more nodes, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SplMinHeap.compare
purpose: Compare elements in order to place them correctly in the heap while sifting up
manual_id: splminheap.compare
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Result of the comparison, positive integer if <code class="parameter">value1</code> is lower than <code class="parameter">value2</code>, 0 if they are equal, negative integer otherwise.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    Having multiple elements with the same value in a Heap is not recommended. They will end up in an arbitrary relative position.
   </p>
  </p></blockquote>


name: SplPriorityQueue.compare
purpose: Compare priorities in order to place elements correctly in the heap while sifting up
manual_id: splpriorityqueue.compare
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Result of the comparison, positive integer if <code class="parameter">priority1</code> is greater than <code class="parameter">priority2</code>, 0 if they are equal, negative integer otherwise.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    Multiple elements with the same priority will get dequeued in no particular order.
   </p>
  </p></blockquote>


name: SplPriorityQueue.current
purpose: Return current node pointed by the iterator
manual_id: splpriorityqueue.current
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   The value or priority (or both) of the current node, depending on the extract flag.
  </p>


name: SplPriorityQueue.extract
purpose: Extracts a node from top of the heap and sift up
manual_id: splpriorityqueue.extract
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   The value or priority (or both) of the extracted node, depending on the extract flag.
  </p>


name: SplPriorityQueue.isCorrupted
purpose: Tells if the priority queue is in a corrupted state
manual_id: splpriorityqueue.iscorrupted
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the priority queue is corrupted, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SplPriorityQueue.top
purpose: Peeks at the node from the top of the queue
manual_id: splpriorityqueue.top
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   The value or priority (or both) of the top node, depending on the extract flag.
  </p>


name: SplPriorityQueue.valid
purpose: Check whether the queue contains more nodes
manual_id: splpriorityqueue.valid
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the queue contains any more nodes, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SplFixedArray.__construct
purpose: Constructs a new fixed array
manual_id: splfixedarray.construct
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
errors:
<p class="para">
   Throws a <span class="classname">ValueError</span> when <code class="parameter">size</code>
   is a negative integer.
  </p>


name: SplFixedArray.current
purpose: Return current array entry
manual_id: splfixedarray.current
version: PHP 5 >= 5.3.0, PHP 7
return_type: mixed
return_description: <p class="para"> The current element value. </p>
errors:
<p class="para">
   Throws <span class="classname">RuntimeException</span> when the internal array pointer points to an 
   invalid index or is out of bounds. 
  </p>


name: SplFixedArray.fromArray
purpose: Import a PHP array in a SplFixedArray instance
manual_id: splfixedarray.fromarray
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: SplFixedArray
return_description:
<p class="para">
   Returns an instance of <span class="classname">SplFixedArray</span> 
   containing the array content.
  </p>


name: SplFixedArray.getIterator
purpose: Retrieve the iterator to go through the array
manual_id: splfixedarray.getiterator
version: PHP 8
return_type: Iterator
return_description:
<p class="para">
   An instance of an object implementing <span class="classname">Iterator</span> to go
   through the array.
  </p>


name: SplFixedArray.jsonSerialize
purpose: Returns a representation that can be converted to JSON
manual_id: splfixedarray.jsonserialize
version: PHP 8 >= 8.1.0
return_type: array
return_description:
<p class="para">
   Returns array data which can be serialized by <span class="function">json_encode</span>,
   which is a value of any type other than a <a href="language.types.resource.html" class="link">resource</a>.
  </p>


name: SplFixedArray.offsetGet
purpose: Returns the value at the specified index
manual_id: splfixedarray.offsetget
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: mixed
return_description: <p class="para"> The value at the specified <code class="parameter">index</code>. </p>
errors:
<p class="para">
   Throws <span class="classname">RuntimeException</span> when <code class="parameter">index</code> is outside 
   the defined size of the array or when <code class="parameter">index</code> cannot be parsed as an integer.
  </p>


name: SplFixedArray.offsetSet
purpose: Sets a new value at a specified index
manual_id: splfixedarray.offsetset
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Throws <span class="classname">RuntimeException</span> when <code class="parameter">index</code> is outside
   the defined size of the array or when <code class="parameter">index</code> cannot be parsed as an integer.
  </p>


name: SplFixedArray.setSize
purpose: Change the size of an array
manual_id: splfixedarray.setsize
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   Throws <span class="classname">InvalidArgumentException</span> when <code class="parameter">size</code> is less than zero.
  </p>
  <p class="para">
   Raises <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> when <code class="parameter">size</code> cannot be used as a number.
  </p>


name: SplFixedArray.toArray
purpose: Returns a PHP array from the fixed array
manual_id: splfixedarray.toarray
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns a PHP <span class="type">array</span>, similar to the fixed array.
  </p>


name: SplFixedArray.valid
purpose: Check whether the array contains more elements
manual_id: splfixedarray.valid
version: PHP 5 >= 5.3.0, PHP 7
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the array contains any more elements, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SplObjectStorage.contains
purpose: Checks if the storage contains a specific object
manual_id: splobjectstorage.contains
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: object
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the <span class="type">object</span> is in the storage, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SplObjectStorage.getHash
purpose: Calculate a unique identifier for the contained objects
manual_id: splobjectstorage.gethash
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: string
return_description: <p class="para"> A <span class="type">string</span> with the calculated identifier. </p>
errors:
<p class="para">
   A <span class="classname">RuntimeException</span> is thrown when the returned
   value is not a <span class="type">string</span>.
  </p>


name: SplObjectStorage.offsetExists
purpose: Checks whether an object exists in the storage
manual_id: splobjectstorage.offsetexists
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: object
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the <span class="type">object</span> exists in the storage,
   and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SplObjectStorage.offsetGet
purpose: Returns the data associated with an object
manual_id: splobjectstorage.offsetget
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: object
return_description:
<p class="para">
   The data previously associated with the <span class="type">object</span> in the storage.
  </p>

errors:
<p class="para">
   Throws <span class="classname">UnexpectedValueException</span> when <code class="parameter">object</code> could not be found.
  </p>


name: SplObjectStorage.valid
purpose: Returns if the current iterator entry is valid
manual_id: splobjectstorage.valid
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the iterator entry is valid, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: AppendIterator.current
purpose: Gets the current value
manual_id: appenditerator.current
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   The current value if it is valid or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> otherwise.
  </p>


name: AppendIterator.getArrayIterator
purpose: Gets the ArrayIterator
manual_id: appenditerator.getarrayiterator
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: ArrayIterator
return_description:
<p class="para">
   Returns an <span class="classname">ArrayIterator</span> containing
   the appended iterators.
  </p>


name: AppendIterator.getIteratorIndex
purpose: Gets an index of iterators
manual_id: appenditerator.getiteratorindex
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the zero-based, integer index of the current inner iterator if it exists, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> otherwise.
  </p>


name: AppendIterator.key
purpose: Gets the current key
manual_id: appenditerator.key
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: scalar
return_description:
<p class="para">
   The current key if it is valid or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> otherwise.
  </p>


name: AppendIterator.valid
purpose: Checks validity of the current element
manual_id: appenditerator.valid
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the current iteration is valid, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ArrayIterator.count
purpose: Count elements
manual_id: arrayiterator.count
version: PHP 5, PHP 7, PHP 8
return_type: object
return_description:
<p class="para">
   The number of elements or public properties in the associated
   <span class="type">array</span> or <span class="type">object</span>, respectively.
  </p>


name: ArrayIterator.getArrayCopy
purpose: Get array copy
manual_id: arrayiterator.getarraycopy
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   A copy of the <span class="type">array</span>, or array of public properties
   if ArrayIterator refers to an <span class="type">object</span>.
  </p>


name: ArrayIterator.offsetExists
purpose: Check if offset exists
manual_id: arrayiterator.offsetexists
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the offset exists, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ArrayIterator.valid
purpose: Check whether array contains more entries
manual_id: arrayiterator.valid
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the iterator is valid, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: CachingIterator.getCache
purpose: Retrieve the contents of the cache
manual_id: cachingiterator.getcache
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: array
return_description: <p class="para"> An <span class="type">array</span> containing the cache items. </p>
errors:
<p class="para">
   Throws a <span class="classname">BadMethodCallException</span> when the
   <strong><code><a href="class.cachingiterator.html#cachingiterator.constants.full-cache">CachingIterator::FULL_CACHE</a></code></strong> flag is not being used.
  </p>


name: CachingIterator.offsetExists
purpose: The offsetExists purpose
manual_id: cachingiterator.offsetexists
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if an entry referenced by the offset exists, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: CachingIterator.__toString
purpose: Return the string representation of the current element
manual_id: cachingiterator.tostring
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The <span class="type">string</span> representation of the current element.
  </p>


name: CallbackFilterIterator.accept
purpose: Calls the callback with the current value, the current key and the inner iterator as arguments
manual_id: callbackfilteriterator.accept
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> to accept the current item, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: DirectoryIterator.__construct
purpose: Constructs a new directory iterator from a path
manual_id: directoryiterator.construct
version: PHP 5, PHP 7, PHP 8
errors:
<p class="para">
   Throws an <span class="classname">UnexpectedValueException</span>
   if the <code class="parameter">directory</code> does not exist.
  </p>
  <p class="para">
   Throws a <span class="classname">ValueError</span>
   if the <code class="parameter">directory</code> is an empty string.
  </p>


name: DirectoryIterator.getBasename
purpose: Get base name of current DirectoryIterator item
manual_id: directoryiterator.getbasename
version: PHP 5 >= 5.2.2, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The base name of the current <span class="classname">DirectoryIterator</span> item.
  </p>


name: DirectoryIterator.getExtension
purpose: Gets the file extension
manual_id: directoryiterator.getextension
version: PHP 5 >= 5.3.6, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns a <span class="type">string</span> containing the file extension, or an
   empty <span class="type">string</span> if the file has no extension.
  </p>


name: DirectoryIterator.getFilename
purpose: Return file name of current DirectoryIterator item
manual_id: directoryiterator.getfilename
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the file name of the current <span class="classname">DirectoryIterator</span> item.
  </p>


name: DirectoryIterator.isDot
purpose: Determine if current DirectoryIterator item is '.' or '..'
manual_id: directoryiterator.isdot
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the entry is <code class="literal">.</code> or <code class="literal">..</code>,
   otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: DirectoryIterator.key
purpose: Return the key for the current DirectoryIterator item
manual_id: directoryiterator.key
version: PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   The key for the current <span class="classname">DirectoryIterator</span> item as an <span class="type">int</span>.
  </p>


name: DirectoryIterator.valid
purpose: Check whether current DirectoryIterator position is a valid file
manual_id: directoryiterator.valid
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the position is valid, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: EmptyIterator.valid
purpose: Checks whether the current element is valid
manual_id: emptyiterator.valid
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: FilesystemIterator.current
purpose: The current file
manual_id: filesystemiterator.current
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: FilesystemIterator
return_description:
<p class="para">
   The filename, file information, or $this depending on the set flags.
   See the <a href="class.filesystemiterator.html#filesystemiterator.constants" class="link">FilesystemIterator constants</a>.
  </p>


name: FilesystemIterator.key
purpose: Retrieve the key for the current file
manual_id: filesystemiterator.key
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the pathname or filename depending on the set flags.
   See the <a href="class.filesystemiterator.html#filesystemiterator.constants" class="link">FilesystemIterator constants</a>.
  </p>


name: FilterIterator.accept
purpose: Check whether the current element of the iterator is acceptable
manual_id: filteriterator.accept
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the current element is acceptable, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: FilterIterator.valid
purpose: Check whether the current element is valid
manual_id: filteriterator.valid
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the current element is valid, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: GlobIterator.count
purpose: Get the number of directories and files
manual_id: globiterator.count
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The number of returned directories and files, as an
   <span class="type">int</span>.
  </p>


name: IteratorIterator.getInnerIterator
purpose: Get the inner iterator
manual_id: iteratoriterator.getinneriterator
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The inner iterator as passed to  <span class="methodname">IteratorIterator::__construct</span>, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> when there is no inner iterator.
  </p>


name: IteratorIterator.valid
purpose: Checks if the current element is valid
manual_id: iteratoriterator.valid
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the current element is valid, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: LimitIterator.__construct
purpose: Construct a LimitIterator
manual_id: limititerator.construct
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
errors:
<p class="para">
   Throws a <span class="classname">ValueError</span>
   if the <code class="parameter">offset</code> is less than <code class="literal">0</code>
   or the <code class="parameter">limit</code> is less than <code class="literal">-1</code>.
  </p>


name: LimitIterator.current
purpose: Get current element
manual_id: limititerator.current
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns the current element or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if there is none.
  </p>


name: LimitIterator.seek
purpose: Seek to the given position
manual_id: limititerator.seek
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: int
return_description: <p class="para"> Returns the offset position after seeking. </p>
errors:
<p class="para">
   Throws an <span class="classname">OutOfBoundsException</span> if the position is 
   outside of the limits specified in  <span class="methodname">LimitIterator::__construct</span>.
  </p>


name: MultipleIterator.attachIterator
purpose: Attaches iterator information
manual_id: multipleiterator.attachiterator
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> Description... </p>
errors:
<p class="para">
   An <span class="classname">IllegalValueException</span> if the <code class="parameter">iterator</code> parameter
   is invalid, or if <code class="parameter">info</code> is already associated
   information.
  </p>


name: MultipleIterator.countIterators
purpose: Gets the number of attached iterator instances
manual_id: multipleiterator.countiterators
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The number of attached iterator instances (as an <span class="type">int</span>).
  </p>


name: MultipleIterator.current
purpose: Gets the registered iterator instances
manual_id: multipleiterator.current
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span> containing the current values of each attached iterator.
  </p>

errors:
<p class="para">
   A <span class="classname">RuntimeException</span> if the iterator is invalid (as of PHP 8.1.0),
   or mode <strong><code>MIT_NEED_ALL</code></strong> is set and at least one attached iterator is
   not valid. Or an <span class="classname">IllegalValueException</span> if a key is <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> and
   <strong><code>MIT_KEYS_ASSOC</code></strong> is set.
  </p>


name: MultipleIterator.key
purpose: Gets the registered iterator instances
manual_id: multipleiterator.key
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: array
return_description: <p class="para"> An <span class="type">array</span> of all registered iterator instances. </p>
errors:
<p class="para">
   A <span class="classname">RuntimeException</span> if the iterator is invalid (as of PHP 8.1.0), or
   mode <strong><code>MIT_NEED_ALL</code></strong> is set, and at least one attached iterator is not valid.
  </p>
  <p class="para">
   Calling this method from <a href="control-structures.foreach.html" class="xref">foreach</a>
   triggers warning &quot;Illegal type returned&quot;.
  </p>


name: MultipleIterator.valid
purpose: Checks the validity of sub iterators
manual_id: multipleiterator.valid
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if one or all sub iterators are valid depending on flags,
   otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: RecursiveArrayIterator.getChildren
purpose: Returns an iterator for the current entry if it is an array or an object
manual_id: recursivearrayiterator.getchildren
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   An iterator for the current entry, if it is an <span class="type">array</span> or <span class="type">object</span>; or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   An <span class="classname">InvalidArgumentException</span>
   will be thrown if the current entry does not contain an <span class="type">array</span> or an <span class="type">object</span>.
  </p>


name: RecursiveArrayIterator.hasChildren
purpose: Returns whether current entry is an array or an object
manual_id: recursivearrayiterator.haschildren
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: object
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the current entry is an <span class="type">array</span> or an <span class="type">object</span>,
   otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: RecursiveCachingIterator.getChildren
purpose: Return the inner iterator's children as a RecursiveCachingIterator
manual_id: recursivecachingiterator.getchildren
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The inner iterator&#039;s children, as a RecursiveCachingIterator; or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if there is no children.
  </p>


name: RecursiveCachingIterator.hasChildren
purpose: Check whether the current element of the inner iterator has children
manual_id: recursivecachingiterator.haschildren
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the inner iterator has children, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: RecursiveCallbackFilterIterator.getChildren
purpose: Return the inner iterator's children contained in a RecursiveCallbackFilterIterator
manual_id: recursivecallbackfilteriterator.getchildren
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: RecursiveCallbackFilterIterator
return_description:
<p class="para">
   Returns a <span class="classname">RecursiveCallbackFilterIterator</span> containing
   the children.
  </p>


name: RecursiveCallbackFilterIterator.hasChildren
purpose: Check whether the inner iterator's current element has children
manual_id: recursivecallbackfilteriterator.haschildren
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the current element has children, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: RecursiveDirectoryIterator.getChildren
purpose: Returns an iterator for the current entry if it is a directory
manual_id: recursivedirectoryiterator.getchildren
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: RecursiveDirectoryIterator
return_description:
<p class="para">
   The filename, file information, or $this depending on the set flags.
   See the <a href="class.filesystemiterator.html#filesystemiterator.constants" class="link">FilesystemIterator
   constants</a>.
  </p>


name: RecursiveDirectoryIterator.hasChildren
purpose: Returns whether current entry is a directory and not '.' or '..'
manual_id: recursivedirectoryiterator.haschildren
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns whether the current entry is a directory, but not &#039;.&#039; or &#039;..&#039;
  </p>


name: RecursiveFilterIterator.getChildren
purpose: Return the inner iterator's children contained in a RecursiveFilterIterator
manual_id: recursivefilteriterator.getchildren
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns a <span class="classname">RecursiveFilterIterator</span> containing the inner iterator&#039;s children.
  </p>


name: RecursiveIteratorIterator.callGetChildren
purpose: Get children
manual_id: recursiveiteratoriterator.callgetchildren
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   A  <span class="methodname">RecursiveIterator</span> on success, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: RecursiveIteratorIterator.getMaxDepth
purpose: Get max depth
manual_id: recursiveiteratoriterator.getmaxdepth
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The maximum accepted depth, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if any depth is allowed.
  </p>


name: RecursiveIteratorIterator.getSubIterator
purpose: The current active sub iterator
manual_id: recursiveiteratoriterator.getsubiterator
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The current active sub iterator on success; <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: RecursiveIteratorIterator.setMaxDepth
purpose: Set max depth
manual_id: recursiveiteratoriterator.setmaxdepth
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Emits an <span class="classname">Exception</span> if <code class="parameter">maxDepth</code> is less than <code class="literal">-1</code>.
  </p>


name: RecursiveIteratorIterator.valid
purpose: Check whether the current position is valid
manual_id: recursiveiteratoriterator.valid
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the current position is valid, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: RecursiveRegexIterator.getChildren
purpose: Returns an iterator for the current entry
manual_id: recursiveregexiterator.getchildren
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: RecursiveRegexIterator
return_description:
<p class="para">
   An iterator for the current entry, if it can be iterated over by the inner iterator.
  </p>

errors:
<p class="para">
   An <span class="classname">InvalidArgumentException</span>
   will be thrown if the current entry does not contain a value that can be iterated over by
   the inner iterator.
  </p>


name: RecursiveRegexIterator.hasChildren
purpose: Returns whether an iterator can be obtained for the current entry
manual_id: recursiveregexiterator.haschildren
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if an iterator can be obtained for the current entry, otherwise returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: RecursiveTreeIterator.callHasChildren
purpose: Has children
manual_id: recursivetreeiterator.callhaschildren
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if there are children, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: RegexIterator.accept
purpose: Get accept status
manual_id: regexiterator.accept
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a match, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: RegexIterator.__construct
purpose: Create a new RegexIterator
manual_id: regexiterator.construct
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
errors:
<p class="para">
   Throws an <span class="classname">InvalidArgumentException</span> if the <code class="parameter">pattern</code> argument is invalid.
  </p>


name: Countable.count
purpose: Count elements of an object
manual_id: countable.count
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The custom count as an <span class="type">int</span>.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    The return value is cast to an <span class="type">int</span>.
   </p>
  </p></blockquote>


name: OuterIterator.getInnerIterator
purpose: Returns the inner iterator for the current entry
manual_id: outeriterator.getinneriterator
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the inner iterator for the current entry if it exists, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> otherwise.
  </p>


name: RecursiveIterator.getChildren
purpose: Returns an iterator for the current entry
manual_id: recursiveiterator.getchildren
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns an iterator for the current entry if it exists, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> otherwise.
  </p>


name: RecursiveIterator.hasChildren
purpose: Returns if an iterator can be created for the current entry
manual_id: recursiveiterator.haschildren
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the current entry can be iterated over, otherwise returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: SeekableIterator.seek
purpose: Seeks to a position
manual_id: seekableiterator.seek
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Implementations should throw an <span class="classname">OutOfBoundsException</span>
   if the <code class="parameter">offset</code> is not seekable.
  </p>


name: class_implements
purpose: Return the interfaces which are implemented by the given class or interface
manual_id: function.class-implements
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An array on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> when the given class doesn&#039;t exist.
  </p>


name: iterator_to_array
purpose: Copy the iterator into an array
manual_id: function.iterator-to-array
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span> containing the elements of the <code class="parameter">iterator</code>.
  </p>


name: spl_autoload_extensions
purpose: Register and return default file extensions for spl_autoload
manual_id: function.spl-autoload-extensions
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A comma delimited list of default file extensions for
   <span class="function">spl_autoload</span>.
  </p>


name: spl_autoload_functions
purpose: Return all registered __autoload() functions
manual_id: function.spl-autoload-functions
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span> of all registered __autoload functions.
   If no function is registered, or the autoload queue is not activated,
   then the return value will be an empty array.
  </p>


name: spl_autoload
purpose: Default implementation for __autoload()
manual_id: function.spl-autoload
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Throws <span class="classname">LogicException</span> when the class is not found
   and there are no other autoloaders registered.
  </p>


name: spl_classes
purpose: Return available SPL classes
manual_id: function.spl-classes
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an <span class="type">array</span> containing the currently available SPL classes.
  </p>


name: spl_object_hash
purpose: Return hash id for given object
manual_id: function.spl-object-hash
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A string that is unique for each currently existing object and is always
   the same for each object.
  </p>


name: SplFileInfo.getATime
purpose: Gets last access time of the file
manual_id: splfileinfo.getatime
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: false
errors: <p class="para"> Throws <span class="classname">RuntimeException</span> on error. </p>
return_description:
<p class="para">
   Returns the time the file was last accessed on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SplFileInfo.getCTime
purpose: Gets the inode change time
manual_id: splfileinfo.getctime
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: false
errors: <p class="para"> Throws <span class="classname">RuntimeException</span> on error. </p>
return_description:
<p class="para">
   The last change time, in a Unix timestamp on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SplFileInfo.getExtension
purpose: Gets the file extension
manual_id: splfileinfo.getextension
version: PHP 5 >= 5.3.6, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
    Returns a <span class="type">string</span> containing the file extension, or an
    empty <span class="type">string</span> if the file has no extension.
  </p>


name: SplFileInfo.getFileInfo
purpose: Gets an SplFileInfo object for the file
manual_id: splfileinfo.getfileinfo
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: SplFileInfo
return_description:
<p class="para">
   An <span class="classname">SplFileInfo</span> object created for the file.
  </p>


name: SplFileInfo.getGroup
purpose: Gets the file group
manual_id: splfileinfo.getgroup
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: false
errors: <p class="para"> Throws <span class="classname">RuntimeException</span> on error. </p>
return_description:
<p class="para">
   The group id in numerical format on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SplFileInfo.getInode
purpose: Gets the inode for the file
manual_id: splfileinfo.getinode
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: false
errors: <p class="para"> Throws <span class="classname">RuntimeException</span> on error. </p>
return_description:
<p class="para">
   Returns the inode number for the filesystem object on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SplFileInfo.getLinkTarget
purpose: Gets the target of a link
manual_id: splfileinfo.getlinktarget
version: PHP 5 >= 5.2.2, PHP 7, PHP 8
return_type: false
errors: <p class="para"> Throws <span class="classname">RuntimeException</span> on error. </p>
return_description:
<p class="para">
   Returns the target of the filesystem link on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SplFileInfo.getMTime
purpose: Gets the last modified time
manual_id: splfileinfo.getmtime
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the last modified time for the file, in a Unix timestamp on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SplFileInfo.getOwner
purpose: Gets the owner of the file
manual_id: splfileinfo.getowner
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: false
errors: <p class="para"> Throws <span class="classname">RuntimeException</span> on error. </p>
return_description:
<p class="para">
   The owner id in numerical format on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SplFileInfo.getPathInfo
purpose: Gets an SplFileInfo object for the path
manual_id: splfileinfo.getpathinfo
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns an <span class="classname">SplFileInfo</span> object for the parent path of the file on success, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: SplFileInfo.getPerms
purpose: Gets file permissions
manual_id: splfileinfo.getperms
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the file permissions on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SplFileInfo.getRealPath
purpose: Gets absolute path to file
manual_id: splfileinfo.getrealpath
version: PHP 5 >= 5.2.2, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the path to the file, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the file does not exist.
  </p>


name: SplFileInfo.getSize
purpose: Gets file size
manual_id: splfileinfo.getsize
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The filesize in bytes on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   A <span class="classname">RuntimeException</span> will be thrown if the file does not exist or an error occurs.
  </p>


name: SplFileInfo.getType
purpose: Gets file type
manual_id: splfileinfo.gettype
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: false
errors: <p class="para"> Throws a <span class="classname">RuntimeException</span> on error. </p>
return_description:
<p class="para">
   A <span class="type">string</span> representing the type of the entry.
   May be one of <code class="literal">file</code>, <code class="literal">link</code>,
   <code class="literal">dir</code>, <code class="literal">block</code>, <code class="literal">fifo</code>,
   <code class="literal">char</code>, <code class="literal">socket</code>, or <code class="literal">unknown</code>, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SplFileInfo.isDir
purpose: Tells if the file is a directory
manual_id: splfileinfo.isdir
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a directory, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SplFileInfo.isExecutable
purpose: Tells if the file is executable
manual_id: splfileinfo.isexecutable
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if executable, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SplFileInfo.isFile
purpose: Tells if the object references a regular file
manual_id: splfileinfo.isfile
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the file exists and is a regular file (not a link), <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SplFileInfo.isLink
purpose: Tells if the file is a link
manual_id: splfileinfo.islink
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the file is a link, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SplFileInfo.isReadable
purpose: Tells if file is readable
manual_id: splfileinfo.isreadable
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if readable, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SplFileInfo.isWritable
purpose: Tells if the entry is writable
manual_id: splfileinfo.iswritable
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if writable, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise;
  </p>


name: SplFileInfo.openFile
purpose: Gets an SplFileObject object for the file
manual_id: splfileinfo.openfile
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: object
return_description:
<p class="para">
   The opened file as an <span class="classname">SplFileObject</span> <span class="type">object</span>.
  </p>

errors:
<p class="para">
   A <span class="classname">RuntimeException</span> if the file cannot be
   opened (e.g. insufficient access rights).
  </p>


name: SplFileObject.__construct
purpose: Construct a new file object
manual_id: splfileobject.construct
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
errors:
<p class="para">
   Throws a <span class="classname">RuntimeException</span> if the <code class="parameter">filename</code> cannot be opened.
  </p>
  <p class="para">
   Throws a <span class="classname">LogicException</span> if the <code class="parameter">filename</code> is a directory.
  </p>


name: SplFileObject.current
purpose: Retrieve current line of file
manual_id: splfileobject.current
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Retrieves the current line of the file. If the <strong><code><a href="class.splfileobject.html#splfileobject.constants.read-csv">SplFileObject::READ_CSV</a></code></strong> flag is set, this method returns an array containing the current line parsed as CSV data.
   If the end of the file is reached, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: SplFileObject.eof
purpose: Reached end of file
manual_id: splfileobject.eof
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if file is at EOF, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SplFileObject.fgetc
purpose: Gets character from file
manual_id: splfileobject.fgetc
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a string containing a single character read from the file or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on EOF.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>


name: SplFileObject.fgetcsv
purpose: Gets line from file and parse as CSV fields
manual_id: splfileobject.fgetcsv
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an indexed array containing the fields read, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    A blank line in a CSV file will be returned as an array
    comprising a single <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> field unless using <strong><code>SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE</code></strong>, 
    in which case empty lines are skipped.
   </p>
  </p></blockquote>


name: SplFileObject.fgets
purpose: Gets line from file
manual_id: splfileobject.fgets
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: string
return_description: <p class="para"> Returns a string containing the next line from the file. </p>
errors:
<p class="para">
   Throws a <span class="classname">RuntimeException</span> if the file cannot be read.
  </p>


name: SplFileObject.fgetss
purpose: Gets line from file and strip HTML tags
manual_id: splfileobject.fgetss
version: PHP 5 >= 5.1.0, PHP 7
return_type: string
return_description:
<p class="para">
   Returns a string containing the next line of the file with HTML and PHP
   code stripped, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: SplFileObject.fpassthru
purpose: Output all remaining data on a file pointer
manual_id: splfileobject.fpassthru
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the number of characters read from <code class="parameter">handle</code>
   and passed through to the output.
  </p>


name: SplFileObject.fputcsv
purpose: Write a field array as a CSV line
manual_id: splfileobject.fputcsv
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the length of the written string or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, and does not write the CSV line to the file, if the
   <code class="parameter">separator</code> or <code class="parameter">enclosure</code>
   parameter is not a single character.
  </p>

errors:
<p class="para">
   An <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error is issued if the
   <code class="parameter">separator</code> or <code class="parameter">enclosure</code>
   parameter is not a single character.
  </p>


name: SplFileObject.fread
purpose: Read from file
manual_id: splfileobject.fread
version: PHP 5 >= 5.5.11, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the string read from the file  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SplFileObject.fscanf
purpose: Parses input from file according to a format
manual_id: splfileobject.fscanf
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   If only one parameter is passed to this method, the values parsed will be
   returned as an array. Otherwise, if optional parameters are passed, the
   function will return the number of assigned values. The optional
   parameters must be passed by reference.
  </p>


name: SplFileObject.fseek
purpose: Seek to a position
manual_id: splfileobject.fseek
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns 0 if the seek was successful, -1 otherwise. Note that seeking
   past EOF is not considered an error.
  </p>


name: SplFileObject.fstat
purpose: Gets information about the file
manual_id: splfileobject.fstat
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array with the statistics of the file; the format of the array
   is described in detail on the <span class="function">stat</span> manual page.
  </p>


name: SplFileObject.ftell
purpose: Return current file position
manual_id: splfileobject.ftell
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
    Returns the position of the file pointer as an integer, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: SplFileObject.getChildren
purpose: No purpose
manual_id: splfileobject.getchildren
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>


name: SplFileObject.getCsvControl
purpose: Get the delimiter, enclosure and escape character for CSV
manual_id: splfileobject.getcsvcontrol
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an indexed array containing the delimiter, enclosure and escape character.
  </p>


name: SplFileObject.getMaxLineLen
purpose: Get maximum line length
manual_id: splfileobject.getmaxlinelen
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the maximum line length if one has been set with
    <span class="methodname">SplFileObject::setMaxLineLen</span>, default is <code class="literal">0</code>.
  </p>


name: SplFileObject.hasChildren
purpose: SplFileObject does not have children
manual_id: splfileobject.haschildren
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: SplFileObject.rewind
purpose: Rewind the file to the first line
manual_id: splfileobject.rewind
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Throws a <span class="classname">RuntimeException</span> if cannot be rewound.
  </p>


name: SplFileObject.seek
purpose: Seek to specified line
manual_id: splfileobject.seek
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Throws a <span class="classname">LogicException</span> if the 
   <code class="parameter">line</code> is negative.
  </p>


name: SplFileObject.setMaxLineLen
purpose: Set maximum line length
manual_id: splfileobject.setmaxlinelen
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Throws <span class="classname">DomainException</span> when
   <code class="parameter">maxLength</code> is less than zero.
  </p>


name: SplFileObject.valid
purpose: Not at EOF
manual_id: splfileobject.valid
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if not reached EOF, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SplTempFileObject.__construct
purpose: Construct a new temporary file object
manual_id: spltempfileobject.construct
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
errors:
<p class="para">
   Throws a <span class="classname">RuntimeException</span> if an error occurs.
  </p>


name: ArrayObject.count
purpose: Get the number of public properties in the ArrayObject
manual_id: arrayobject.count
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The number of public properties in the <span class="classname">ArrayObject</span>.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    When the <span class="classname">ArrayObject</span> is constructed from an array all properties are public.
   </p>
  </p></blockquote>


name: ArrayObject.getArrayCopy
purpose: Creates a copy of the ArrayObject
manual_id: arrayobject.getarraycopy
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns a copy of the array. When the <span class="classname">ArrayObject</span> refers to an object,
   an array of the properties of that object will be returned.
  </p>


name: ArrayObject.getIteratorClass
purpose: Gets the iterator classname for the ArrayObject
manual_id: arrayobject.getiteratorclass
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the iterator class name that is used to iterate over this object.
  </p>


name: ArrayObject.offsetExists
purpose: Returns whether the requested index exists
manual_id: arrayobject.offsetexists
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the requested index exists, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ArrayObject.offsetGet
purpose: Returns the value at the specified index
manual_id: arrayobject.offsetget
version: PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   The value at the specified index or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>

errors:
<p class="para">
   Produces an <strong><code><a href="errorfunc.constants.html#constant.e-notice">E_NOTICE</a></code></strong> error message when the specified
   index does not exist.
  </p>


name: ArrayObject.serialize
purpose: Serialize an ArrayObject
manual_id: arrayobject.serialize
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The serialized representation of the <span class="classname">ArrayObject</span>.
  </p>


name: php_user_filter.filter
purpose: Called when applying the filter
manual_id: php-user-filter.filter
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The  <span class="methodname">filter</span> method must return one of
   three values upon completion.
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Return Value</th>
       <th>Meaning</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><strong><code><a href="stream.constants.html#constant.psfs-pass-on">PSFS_PASS_ON</a></code></strong></td>
       <td>
        Filter processed successfully with data available in the
        <code class="parameter">out</code> <code class="literal">bucket brigade</code>.
       </td>
      </tr>

      <tr>
       <td><strong><code><a href="stream.constants.html#constant.psfs-feed-me">PSFS_FEED_ME</a></code></strong></td>
       <td>
        Filter processed successfully, however no data was available to
        return. More data is required from the stream or prior filter.
       </td>
      </tr>

      <tr>
       <td><strong><code><a href="stream.constants.html#constant.psfs-err-fatal">PSFS_ERR_FATAL</a></code></strong> (default)</td>
       <td>
        The filter experienced an unrecoverable error and cannot continue.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: php_user_filter.onCreate
purpose: Called when creating the filter
manual_id: php-user-filter.oncreate
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Your implementation of
   this method should return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure, or <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success.
  </p>


name: streamWrapper.dir_readdir
purpose: Read entry from directory handle
manual_id: streamwrapper.dir-readdir
version: PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Should return <span class="type">string</span> representing the next filename, or
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there is no next file.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    The return value will be casted to <span class="type">string</span>.
   </p>
  </p></blockquote>

errors:
<p class="para">Emits
<strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> if call to this method fails
(i.e. not implemented).</p>


name: streamWrapper.stream_cast
purpose: Retrieve the underlaying resource
manual_id: streamwrapper.stream-cast
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: resource
return_description:
<p class="para">
   Should return the underlying stream resource used by the wrapper, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: streamWrapper.stream_eof
purpose: Tests for end-of-file on a file pointer
manual_id: streamwrapper.stream-eof
version: PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Should return <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the read/write position is at the end of the stream and if no more data is available to be read, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: streamWrapper.stream_flush
purpose: Flushes the output
manual_id: streamwrapper.stream-flush
version: PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Should return <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the cached data was successfully stored (or
   if there was no data to store), or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the data could
   not be stored.
  </p>


name: streamWrapper.stream_lock
purpose: Advisory file locking
manual_id: streamwrapper.stream-lock
version: PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   Emits <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> if call to this method fails (i.e. not implemented).
  </p>


name: streamWrapper.stream_metadata
purpose: Change stream metadata
manual_id: streamwrapper.stream-metadata
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   If <code class="parameter">option</code> is not implemented, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> should be
   returned.
  </p>


name: streamWrapper.stream_read
purpose: Read from stream
manual_id: streamwrapper.stream-read
version: PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   If there are less than <code class="parameter">count</code>
   bytes available, as many as are available should be returned.
   If no more data is available, an empty string should be returned.
   To signal that reading failed, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> should be returned.
  </p>

errors:
<p class="para">Emits
<strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> if call to this method fails
(i.e. not implemented).</p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    If the return value is longer then <code class="parameter">count</code> an
    <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> error will be emitted, and excess data will be
    lost.
   </p>
  </p></blockquote>


name: streamWrapper.stream_seek
purpose: Seeks to specific location in a stream
manual_id: streamwrapper.stream-seek
version: PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Return <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the position was updated, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: streamWrapper.stream_write
purpose: Write to stream
manual_id: streamwrapper.stream-write
version: PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Should return the number of bytes that were successfully stored, or 0 if
   none could be stored.
  </p>

errors:
<p class="para">Emits
<strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> if call to this method fails
(i.e. not implemented).</p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    If the return value is greater the length of
    <code class="parameter">data</code>, <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> will be
    emitted and the return value will truncated to its length.
   </p>
  </p></blockquote>


name: streamWrapper.url_stat
purpose: Retrieve information about a file
manual_id: streamwrapper.url-stat
version: PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Should return an <span class="type">array</span> with the same elements as <span class="function">stat</span> does.
   Unknown or unavailable values should be set to a rational value
   (usually <code class="literal">0</code>). Special attention should be payed to
   <code class="literal">mode</code> as documented under <span class="function">stat</span>.
   Should return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: stream_bucket_make_writeable
purpose: Returns a bucket object from the brigade to operate on
manual_id: function.stream-bucket-make-writeable
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns a bucket object with the properties listed below or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
   <dl>
    
     <dt>
      <span class="property">data</span>
      (<span class="type">string</span>)
     </dt>
     <dd>
      <p class="para">
       <code class="parameter">data</code> <code class="literal">bucket</code> The current string in the bucket.
      </p>
     </dd>
    
    
     <dt>
      <span class="property">datalen</span>
      (<span class="type">integer</span>)
     </dt>
     <dd>
      <p class="para">
       <code class="parameter">datalen</code> <code class="literal">bucket</code> The length of the string in the bucket.
      </p>
     </dd>
    
   </dl>
  </p>


name: stream_context_get_params
purpose: Retrieves parameters from a context
manual_id: function.stream-context-get-params
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an associate array containing all context options and parameters.
  </p>


name: stream_copy_to_stream
purpose: Copies data from one stream to another
manual_id: function.stream-copy-to-stream
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the total count of bytes copied, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: stream_filter_append
purpose: Attach a filter to a stream
manual_id: function.stream-filter-append
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: resource
return_description:
<p class="para">
   Returns a resource on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. The resource can be
   used to refer to this filter instance during a call to
   <span class="function">stream_filter_remove</span>.
  </p>

  <p class="para">
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned if <code class="parameter">stream</code> is not a resource or
   if <code class="parameter">filtername</code> cannot be located.
  </p>


name: stream_filter_register
purpose: Register a user defined stream filter
manual_id: function.stream-filter-register
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   <span class="function">stream_filter_register</span> will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the
   <code class="parameter">filter_name</code> is already defined.
  </p>


name: stream_get_contents
purpose: Reads remainder of a stream into a string
manual_id: function.stream-get-contents
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a string or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: stream_get_filters
purpose: Retrieve list of registered filters
manual_id: function.stream-get-filters
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an indexed array containing the name of all stream filters
   available.
  </p>


name: stream_get_line
purpose: Gets line from stream resource up to a given delimiter
manual_id: function.stream-get-line
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a string of up to <code class="parameter">length</code> bytes read from the file
   pointed to by <code class="parameter">stream</code>, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: stream_get_meta_data
purpose: Retrieves header/meta data from streams/file pointers
manual_id: function.stream-get-meta-data
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   The result array contains the following items:
  </p>
  <ul class="itemizedlist">
   <li class="listitem">
    <p class="para">
     <code class="literal">timed_out</code> (bool) - <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the stream
     timed out while waiting for data on the last call to
     <span class="function">fread</span> or <span class="function">fgets</span>.
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <code class="literal">blocked</code> (bool) - <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the stream is
     in blocking IO mode. See <span class="function">stream_set_blocking</span>.
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <code class="literal">eof</code> (bool) - <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the stream has reached
     end-of-file.  Note that for socket streams this member can be <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
     even when <code class="literal">unread_bytes</code> is non-zero.  To
     determine if there is more data to be read, use
     <span class="function">feof</span> instead of reading this item.
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <code class="literal">unread_bytes</code> (int) - the number of bytes
     currently contained in the PHP&#039;s own internal buffer.
    </p>
    <blockquote class="note"><p><strong class="note">Note</strong>: 
     <span class="simpara">
      You shouldn&#039;t use this value in a script.
     </span>
    </p></blockquote>
   </li>
   <li class="listitem">
    <p class="para">
     <code class="literal">stream_type</code> (string) - a label describing
     the underlying implementation of the stream.
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <code class="literal">wrapper_type</code> (string) - a label describing
     the protocol wrapper implementation layered over the stream.
     See <a href="wrappers.html" class="xref">Supported Protocols and Wrappers</a> for more information about wrappers.
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <code class="literal">wrapper_data</code> (mixed) - wrapper specific
     data attached to this stream.  See <a href="wrappers.html" class="xref">Supported Protocols and Wrappers</a> for
     more information about wrappers and their wrapper data.
    </p>
   </li>
   
   <li class="listitem">
    <p class="para">
     <code class="literal">mode</code> (string) - the type of access required for
     this stream (see Table 1 of the <a href="function.fopen.html" class="link">fopen()</a> reference)
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <code class="literal">seekable</code> (bool) - whether the current stream can
     be seeked.
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <code class="literal">uri</code> (string) - the URI/filename associated with this
     stream.
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <code class="literal">crypto</code> (array) - the TLS connection metadata for this
     stream. (Note: Only provided when the resource&#039;s stream uses TLS.)
    </p>
   </li>
  </ul>


name: stream_get_wrappers
purpose: Retrieve list of registered streams
manual_id: function.stream-get-wrappers
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an indexed array containing the name of all stream wrappers
   available on the running system.
  </p>


name: stream_resolve_include_path
purpose: Resolve filename against the include path
manual_id: function.stream-resolve-include-path
version: PHP 5 >= 5.3.2, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a <span class="type">string</span> containing the resolved absolute filename,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: stream_select
manual_id: function.stream-select
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
purpose:
Runs the equivalent of the select() system call on the given   arrays of streams with a timeout specified by seconds and microseconds

return_description:
<p class="para">
   On success <span class="function">stream_select</span> returns the number of
   stream resources contained in the modified arrays, which may be zero if
   the timeout expires before anything interesting happens. On error <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   is returned and a warning raised (this can happen if the system call is
   interrupted by an incoming signal).
  </p>


name: stream_set_chunk_size
purpose: Set the stream chunk size
manual_id: function.stream-set-chunk-size
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: int
return_description: <p class="para"> Returns the previous chunk size on success. </p>
errors:
<p class="para">
   A <span class="classname">ValueError</span> is thrown if <code class="parameter">size</code>
   is less than 1 or greater than <strong><code><a href="reserved.constants.html#constant.php-int-max">PHP_INT_MAX</a></code></strong>.
  </p>


name: stream_set_read_buffer
purpose: Set read file buffering on the given stream
manual_id: function.stream-set-read-buffer
version: PHP 5 >= 5.3.3, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns 0 on success, or another value if the request
   cannot be honored.
  </p>


name: stream_socket_accept
purpose: Accept a connection on a socket created by stream_socket_server
manual_id: function.stream-socket-accept
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a stream to the accepted socket connection or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: stream_socket_client
purpose: Open Internet or Unix domain socket connection
manual_id: function.stream-socket-client
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   On success a stream resource is returned which may
   be used together with the other file functions (such as
   <span class="function">fgets</span>, <span class="function">fgetss</span>,
   <span class="function">fwrite</span>, <span class="function">fclose</span>, and
   <span class="function">feof</span>), <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   On failure the <code class="parameter">error_code</code> and
   <code class="parameter">error_message</code> arguments will be populated with the actual
   system level error that occurred in the system-level
   <code class="literal">connect()</code> call. If the value returned in
   <code class="parameter">error_code</code> is <code class="literal">0</code> and the
   function returned <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, it is an indication that the error
   occurred before the <code class="literal">connect()</code> call. This is
   most likely due to a problem initializing the socket. Note that
   the <code class="parameter">error_code</code> and
   <code class="parameter">error_message</code> arguments will always be passed by
   reference.
  </p>


name: stream_socket_enable_crypto
purpose: Turns encryption on/off on an already connected socket
manual_id: function.stream-socket-enable-crypto
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if negotiation has failed or
   <code class="literal">0</code> if there isn&#039;t enough data and you should try again
   (only for non-blocking sockets).
  </p>


name: stream_socket_get_name
purpose: Retrieve the name of the local or remote sockets
manual_id: function.stream-socket-get-name
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The name of the socket, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: stream_socket_pair
purpose: Creates a pair of connected, indistinguishable socket streams
manual_id: function.stream-socket-pair
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="type">array</span> with the two socket resources on success, or
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: stream_socket_recvfrom
purpose: Receives data from a socket, connected or not
manual_id: function.stream-socket-recvfrom
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the read data, as a string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: stream_socket_sendto
purpose: Sends a message to a socket, whether it is connected or not
manual_id: function.stream-socket-sendto
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a result code, as an integer, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: stream_socket_server
purpose: Create an Internet or Unix domain server socket
manual_id: function.stream-socket-server
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the created stream, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: stream_wrapper_register
purpose: Register a URL wrapper implemented as a PHP class
manual_id: function.stream-wrapper-register
version: PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   <span class="function">stream_wrapper_register</span> will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the
   <code class="parameter">protocol</code> already has a handler.
  </p>


name: Swoole\Buffer.append
manual_id: swoole-buffer.append
version: PECL swoole >= 1.9.0
return_type: int
return_description: <p class="para"> The new size of the memory buffer. </p>
purpose:
Append the string or binary data at the end of the memory buffer and return the new size of memory allocated.


name: Swoole\Channel.pop
purpose: Read and pop data from swoole channel.
manual_id: swoole-channel.pop
version: PECL swoole >= 1.9.0
return_type: mixed
return_description:
<p class="para">
    If the channel is empty, the function will return false, or return the unserialized data.
  </p>


name: Swoole\Client.send
purpose: Send data to the remote TCP socket.
manual_id: swoole-client.send
version: PECL swoole >= 1.9.0
return_type: int
return_description:
<p class="para">
   If the client sends data successfully, it returns the length of data sent. 
   Or it returns false and sets $swoole_client-&gt;errCode. For sync client, 
   there is no limit for the data to send. For async client, The limit 
   for the data to send is socket_buffer_size. 
  </p>


name: Swoole\Process.signal
purpose: Send signal to the child processes.
manual_id: swoole-process.signal
version: PECL swoole >= 1.9.0
return_type: void
return_description:
<p class="para">
   If signal sent successfully, it returns TRUE, otherwise it returns FALSE.
  </p>


name: tidy.body
purpose: Returns a tidyNode object starting from the <body> tag of the tidy parse tree
manual_id: tidy.body
return_type: null
return_description:
<p class="para">
   Returns a <span class="classname">tidyNode</span> object starting from the 
   &lt;body&gt; tag of the tidy parse tree.
  </p>


name: tidy.$errorBuffer
purpose: Return warnings and errors which occurred parsing the specified document
manual_id: tidy.props.errorbuffer
return_type: false
return_description:
<p class="para">
   Returns the error buffer as a string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the buffer is empty.
  </p>


name: tidy.getConfig
purpose: Get current Tidy configuration
manual_id: tidy.getconfig
return_type: array
return_description:
<p class="para">
   Returns an array of configuration options.
  </p>
  <p class="para">
   For an explanation about each option, visit <a href="http://api.html-tidy.org/#quick-reference" class="link external">&raquo;&nbsp;http://api.html-tidy.org/#quick-reference</a>.
  </p>


name: tidy.getHtmlVer
purpose: Get the Detected HTML version for the specified document
manual_id: tidy.gethtmlver
return_type: int
return_description:
<p class="para">
   Returns the detected HTML version.
  </p>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="para">
    This function is not yet implemented in the Tidylib itself, so it always
    return <code class="literal">0</code>.
   </p>
  </div>


name: tidy.getOpt
purpose: Returns the value of the specified configuration option for the tidy document
manual_id: tidy.getopt
version: PHP 5, PHP 7, PHP 8, PECL tidy >= 0.5.2
return_type: bool
return_description:
<p class="para">
   Returns the value of the specified <code class="parameter">option</code>.
   The return type depends on the type of the specified one. 
  </p>


name: tidy.getOptDoc
purpose: Returns the documentation for the given option name
manual_id: tidy.getoptdoc
return_type: false
return_description:
<p class="para">
   Returns a string if the option exists and has documentation available, or
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: tidy.getRelease
purpose: Get release date (version) for Tidy library
manual_id: tidy.getrelease
return_type: string
return_description:
<p class="para">
   Returns a string with the release date of the Tidy library,
   which may be <code class="code">&#039;unknown&#039;</code>.
  </p>


name: tidy.getStatus
purpose: Get status of specified document
manual_id: tidy.getstatus
return_type: int
return_description:
<p class="para">
   Returns 0 if no error/warning was raised, 1 for warnings or accessibility
   errors, or 2 for errors.
  </p>


name: tidy.isXhtml
purpose: Indicates if the document is a XHTML document
manual_id: tidy.isxhtml
return_type: bool
return_description:
<p class="para">
   This function returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the specified tidy
   <code class="parameter">tidy</code> is a XHTML document, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="para">
    This function is not yet implemented in the Tidylib itself, so it always
    return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
   </p>
  </div>


name: tidy.isXml
purpose: Indicates if the document is a generic (non HTML/XHTML) XML document
manual_id: tidy.isxml
return_type: bool
return_description:
<p class="para">
   This function returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the specified tidy
   <code class="parameter">tidy</code> is a generic XML document (non HTML/XHTML),
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="para">
    This function is not yet implemented in the Tidylib itself, so it always
    return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
   </p>
  </div>


name: tidy.parseFile
purpose: Parse markup in file or URI
manual_id: tidy.parsefile
return_type: false
return_description:
<p class="para">
    <span class="methodname">tidy::parseFile</span> returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success.
   <span class="function">tidy_parse_file</span> returns a new <span class="classname">tidy</span>
   instance on success.
   Both, the method and the function return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: tidy.parseString
purpose: Parse a document stored in a string
manual_id: tidy.parsestring
return_type: false
return_description:
<p class="para">
    <span class="methodname">tidy::parseString</span> returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success.
   <span class="function">tidy_parse_string</span> returns a new <span class="classname">tidy</span>
   instance on success.
   Both, the method and the function return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: tidy.repairFile
purpose: Repair a file and return it as a string
manual_id: tidy.repairfile
return_type: false
return_description:
<p class="para">
   Returns the repaired contents as a string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: tidy.repairString
purpose: Repair a string using an optionally provided configuration file
manual_id: tidy.repairstring
return_type: false
return_description:
<p class="para">
   Returns the repaired string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: tidyNode.getParent
purpose: Returns the parent node of the current node
manual_id: tidynode.getparent
version: PHP 5 >= 5.2.2, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns a <span class="type">tidyNode</span> if the node has a parent, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
   otherwise.
  </p>


name: tidyNode.hasChildren
purpose: Checks if a node has children
manual_id: tidynode.haschildren
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the node has children, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: tidyNode.hasSiblings
purpose: Checks if a node has siblings
manual_id: tidynode.hassiblings
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the node has siblings, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: tidyNode.isAsp
purpose: Checks if this node is ASP
manual_id: tidynode.isasp
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the node is ASP, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: tidyNode.isComment
purpose: Checks if a node represents a comment
manual_id: tidynode.iscomment
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the node is a comment, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: tidyNode.isHtml
purpose: Checks if a node is an element node
manual_id: tidynode.ishtml
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the node is an element node, but not the root node of the document, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: tidyNode.isJste
purpose: Checks if this node is JSTE
manual_id: tidynode.isjste
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the node is JSTE, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: tidyNode.isPhp
purpose: Checks if a node is PHP
manual_id: tidynode.isphp
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the current node is PHP code, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: tidyNode.isText
purpose: Checks if a node represents text (no markup)
manual_id: tidynode.istext
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the node represent a text, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: PhpToken.getTokenName
purpose: Returns the name of the token.
manual_id: phptoken.gettokenname
version: PHP 8
return_type: null
return_description:
<p class="para">
   An ASCII character for single-char tokens,
   or one of T_* constant names for known tokens (see <a href="tokens.html" class="xref">List of Parser Tokens</a>),
   or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> for unknown tokens.
  </p>


name: PhpToken.isIgnorable
purpose: Tells whether the token would be ignored by the PHP parser.
manual_id: phptoken.isignorable
version: PHP 8
return_type: bool
return_description:
<p class="para">
   A boolean value whether the token would be ignored by the PHP parser (such as whitespace or comments).
  </p>


name: PhpToken.tokenize
purpose: Splits given source into PHP tokens, represented by PhpToken objects.
manual_id: phptoken.tokenize
version: PHP 8
return_type: array
return_description:
<p class="para">
   An array of PHP tokens represented by instances of PhpToken or its descendants.
   This method returns <span class="type">static[]</span> so that PhpToken can be seamlessly extended.
  </p>


name: token_get_all
purpose: Split given source into PHP tokens
manual_id: function.token-get-all
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An array of token identifiers. Each individual token identifier is either
   a single character (i.e.: <code class="literal">;</code>, <code class="literal">.</code>, 
   <code class="literal">&gt;</code>, <code class="literal">!</code>, etc...),
   or a three element array containing the token index in element 0, the string
   content of the original token in element 1 and the line number in element 2.
  </p>


name: base64_decode
purpose: Decodes data encoded with MIME base64
manual_id: function.base64-decode
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the decoded data or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. The returned data may be
   binary.
  </p>


name: get_headers
purpose: Fetches all the headers sent by the server in response to an HTTP request
manual_id: function.get-headers
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an indexed or associative array with the headers, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   failure.
  </p>


name: get_meta_tags
purpose: Extracts all meta tag content attributes from a file and returns an array
manual_id: function.get-meta-tags
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array with all the parsed meta tags.
  </p>
  <p class="para">
   The value of the name property becomes the key, the value of the content
   property becomes the value of the returned array, so you can easily use
   standard array functions to traverse it or access single values. 
   Special characters in the value of the name property are substituted with
   &#039;_&#039;, the rest is converted to lower case.  If two meta tags have the same
   name, only the last one is returned.
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: parse_url
purpose: Parse a URL and return its components
manual_id: function.parse-url
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   On seriously malformed URLs, <span class="function">parse_url</span> may return
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>
  <p class="para">
   If the <code class="parameter">component</code> parameter is omitted, an
   associative <span class="type">array</span> is returned. At least one element will be
   present within the array. Potential keys within this array are:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      <var class="varname">scheme</var> - e.g. http
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <var class="varname">host</var> 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <var class="varname">port</var>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <var class="varname">user</var>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <var class="varname">pass</var>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <var class="varname">path</var>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <var class="varname">query</var> - after the question mark <code class="literal">?</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <var class="varname">fragment</var> - after the hashmark <code class="literal">#</code>
     </span>
    </li>
   </ul>
  </p>
  <p class="para">
   If the <code class="parameter">component</code> parameter is specified,
   <span class="function">parse_url</span> returns a <span class="type">string</span> (or an
   <span class="type">int</span>, in the case of <strong><code><a href="url.constants.html#constant.php-url-port">PHP_URL_PORT</a></code></strong>)
   instead of an <span class="type">array</span>. If the requested component doesn&#039;t exist
   within the given URL, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> will be returned.
   As of PHP 8.0.0, <span class="function">parse_url</span> distinguishes absent and empty
   queries and fragments:
  </p>
  <p class="para">
   <div class="informalexample">
    <div class="example-contents screen">
<div class="cdata"><pre>
http://example.com/foo → query = null, fragment = null
http://example.com/foo? → query = &quot;&quot;,   fragment = null
http://example.com/foo# → query = null, fragment = &quot;&quot;
http://example.com/foo?# → query = &quot;&quot;,   fragment = &quot;&quot;
</pre></div>
    </div>
   </div>
  </p>
  <p class="para">
    Previously all cases resulted in query and fragment being <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>
  <p class="para">
   Note that control characters (cf. <span class="function">ctype_cntrl</span>) in the
   components are replaced with underscores (<code class="literal">_</code>).
  </p>


name: rawurlencode
purpose: URL-encode according to RFC 3986
manual_id: function.rawurlencode
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns a string in which all non-alphanumeric characters except
   <code class="literal">-_.~</code> have been replaced with a percent
   (<code class="literal">%</code>) sign followed by two hex digits.  This is the
   encoding described in <a href="http://www.faqs.org/rfcs/rfc3986" class="link external">&raquo;&nbsp;RFC 3986</a> for
   protecting literal characters from being interpreted as special URL
   delimiters, and for protecting URLs from being mangled by transmission
   media with character conversions (like some email systems).
  </p>


name: urlencode
purpose: URL-encodes string
manual_id: function.urlencode
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns a string in which all non-alphanumeric characters except
   <code class="literal">-_.</code> have been replaced with a percent
   (<code class="literal">%</code>) sign followed by two hex digits and spaces encoded
   as plus (<code class="literal">+</code>) signs.  It is encoded the same way that the
   posted data from a WWW form is encoded, that is the same way as in
   <code class="literal">application/x-www-form-urlencoded</code> media type. This
   differs from the <a href="http://www.faqs.org/rfcs/rfc3986" class="link external">&raquo;&nbsp;RFC 3986</a> encoding (see
   <span class="function">rawurlencode</span>) in that for historical reasons, spaces
   are encoded as plus (+) signs.
  </p>


name: V8Js.executeString
purpose: Execute a string as Javascript code
manual_id: v8js.executestring
version: PECL v8js >= 0.1.0
return_type: mixed
return_description:
<p class="para">
   Returns the last variable instantiated in the Javascript code converted to matching PHP variable type.
  </p>


name: V8Js.getExtensions
purpose: Return an array of registered extensions
manual_id: v8js.getextensions
version: PECL v8js >= 0.1.0
return_type: array
return_description:
<p class="para">
   Returns an array of registered extensions or an empty array if there are none.
  </p>


name: V8Js.getPendingException
purpose: Return pending uncaught Javascript exception
manual_id: v8js.getpendingexception
version: PECL v8js >= 0.1.0
return_type: V8JsException
return_description:
<p class="para">
   Either <span class="classname">V8JsException</span> or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>


name: V8Js.registerExtension
purpose: Register Javascript extensions for V8Js
manual_id: v8js.registerextension
version: PECL v8js >= 0.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if extension was registered successfully, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: yaml_emit_file
purpose: Send the YAML representation of a value to a file
manual_id: function.yaml-emit-file
version: PECL yaml >= 0.5.0
return_type: bool
return_description:
<p class="para">
  Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success.
  </p>


name: yaml_parse_file
purpose: Parse a YAML stream from a file
manual_id: function.yaml-parse-file
version: PECL yaml >= 0.4.0
return_type: mixed
return_description:
<p class="para">
   Returns the value encoded in <code class="parameter">input</code> in appropriate
   PHP type or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. If <code class="parameter">pos</code> is <code class="literal">-1</code> an
   <span class="type">array</span> will be returned with one entry for each document found
   in the stream.
  </p>


name: yaml_parse_url
purpose: Parse a Yaml stream from a URL
manual_id: function.yaml-parse-url
version: PECL yaml >= 0.4.0
return_type: mixed
return_description:
<p class="para">
   Returns the value encoded in <code class="parameter">input</code> in appropriate
   PHP type or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. If <code class="parameter">pos</code> is
   <code class="literal">-1</code> an <span class="type">array</span> will be returned with one entry
   for each document found in the stream.
  </p>


name: Yaf_Application.app
purpose: Retrieve an Application instance
manual_id: yaf-application.app
version: Yaf >=1.0.0
return_type: mixed
return_description:
<p class="para">
   A Yaf_Application instance, if no Yaf_Application was initialized before,
   <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> will be returned.
  </p>


name: Yaf_Dispatcher.getDefaultAction
purpose: Retrive the default action name
manual_id: yaf-dispatcher.getdefaultaction
version: Yaf >=3.2.0
return_type: string
return_description:
<p class="para">
   <span class="type">string</span>, default action name, default is &quot;index&quot;
  </p>


name: Yaf_Dispatcher.getDefaultController
purpose: Retrive the default controller name
manual_id: yaf-dispatcher.getdefaultcontroller
version: Yaf >=3.2.0
return_type: string
return_description:
<p class="para">
   <span class="type">string</span>, default controller name, default is &quot;Index&quot;
  </p>


name: Yaf_Dispatcher.getDefaultModule
purpose: Retrive the default module name
manual_id: yaf-dispatcher.getdefaultmodule
version: Yaf >=3.2.0
return_type: string
return_description:
<p class="para">
   <span class="type">string</span>, module name, default is &quot;Index&quot;
  </p>


name: Yaf_Loader.getNamespacePath
purpose: Retieve path of a registered namespace
manual_id: yaf-loader.getnamespacepath
version: Yaf >=3.2.0
return_type: string
return_description:
<p class="para">
   <span class="type">string</span> path, if the namespace is not registered, then <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> default library will be returned
  </p>


name: Yaf_Request_Simple.isXmlHttpRequest
purpose: Determin if request is AJAX request
manual_id: yaf-request-simple.isxmlhttprequest
version: Yaf >=1.0.0
return_type: void
return_description:
<p class="para">
   Always returns false for <span class="classname">Yaf_Request_Simple</span>
  </p>


name: Yaf_Route_Map.assemble
purpose: Assemble a url
manual_id: yaf-route-map.assemble
version: Yaf >=2.3.0
return_type: string
errors: <p class="para"> May throw <span class="classname">Yaf_Exception_TypeError</span>. </p>
return_description:
<p class="para">
   Returns <span class="type">string</span> on success or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: Yaf_Route_Regex.route
purpose: The route purpose
manual_id: yaf-route-regex.route
version: Yaf >=1.0.0
return_type: bool
return_description:
<p class="para">
   If the pattern given by the first parameter of 
    <span class="methodname">Yaf_Route_Regex::_construct</span> matche the request
   uri, return <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, otherwise return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: Yaf_Router.addConfig
purpose: Add config-defined routes into Router
manual_id: yaf-router.addconfig
version: Yaf >=1.0.0
return_type: bool
return_description:
<p class="para">
     An <span class="classname">Yaf_Config_Abstract</span> instance, which should
     contains one or more valid route configs
  </p>


name: Yaf_Route_Simple.assemble
purpose: Assemble a url
manual_id: yaf-route-simple.assemble
version: Yaf >=2.3.0
return_type: string
return_description: <p class="para"> Returns a <span class="type">string</span>. </p>
errors:
<p class="para">
   Throws <span class="classname">Yaf_Exception_TypeError</span> if <code class="parameter">info</code> 
   keys <code class="literal">&#039;:c&#039;</code> or <code class="literal">&#039;:a&#039;</code> are not set.
  </p>


name: Yaf_Route_Simple.__construct
purpose: Yaf_Route_Simple constructor
manual_id: yaf-route-simple.construct
version: Yaf >=1.0.0
return_description:
<p class="para">
   Always return <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.
  </p>


name: Yaf_Route_Simple.route
purpose: Route a request
manual_id: yaf-route-simple.route
version: Yaf >=1.0.0
return_type: bool
return_description:
<p class="para">
   always be <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
  </p>


name: Yaf_Route_Static.assemble
purpose: Assemble a url
manual_id: yaf-route-static.assemble
version: Yaf >=2.3.0
return_type: string
return_description: <p class="para"> Returns a <span class="type">string</span>. </p>
errors:
<p class="para">
   Throws <span class="classname">Yaf_Exception_TypeError</span> if <code class="parameter">info</code> 
   keys <code class="literal">&#039;:c&#039;</code> and <code class="literal">&#039;:a&#039;</code> are not set.
  </p>


name: Yaf_Route_Supervar.route
purpose: The route purpose
manual_id: yaf-route-supervar.route
version: Yaf >=1.0.0
return_type: bool
return_description:
<p class="para">
    If there is a key(which was defined in
     <span class="methodname">Yaf_Route_Supervar::__construct</span>) in $_GET, return <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.
    otherwise return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: Yaconf.get
purpose: Retrieve a item
manual_id: yaconf.get
version: PECL yaconf >= 1.0.0
return_type: mixed
return_description:
<p class="para">
   Returns configuration result(string or array) if the key exists,
   return default_value if not.
  </p>


name: taint
purpose: Taint a string
manual_id: function.taint
version: PECL taint >=0.1.0
return_type: bool
return_description:
<p class="para">
      Return TRUE if the transformation is done. Always return TRUE if the taint
      extension is not enabled.    
  </p>


name: Ds\Collection.isEmpty
purpose: Returns whether the collection is empty
manual_id: ds-collection.isempty
version: PECL ds >= 1.0.0
return_type: bool
return_description:
<p class="para">
    Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the collection is empty, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Ds\Collection.toArray
purpose: Converts the collection to an array
manual_id: ds-collection.toarray
version: PECL ds >= 1.0.0
return_type: array
return_description:
<p class="para">
    An <span class="type">array</span> containing all the values in the same order as the collection.
  </p>


name: Ds\Hashable.equals
purpose: Determines whether an object is equal to the current instance
manual_id: ds-hashable.equals
version: PECL ds >= 1.0.0
return_type: bool
return_description:
<p class="para">
    <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if equal, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Ds\Sequence.contains
purpose: Determines if the sequence contains given values
manual_id: ds-sequence.contains
version: PECL ds >= 1.0.0
return_type: bool
return_description:
<p class="para">
    <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if any of the provided <code class="parameter">values</code> are not in the
    sequence, <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> otherwise.
  </p>


name: Ds\Sequence.filter
purpose: Creates a new sequence using a callable to determine which values to include
manual_id: ds-sequence.filter
version: PECL ds >= 1.0.0
return_type: callable
return_description:
<p class="para">
    A new sequence containing all the values for which
    either the <code class="parameter">callback</code> returned <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, or all values that
    convert to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a <code class="parameter">callback</code> was not provided.
  </p>


name: Ds\Sequence.find
purpose: Attempts to find a value's index
manual_id: ds-sequence.find
version: PECL ds >= 1.0.0
return_type: mixed
return_description:
<p class="para">
    The index of the value, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not found.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
        <p class="para">
            Values will be compared by value and by type.
        </p>
    </p></blockquote>


name: Ds\Sequence.get
purpose: Returns the value at a given index
manual_id: ds-sequence.get
version: PECL ds >= 1.0.0
return_type: mixed
return_description: <p class="para"> The value at the requested index. </p>
errors:
<p class="para">
   <span class="classname">OutOfRangeException</span> if the index is not valid.
  </p>


name: Ds\Sequence.map
purpose: Returns the result of applying a callback to each value
manual_id: ds-sequence.map
version: PECL ds >= 1.0.0
return_type: Ds\Sequence
return_description:
<p class="para">
    The result of applying a <code class="parameter">callback</code> to each value in
    the sequence.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
    <p class="para">
        The values of the current instance won&#039;t be affected.
    </p>
  </p></blockquote>


name: Ds\Sequence.merge
purpose: Returns the result of adding all given values to the sequence
manual_id: ds-sequence.merge
version: PECL ds >= 1.0.0
return_type: Ds\Sequence
return_description:
<p class="para">
    The result of adding all given values to the sequence,
    effectively the same as adding the values to a copy, then returning that copy.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
    <p class="para">
        The current instance won&#039;t be affected.
    </p>
  </p></blockquote>


name: Ds\Sequence.reversed
purpose: Returns a reversed copy
manual_id: ds-sequence.reversed
version: PECL ds >= 1.0.0
return_type: Ds\Sequence
return_description:
<p class="para">
    A reversed copy of the sequence.

    <blockquote class="note"><p><strong class="note">Note</strong>: 
        <p class="para">
            The current instance is not affected.
        </p>
    </p></blockquote>
  </p>


name: Ds\Sequence.rotate
purpose: Rotates the sequence by a given number of rotations
manual_id: ds-sequence.rotate
version: PECL ds >= 1.0.0
return_type: void
return_description:
<p class="para">
    No value is returned.. The sequence of the current instance will be rotated.
  </p>


name: Ds\Sequence.sum
purpose: Returns the sum of all values in the sequence
manual_id: ds-sequence.sum
version: PECL ds >= 1.0.0
return_type: float
return_description:
<p class="para">
    The sum of all the values in the sequence as either a <span class="type">float</span> or <span class="type">int</span>
    depending on the values in the sequence.
  </p>


name: Ds\Vector.contains
purpose: Determines if the vector contains given values
manual_id: ds-vector.contains
version: PECL ds >= 1.0.0
return_type: bool
return_description:
<p class="para">
    <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if any of the provided <code class="parameter">values</code> are not in the
    vector, <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> otherwise.
  </p>


name: Ds\Vector.filter
purpose: Creates a new vector using a callable to determine which values to include
manual_id: ds-vector.filter
version: PECL ds >= 1.0.0
return_type: callable
return_description:
<p class="para">
    A new vector containing all the values for which
    either the <code class="parameter">callback</code> returned <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, or all values that
    convert to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a <code class="parameter">callback</code> was not provided.
  </p>


name: Ds\Vector.isEmpty
purpose: Returns whether the vector is empty
manual_id: ds-vector.isempty
version: PECL ds >= 1.0.0
return_type: bool
return_description:
<p class="para">
    Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the vector is empty, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Ds\Vector.map
purpose: Returns the result of applying a callback to each value
manual_id: ds-vector.map
version: PECL ds >= 1.0.0
return_type: Ds\Vector
return_description:
<p class="para">
    The result of applying a <code class="parameter">callback</code> to each value in
    the vector.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
    <p class="para">
        The values of the current instance won&#039;t be affected.
    </p>
  </p></blockquote>


name: Ds\Vector.merge
purpose: Returns the result of adding all given values to the vector
manual_id: ds-vector.merge
version: PECL ds >= 1.0.0
return_type: Ds\Vector
return_description:
<p class="para">
    The result of adding all given values to the vector,
    effectively the same as adding the values to a copy, then returning that copy.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
    <p class="para">
        The current instance won&#039;t be affected.
    </p>
  </p></blockquote>


name: Ds\Vector.reversed
purpose: Returns a reversed copy
manual_id: ds-vector.reversed
version: PECL ds >= 1.0.0
return_type: Ds\Vector
return_description:
<p class="para">
    A reversed copy of the vector.

    <blockquote class="note"><p><strong class="note">Note</strong>: 
        <p class="para">
            The current instance is not affected.
        </p>
    </p></blockquote>
  </p>


name: Ds\Vector.rotate
purpose: Rotates the vector by a given number of rotations
manual_id: ds-vector.rotate
version: PECL ds >= 1.0.0
return_type: void
return_description:
<p class="para">
    No value is returned.. The vector of the current instance will be rotated.
  </p>


name: Ds\Vector.sum
purpose: Returns the sum of all values in the vector
manual_id: ds-vector.sum
version: PECL ds >= 1.0.0
return_type: float
return_description:
<p class="para">
    The sum of all the values in the vector as either a <span class="type">float</span> or <span class="type">int</span>
    depending on the values in the vector.
  </p>


name: Ds\Vector.toArray
purpose: Converts the vector to an array
manual_id: ds-vector.toarray
version: PECL ds >= 1.0.0
return_type: array
return_description:
<p class="para">
    An <span class="type">array</span> containing all the values in the same order as the vector.
  </p>


name: Ds\Deque.contains
purpose: Determines if the deque contains given values
manual_id: ds-deque.contains
version: PECL ds >= 1.0.0
return_type: bool
return_description:
<p class="para">
    <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if any of the provided <code class="parameter">values</code> are not in the
    deque, <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> otherwise.
  </p>


name: Ds\Deque.filter
purpose: Creates a new deque using a callable to determine which values to include
manual_id: ds-deque.filter
version: PECL ds >= 1.0.0
return_type: callable
return_description:
<p class="para">
    A new deque containing all the values for which
    either the <code class="parameter">callback</code> returned <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, or all values that
    convert to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a <code class="parameter">callback</code> was not provided.
  </p>


name: Ds\Deque.isEmpty
purpose: Returns whether the deque is empty
manual_id: ds-deque.isempty
version: PECL ds >= 1.0.0
return_type: bool
return_description:
<p class="para">
    Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the deque is empty, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Ds\Deque.map
purpose: Returns the result of applying a callback to each value
manual_id: ds-deque.map
version: PECL ds >= 1.0.0
return_type: Ds\Deque
return_description:
<p class="para">
    The result of applying a <code class="parameter">callback</code> to each value in
    the deque.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
    <p class="para">
        The values of the current instance won&#039;t be affected.
    </p>
  </p></blockquote>


name: Ds\Deque.merge
purpose: Returns the result of adding all given values to the deque
manual_id: ds-deque.merge
version: PECL ds >= 1.0.0
return_type: Ds\Deque
return_description:
<p class="para">
    The result of adding all given values to the deque,
    effectively the same as adding the values to a copy, then returning that copy.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
    <p class="para">
        The current instance won&#039;t be affected.
    </p>
  </p></blockquote>


name: Ds\Deque.reversed
purpose: Returns a reversed copy
manual_id: ds-deque.reversed
version: PECL ds >= 1.0.0
return_type: Ds\Deque
return_description:
<p class="para">
    A reversed copy of the deque.

    <blockquote class="note"><p><strong class="note">Note</strong>: 
        <p class="para">
            The current instance is not affected.
        </p>
    </p></blockquote>
  </p>


name: Ds\Deque.rotate
purpose: Rotates the deque by a given number of rotations
manual_id: ds-deque.rotate
version: PECL ds >= 1.0.0
return_type: void
return_description:
<p class="para">
    No value is returned.. The deque of the current instance will be rotated.
  </p>


name: Ds\Deque.sum
purpose: Returns the sum of all values in the deque
manual_id: ds-deque.sum
version: PECL ds >= 1.0.0
return_type: float
return_description:
<p class="para">
    The sum of all the values in the deque as either a <span class="type">float</span> or <span class="type">int</span>
    depending on the values in the deque.
  </p>


name: Ds\Deque.toArray
purpose: Converts the deque to an array
manual_id: ds-deque.toarray
version: PECL ds >= 1.0.0
return_type: array
return_description:
<p class="para">
    An <span class="type">array</span> containing all the values in the same order as the deque.
  </p>


name: Ds\Map.diff
purpose: Creates a new map using keys that aren't in another map
manual_id: ds-map.diff
version: PECL ds >= 1.0.0
return_type: Ds\Map
return_description:
<p class="para">
    The result of removing all keys from the current instance that are
    present in a given <code class="parameter">map</code>.
  </p>


name: Ds\Map.filter
purpose: Creates a new map using a callable to determine which pairs to include
manual_id: ds-map.filter
version: PECL ds >= 1.0.0
return_type: callable
return_description:
<p class="para">
    A new map containing all the pairs for which
    either the <code class="parameter">callback</code> returned <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, or all values that
    convert to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a <code class="parameter">callback</code> was not provided.
  </p>


name: Ds\Map.get
purpose: Returns the value for a given key
manual_id: ds-map.get
version: PECL ds >= 1.0.0
return_type: object
return_description:
<p class="para">
    The value mapped to the given <code class="parameter">key</code>, or the <code class="parameter">default</code>
    value if provided and the key could not be found in the map.
  </p>

errors:
<p class="para">
   <span class="classname">OutOfBoundsException</span> if the key could not be found
   and a default value was not provided.
  </p>


name: Ds\Map.hasKey
purpose: Determines whether the map contains a given key
manual_id: ds-map.haskey
version: PECL ds >= 1.0.0
return_type: bool
return_description:
<p class="para">
    Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the key could found, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Ds\Map.hasValue
purpose: Determines whether the map contains a given value
manual_id: ds-map.hasvalue
version: PECL ds >= 1.0.0
return_type: bool
return_description:
<p class="para">
    Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the value could found, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Ds\Map.intersect
purpose: Creates a new map by intersecting keys with another map
manual_id: ds-map.intersect
version: PECL ds >= 1.0.0
return_type: Ds\Map
return_description:
<p class="para">
    The key intersection of the current instance and another <code class="parameter">map</code>.
    </p>


name: Ds\Map.isEmpty
purpose: Returns whether the map is empty
manual_id: ds-map.isempty
version: PECL ds >= 1.0.0
return_type: bool
return_description:
<p class="para">
    Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the map is empty, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Ds\Map.keys
purpose: Returns a set of the map's keys
manual_id: ds-map.keys
version: PECL ds >= 1.0.0
return_type: Ds\Set
return_description:
<p class="para">
    A <span class="classname">Ds\Set</span> containing all the keys of the map.
  </p>


name: Ds\Map.map
purpose: Returns the result of applying a callback to each value
manual_id: ds-map.map
version: PECL ds >= 1.0.0
return_type: Ds\Map
return_description:
<p class="para">
    The result of applying a <code class="parameter">callback</code> to each value in
    the map.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
    <p class="para">
        The keys and values of the current instance won&#039;t be affected.
    </p>
  </p></blockquote>


name: Ds\Map.merge
purpose: Returns the result of adding all given associations
manual_id: ds-map.merge
version: PECL ds >= 1.0.0
return_type: array
return_description:
<p class="para">
    The result of associating all keys of a given <span class="classname">traversable</span>
    object or <span class="type">array</span> with their corresponding values, combined with the current instance.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
    <p class="para">
        The current instance won&#039;t be affected.
    </p>
  </p></blockquote>


name: Ds\Map.pairs
purpose: Returns a sequence containing all the pairs of the map
manual_id: ds-map.pairs
version: PECL ds >= 1.0.0
return_type: Ds\Sequence
return_description:
<p class="para">
    <span class="classname">Ds\Sequence</span> containing all the pairs of the map.
  </p>


name: Ds\Map.remove
purpose: Removes and returns a value by key
manual_id: ds-map.remove
version: PECL ds >= 1.0.0
return_type: object
return_description:
<p class="para">
    The value that was removed, or the <code class="parameter">default</code>
    value if provided and the <code class="parameter">key</code> could not be found in the map.
  </p>

errors:
<p class="para">
   <span class="classname">OutOfBoundsException</span> if the key could not be found
   and a default value was not provided.
  </p>


name: Ds\Map.reversed
purpose: Returns a reversed copy
manual_id: ds-map.reversed
version: PECL ds >= 1.0.0
return_type: Ds\Map
return_description:
<p class="para">
    A reversed copy of the map.

    <blockquote class="note"><p><strong class="note">Note</strong>: 
        <p class="para">
            The current instance is not affected.
        </p>
    </p></blockquote>
  </p>


name: Ds\Map.skip
purpose: Returns the pair at a given positional index
manual_id: ds-map.skip
version: PECL ds >= 1.0.0
return_type: Ds\Pair
return_description:
<p class="para">
    Returns the <span class="classname">Ds\Pair</span> at the given <code class="parameter">position</code>.
  </p>

errors:
<p class="para">
   <span class="classname">OutOfRangeException</span> if the position is not valid.
  </p>


name: Ds\Map.sum
purpose: Returns the sum of all values in the map
manual_id: ds-map.sum
return_type: float
return_description:
<p class="para">
    The sum of all the values in the map as either a <span class="type">float</span> or <span class="type">int</span>
    depending on the values in the map.
  </p>


name: Ds\Map.toArray
purpose: Converts the map to an array
manual_id: ds-map.toarray
version: PECL ds >= 1.0.0
return_type: array
return_description:
<p class="para">
    An <span class="type">array</span> containing all the values in the same order as the map.
  </p>


name: Ds\Map.union
purpose: Creates a new map using values from the current instance and another map
manual_id: ds-map.union
version: PECL ds >= 1.0.0
return_type: Ds\Map
return_description:
<p class="para">
    A new map containing all the pairs of the current instance as well as another <code class="parameter">map</code>.
    </p>


name: Ds\Map.values
purpose: Returns a sequence of the map's values
manual_id: ds-map.values
version: PECL ds >= 1.0.0
return_type: Ds\Sequence
return_description:
<p class="para">
    A <span class="classname">Ds\Sequence</span> containing all the values of the map.
  </p>


name: Ds\Map.xor
purpose: Creates a new map using keys of either the current instance or of another map, but not of both
manual_id: ds-map.xor
version: PECL ds >= 1.0.0
return_type: Ds\Map
return_description:
<p class="para">
        A new map containing keys in the current instance as well as another <code class="parameter">map</code>,
        but not in both.
    </p>


name: Ds\Pair.isEmpty
purpose: Returns whether the pair is empty
manual_id: ds-pair.isempty
return_type: bool
return_description:
<p class="para">
    Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the pair is empty, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Ds\Pair.toArray
purpose: Converts the pair to an array
manual_id: ds-pair.toarray
version: PECL ds >= 1.0.0
return_type: array
return_description:
<p class="para">
    An <span class="type">array</span> containing all the values in the same order as the pair.
  </p>


name: Ds\Set.contains
purpose: Determines if the set contains all values
manual_id: ds-set.contains
version: PECL ds >= 1.0.0
return_type: object
return_description:
<p class="para">
    <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if any of the provided <code class="parameter">values</code> are not in the
    set, <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> otherwise.
  </p>


name: Ds\Set.diff
purpose: Creates a new set using values that aren't in another set
manual_id: ds-set.diff
version: PECL ds >= 1.0.0
return_type: Ds\Set
return_description:
<p class="para">
    A new set containing all values that were not in the other <code class="parameter">set</code>.
  </p>


name: Ds\Set.filter
purpose: Creates a new set using a callable to determine which values to include
manual_id: ds-set.filter
version: PECL ds >= 1.0.0
return_type: callable
return_description:
<p class="para">
    A new set containing all the values for which
    either the <code class="parameter">callback</code> returned <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, or all values that
    convert to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a <code class="parameter">callback</code> was not provided.
  </p>


name: Ds\Set.intersect
purpose: Creates a new set by intersecting values with another set
manual_id: ds-set.intersect
version: PECL ds >= 1.0.0
return_type: Ds\Set
return_description:
<p class="para">
    The intersection of the current instance and another <code class="parameter">set</code>.
    </p>


name: Ds\Set.isEmpty
purpose: Returns whether the set is empty
manual_id: ds-set.isempty
version: PECL ds >= 1.0.0
return_type: bool
return_description:
<p class="para">
    Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the set is empty, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Ds\Set.merge
purpose: Returns the result of adding all given values to the set
manual_id: ds-set.merge
version: PECL ds >= 1.0.3
return_type: Ds\Set
return_description:
<p class="para">
    The result of adding all given values to the set,
    effectively the same as adding the values to a copy, then returning that copy.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
    <p class="para">
        The current instance won&#039;t be affected.
    </p>
  </p></blockquote>


name: Ds\Set.reversed
purpose: Returns a reversed copy
manual_id: ds-set.reversed
version: PECL ds >= 1.0.0
return_type: Ds\Set
return_description:
<p class="para">
    A reversed copy of the set.

    <blockquote class="note"><p><strong class="note">Note</strong>: 
        <p class="para">
            The current instance is not affected.
        </p>
    </p></blockquote>
  </p>


name: Ds\Set.sum
purpose: Returns the sum of all values in the set
manual_id: ds-set.sum
version: PECL ds >= 1.0.0
return_type: float
return_description:
<p class="para">
    The sum of all the values in the set as either a <span class="type">float</span> or <span class="type">int</span>
    depending on the values in the set.
  </p>


name: Ds\Set.toArray
purpose: Converts the set to an array
manual_id: ds-set.toarray
version: PECL ds >= 1.0.0
return_type: array
return_description:
<p class="para">
    An <span class="type">array</span> containing all the values in the same order as the set.
  </p>


name: Ds\Set.union
purpose: Creates a new set using values from the current instance and another set
manual_id: ds-set.union
version: PECL ds >= 1.0.0
return_type: Ds\Set
return_description:
<p class="para">
    A new set containing all the values of the current instance as well as another <code class="parameter">set</code>.
    </p>


name: Ds\Set.xor
purpose: Creates a new set using values in either the current instance or in another set, but not in both
manual_id: ds-set.xor
version: PECL ds >= 1.0.0
return_type: Ds\Set
return_description:
<p class="para">
        A new set containing values in the current instance as well as another <code class="parameter">set</code>,
        but not in both.
    </p>


name: Ds\Stack.isEmpty
purpose: Returns whether the stack is empty
manual_id: ds-stack.isempty
version: PECL ds >= 1.0.0
return_type: bool
return_description:
<p class="para">
    Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the stack is empty, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Ds\Stack.toArray
purpose: Converts the stack to an array
manual_id: ds-stack.toarray
version: PECL ds >= 1.0.0
return_type: array
return_description:
<p class="para">
    An <span class="type">array</span> containing all the values in the same order as the stack.
  </p>


name: Ds\Queue.isEmpty
purpose: Returns whether the queue is empty
manual_id: ds-queue.isempty
version: PECL ds >= 1.0.0
return_type: bool
return_description:
<p class="para">
    Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the queue is empty, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Ds\Queue.toArray
purpose: Converts the queue to an array
manual_id: ds-queue.toarray
version: PECL ds >= 1.0.0
return_type: array
return_description:
<p class="para">
    An <span class="type">array</span> containing all the values in the same order as the queue.
  </p>


name: curl_copy_handle
purpose: Copy a cURL handle along with all of its preferences
manual_id: function.curl-copy-handle
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a new cURL handle,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: curl_errno
purpose: Return the last error number
manual_id: function.curl-errno
version: PHP 4 >= 4.0.3, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the error number or <code class="literal">0</code> (zero) if no error
   occurred.
  </p>


name: curl_error
purpose: Return a string containing the last error for the current session
manual_id: function.curl-error
version: PHP 4 >= 4.0.3, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the error message or <code class="literal">&#039;&#039;</code> (the empty string) if no
   error occurred.
  </p>


name: curl_escape
purpose: URL encodes the given string
manual_id: function.curl-escape
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns escaped string or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: curl_exec
purpose: Perform a cURL session
manual_id: function.curl-exec
version: PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. However, if the <strong><code><a href="curl.constants.html#constant.curlopt-returntransfer">CURLOPT_RETURNTRANSFER</a></code></strong>
   option is <a href="function.curl-setopt.html" class="link">set</a>, it will return
   the result on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    Note that response status codes which indicate errors (such as <code class="literal">404
    Not found</code>) are not regarded as failure.
    <span class="function">curl_getinfo</span> can be used to check for these.
   </p>
  </p></blockquote>


name: curl_getinfo
purpose: Get information regarding a specific transfer
manual_id: function.curl-getinfo
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   If <code class="parameter">option</code> is given, returns its value.
   Otherwise, returns an associative array with the following elements
   (which correspond to <code class="parameter">option</code>), or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      &quot;url&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;content_type&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;http_code&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;header_size&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;request_size&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;filetime&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;ssl_verify_result&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;redirect_count&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;total_time&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;namelookup_time&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;connect_time&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;pretransfer_time&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;size_upload&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;size_download&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;speed_download&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;speed_upload&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;download_content_length&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;upload_content_length&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;starttransfer_time&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;redirect_time&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;certinfo&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;primary_ip&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;primary_port&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;local_ip&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;local_port&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;redirect_url&quot;
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;request_header&quot; (This is only set if the <strong><code><a href="curl.constants.html#constant.curlinfo-header-out">CURLINFO_HEADER_OUT</a></code></strong>
      is set by a previous call to <span class="function">curl_setopt</span>)
     </span>
    </li>
   </ul>
   Note that private data is not included in the associative array and must be retrieved individually with the <strong><code><a href="curl.constants.html#constant.curlinfo-private">CURLINFO_PRIVATE</a></code></strong> option.
  </p>


name: curl_init
purpose: Initialize a cURL session
manual_id: function.curl-init
version: PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a cURL handle on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on errors.
  </p>


name: curl_multi_add_handle
purpose: Add a normal cURL handle to a cURL multi handle
manual_id: function.curl-multi-add-handle
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns 0 on success, or one of the <strong><code>CURLM_XXX</code></strong> errors
   code.
  </p>


name: curl_multi_exec
purpose: Run the sub-connections of the current cURL handle
manual_id: function.curl-multi-exec
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   A cURL code defined in the cURL <a href="curl.constants.html" class="link">Predefined Constants</a>.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    This only returns errors regarding the whole multi stack. There might still have 
    occurred problems on individual transfers even when this function returns 
    <strong><code><a href="curl.constants.html#constant.curlm-ok">CURLM_OK</a></code></strong>.
   </p>
  </p></blockquote>


name: curl_multi_getcontent
purpose: Return the content of a cURL handle if CURLOPT_RETURNTRANSFER is set
manual_id: function.curl-multi-getcontent
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Return the content of a cURL handle if <strong><code><a href="curl.constants.html#constant.curlopt-returntransfer">CURLOPT_RETURNTRANSFER</a></code></strong> is set or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not set.
  </p>


name: curl_multi_info_read
purpose: Get information about the current transfers
manual_id: function.curl-multi-info-read
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   On success, returns an associative array for the message, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   <table class="doctable table">
    <caption><strong>Contents of the returned array</strong></caption>
    
     <thead>
      <tr>
       <th>Key:</th>
       <th>Value:</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><code class="literal">msg</code></td>
       <td>The <strong><code><a href="curl.constants.html#constant.curlmsg-done">CURLMSG_DONE</a></code></strong> constant. Other return values
       are currently not available.</td>
      </tr>

      <tr>
       <td><code class="literal">result</code></td>
       <td>One of the <strong><code>CURLE_*</code></strong> constants. If everything is
       OK, the <strong><code><a href="curl.constants.html#constant.curle-ok">CURLE_OK</a></code></strong> will be the result.</td>
      </tr>

      <tr>
       <td><code class="literal">handle</code></td>
       <td>Resource of type curl indicates the handle which it concerns.</td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: curl_multi_remove_handle
purpose: Remove a multi handle from a set of cURL handles
manual_id: function.curl-multi-remove-handle
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns 0 on success, or one of the <strong><code>CURLM_XXX</code></strong> error
   codes.
  </p>


name: curl_multi_select
purpose: Wait for activity on any curl_multi connection
manual_id: function.curl-multi-select
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   On success, returns the number of descriptors contained in 
   the descriptor sets. This may be 0 if there was no activity on any
   of the descriptors. On failure, this function will return -1 on a select
   failure (from the underlying select system call). 
  </p>


name: curl_multi_strerror
purpose: Return string describing error code
manual_id: function.curl-multi-strerror
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns error string for valid error code, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> otherwise.
  </p>


name: curl_pause
purpose: Pause and unpause a connection
manual_id: function.curl-pause
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns an error code (<strong><code><a href="curl.constants.html#constant.curle-ok">CURLE_OK</a></code></strong> for no error).
  </p>


name: curl_setopt_array
purpose: Set multiple options for a cURL transfer
manual_id: function.curl-setopt-array
version: PHP 5 >= 5.1.3, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if all options were successfully set. If an option could
   not be successfully set, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is immediately returned, ignoring any
   future options in the <code class="parameter">options</code> array.
  </p>


name: curl_share_strerror
purpose: Return string describing the given error code
manual_id: function.curl-share-strerror
version: PHP 7 >= 7.1.0, PHP 8
return_type: null
return_description:
<p class="para">
   Returns error description or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> for invalid error code.
  </p>


name: curl_unescape
purpose: Decodes the given URL encoded string
manual_id: function.curl-unescape
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns decoded string  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: curl_version
purpose: Gets cURL version information
manual_id: function.curl-version
version: PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an associative array with the following elements: 
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Key</th>
       <th>Value description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>version_number</td>
       <td>cURL 24 bit version number</td>
      </tr>

      <tr>
       <td>version</td>
       <td>cURL version number, as a string</td>
      </tr>

      <tr>
       <td>ssl_version_number</td>
       <td>OpenSSL 24 bit version number</td>
      </tr>

      <tr>
       <td>ssl_version</td>
       <td>OpenSSL version number, as a string</td>
      </tr>

      <tr>
       <td>libz_version</td>
       <td>zlib version number, as a string</td>
      </tr>

      <tr>
       <td>host</td>
       <td>Information about the host where cURL was built</td>
      </tr>

      <tr>
       <td>age</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td>features</td>
       <td>A bitmask of the <code class="literal">CURL_VERSION_XXX</code> constants</td>
      </tr>

      <tr>
       <td>protocols</td>
       <td>An array of protocols names supported by cURL</td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: Event.pending
purpose: Detects whether event is pending or scheduled
manual_id: event.pending
version: PECL event >= 1.2.6-beta
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if event is pending or scheduled. Otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: Event.signal
purpose: Constructs signal event object
manual_id: event.signal
version: PECL event >= 1.2.6-beta
return_type: Event
return_description:
<p class="para">
   Returns Event object on success. Otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: EventBase.__construct
purpose: Constructs EventBase object
manual_id: eventbase.construct
version: PECL event >= 1.2.6-beta
errors:
<p class="para">
   If <span class="classname">EventBase</span> cannot be constructed with the provided configuration,
   a <span class="classname">EventException</span> will be thrown.
  </p>


name: EventBase.getFeatures
purpose: Returns bitmask of features supported
manual_id: eventbase.getfeatures
version: PECL event >= 1.2.6-beta
return_type: int
return_description:
<p class="para">
   Returns integer representing a bitmask of supported features. See
   <a href="class.eventconfig.html#eventconfig.constants" class="link">EventConfig::FEATURE_* constants</a>
   .
  </p>


name: EventBase.getTimeOfDayCached
purpose: Returns the current event base time
manual_id: eventbase.gettimeofdaycached
version: PECL event >= 1.2.6-beta
return_type: float
return_description:
<p class="para">
   Returns the current
   <em>event base</em>
   time. On failure returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>


name: EventBase.gotExit
purpose: Checks if the event loop was told to exit
manual_id: eventbase.gotexit
version: PECL event >= 1.2.6-beta
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, event loop was told to exit by
    <span class="methodname">EventBase::exit</span>
   . Otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: EventBase.gotStop
purpose: Checks if the event loop was told to exit
manual_id: eventbase.gotstop
version: PECL event >= 1.2.6-beta
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, event loop was told to stop by
    <span class="methodname">EventBase::stop</span>
   . Otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: EventBuffer.copyout
purpose: Copies out specified number of bytes from the front of the buffer
manual_id: eventbuffer.copyout
version: PECL event >= 1.2.6-beta
return_type: int
return_description:
<p class="para">
   Returns the number of bytes copied, or
   <strong><code>-1</code></strong>
   on failure.
  </p>


name: EventBuffer.pullup
purpose: Linearizes data within buffer and returns it's contents as a string
manual_id: eventbuffer.pullup
version: PECL event >= 1.2.6-beta
return_type: string
return_description:
<p class="para">
   If
   <code class="parameter">size</code>
   is greater than the number of bytes in the buffer, the function returns
   <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>. Otherwise,
    <span class="methodname">EventBuffer::pullup</span>
   returns string.
  </p>


name: EventBuffer.read
purpose: Read data from an evbuffer and drain the bytes read
manual_id: eventbuffer.read
version: PECL event >= 1.6.0
return_type: string
return_description:
<p class="para">
   Returns string read, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: EventBuffer.readFrom
purpose: Read data from a file onto the end of the buffer
manual_id: eventbuffer.readfrom
version: PECL event >= 1.7.0
return_type: int
return_description:
<p class="para">
   Returns the number of bytes read, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: EventBuffer.readLine
purpose: Extracts a line from the front of the buffer
manual_id: eventbuffer.readline
version: PECL event >= 1.2.6-beta
return_type: string
return_description:
<p class="para">
   On success returns the line read from the buffer, otherwise <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>


name: EventBuffer.search
purpose: Scans the buffer for an occurrence of a string
manual_id: eventbuffer.search
version: PECL event >= 1.2.6-beta
return_type: mixed
return_description:
<p class="para">
   Returns numeric position of the first occurrence of the string in the
   buffer, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if string is not found.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>


name: EventBuffer.searchEol
purpose: Scans the buffer for an occurrence of an end of line
manual_id: eventbuffer.searcheol
version: PECL event >= 1.5.0
return_type: mixed
return_description:
<p class="para">
   Returns numeric position of the first occurrence of end-of-line symbol in
   the buffer, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not found.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>


name: EventBuffer.substr
purpose: Substracts a portion of the buffer data
manual_id: eventbuffer.substr
version: PECL event >= 1.6.0
return_type: string
return_description:
<p class="para">
   Returns the data substracted as a
   <span class="type">string</span>
   on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: EventBufferEvent.createPair
purpose: Creates two buffer events connected to each other
manual_id: eventbufferevent.createpair
version: PECL event >= 1.2.6-beta
return_type: array
return_description:
<p class="para">
   Returns array of two
   <span class="classname">EventBufferEvent</span>
   objects connected to each other.
  </p>


name: EventBufferEvent.getDnsErrorString
purpose: Returns string describing the last failed DNS lookup attempt
manual_id: eventbufferevent.getdnserrorstring
version: PECL event >= 1.2.6-beta
return_type: string
return_description:
<p class="para">
   Returns a string describing DNS lookup error, or an empty string for no
   error.
  </p>


name: EventBufferEvent.getEnabled
purpose: Returns bitmask of events currently enabled on the buffer event
manual_id: eventbufferevent.getenabled
version: PECL event >= 1.2.6-beta
return_type: int
return_description:
<p class="para">
   Returns integer representing a bitmask of events currently enabled on the
   buffer event
  </p>


name: EventBufferEvent.getInput
purpose: Returns underlying input buffer associated with current buffer event
manual_id: eventbufferevent.getinput
version: PECL event >= 1.2.6-beta
return_type: EventBuffer
return_description:
<p class="para">
   Returns instance of
   <span class="classname">EventBuffer</span>
   input buffer associated with current buffer event.
  </p>


name: EventBufferEvent.getOutput
purpose: Returns underlying output buffer associated with current buffer event
manual_id: eventbufferevent.getoutput
version: PECL event >= 1.2.6-beta
return_type: EventBuffer
return_description:
<p class="para">
   Returns instance of
   <span class="classname">EventBuffer</span>
   output buffer associated with current buffer event.
  </p>


name: EventBufferEvent.sslError
purpose: Returns most recent OpenSSL error reported on the buffer event
manual_id: eventbufferevent.sslerror
version: PECL event >= 1.2.6-beta
return_type: string
return_description:
<p class="para">
   Returns OpenSSL error string reported on the buffer event, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, if
   there is no more error to return.
  </p>


name: EventBufferEvent.sslFilter
purpose: Create a new SSL buffer event to send its data over another buffer event
manual_id: eventbufferevent.sslfilter
version: PECL event >= 1.2.6-beta
return_type: EventBufferEvent
return_description:
<p class="para">
   Returns a new SSL
   <span class="classname">EventBufferEvent</span>
   object.
  </p>


name: EventBufferEvent.sslGetCipherInfo
purpose: Returns a textual description of the cipher
manual_id: eventbufferevent.sslgetcipherinfo
version: PECL event >= 1.10.0
return_type: string
return_description:
<p class="para">
   Returns a textual description of the cipher on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: EventBufferEvent.sslGetCipherName
purpose: Returns the current cipher name of the SSL connection
manual_id: eventbufferevent.sslgetciphername
version: PECL event >= 1.10.0
return_type: string
return_description:
<p class="para">
   Returns the current cipher name of the SSL connection, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: EventBufferEvent.sslGetCipherVersion
purpose: Returns version of cipher used by current SSL connection
manual_id: eventbufferevent.sslgetcipherversion
version: PECL event >= 1.10.0
return_type: string
return_description:
<p class="para">
   Returns the current cipher version of the SSL connection, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: EventDnsBase.__construct
purpose: Constructs EventDnsBase object
manual_id: eventdnsbase.construct
version: PECL event >= 1.2.6-beta
errors:
<p class="para">
   If <code class="parameter">initialize</code> has a type other than
   <span class="type"><span class="type">int</span><span class="type">bool</span></span>,
   a <span class="exceptionname">TypeError</span> is thrown.
  </p>
  <p class="para">
   If the value of <code class="parameter">initialize</code> is invalid,
   a <span class="exceptionname">EventException</span> is thrown.
  </p>


name: EventDnsBase.countNameservers
purpose: Gets the number of configured nameservers
manual_id: eventdnsbase.countnameservers
version: PECL event >= 1.2.6-beta
return_type: int
return_description:
<p class="para">
   Returns the number of configured nameservers(not necessarily the number of
   running nameservers). This is useful for double-checking whether our calls
   to the various nameserver configuration functions have been successful.
  </p>


name: EventHttp.setAllowedMethods
manual_id: eventhttp.setallowedmethods
version: PECL event >= 1.4.0-beta
return_type: void
return_description: <p class="para"> No value is returned. </p>
purpose:
Sets the what HTTP methods are supported in requests accepted by this server, and passed to user callbacks


name: EventHttpConnection.getBase
purpose: Returns event base associated with the connection
manual_id: eventhttpconnection.getbase
version: PECL event >= 1.2.6-beta
return_type: EventBase
return_description:
<p class="para">
   On success returns
   <span class="classname">EventBase</span>
   object associated with the connection. Otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: EventHttpRequest.findHeader
purpose: Finds the value belonging a header
manual_id: eventhttprequest.findheader
version: PECL event >= 1.4.0-beta
return_type: void
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if header not found.
  </p>


name: EventHttpRequest.getCommand
purpose: Returns the request command(method)
manual_id: eventhttprequest.getcommand
version: PECL event >= 1.4.0-beta
return_type: void
return_description:
<p class="para">
   Returns the request command, one of
   <a href="class.eventhttprequest.html#eventhttprequest.constants" class="link">
    <code class="literal">EventHttpRequest::CMD_*</code>
   </a>
   constants.
  </p>


name: EventUtil.getLastSocketErrno
purpose: Returns the most recent socket error number
manual_id: eventutil.getlastsocketerrno
version: PECL event >= 1.2.6-beta
return_type: int
return_description:
<p class="para">
   Returns the most recent socket error number(
   <code class="literal">errno</code>
   ).
  </p>


name: EventUtil.getSocketFd
purpose: Returns numeric file descriptor of a socket, or stream
manual_id: eventutil.getsocketfd
version: PECL event >= 1.7.0
return_type: int
return_description:
<p class="para">
   Returns numeric file descriptor of a socket, or stream.
    <span class="methodname">EventUtil::getSocketFd</span>
   returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> in case if it is whether failed to recognize the type of
   the underlying file, or detected that the file descriptor associated with
   <code class="parameter">socket</code>
   is not valid.
  </p>


name: ftp_chdir
purpose: Changes the current directory on a FTP server
manual_id: function.ftp-chdir
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   If changing directory fails, PHP will also throw a warning.
  </p>


name: ftp_chmod
purpose: Set permissions on a file via FTP
manual_id: function.ftp-chmod
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the new file permissions on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: ftp_connect
purpose: Opens an FTP connection
manual_id: function.ftp-connect
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="classname">FTP\Connection</span> instance on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ftp_exec
purpose: Requests execution of a command on the FTP server
manual_id: function.ftp-exec
version: PHP 4 >= 4.0.3, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the command was successful (server sent response code:
   <code class="literal">200</code>); otherwise returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ftp_get_option
purpose: Retrieves various runtime behaviours of the current FTP connection
manual_id: function.ftp-get-option
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns the value on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the given 
   <code class="parameter">option</code> is not supported. In the latter case, a
   warning message is also thrown.
  </p>


name: ftp_login
purpose: Logs in to an FTP connection
manual_id: function.ftp-login
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   If login fails, PHP will also throw a warning.
  </p>


name: ftp_mdtm
purpose: Returns the last modified time of the given file
manual_id: function.ftp-mdtm
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the last modified time as a <em>local</em> Unix timestamp on success, or -1 on 
   error.
  </p>


name: ftp_mkdir
purpose: Creates a directory
manual_id: function.ftp-mkdir
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the newly created directory name on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>

errors:
<p class="simpara">
   Emits an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error if the directory
   already exists or the relevant permissions prevent creating the directory.
  </p>


name: ftp_mlsd
purpose: Returns a list of files in the given directory
manual_id: function.ftp-mlsd
version: PHP 7 >= 7.2.0, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of arrays with file infos from the specified directory on success or
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: ftp_nb_continue
purpose: Continues retrieving/sending a file (non-blocking)
manual_id: function.ftp-nb-continue
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns <strong><code><a href="ftp.constants.html#constant.ftp-failed">FTP_FAILED</a></code></strong> or <strong><code><a href="ftp.constants.html#constant.ftp-finished">FTP_FINISHED</a></code></strong>
   or <strong><code><a href="ftp.constants.html#constant.ftp-moredata">FTP_MOREDATA</a></code></strong>.
  </p>


name: ftp_nb_get
purpose: Retrieves a file from the FTP server and writes it to a local file (non-blocking)
manual_id: function.ftp-nb-get
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns <strong><code><a href="ftp.constants.html#constant.ftp-failed">FTP_FAILED</a></code></strong> or <strong><code><a href="ftp.constants.html#constant.ftp-finished">FTP_FINISHED</a></code></strong>
   or <strong><code><a href="ftp.constants.html#constant.ftp-moredata">FTP_MOREDATA</a></code></strong>, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure to open the local file.
  </p>


name: ftp_nlist
purpose: Returns a list of files in the given directory
manual_id: function.ftp-nlist
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of filenames from the specified directory on success or
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: ftp_pwd
purpose: Returns the current directory name
manual_id: function.ftp-pwd
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the current directory name or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: ftp_raw
purpose: Sends an arbitrary command to an FTP server
manual_id: function.ftp-raw
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the server&#039;s response as an array of strings, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
   No parsing is performed on the response string, nor does
   <span class="function">ftp_raw</span> determine if the command succeeded.
  </p>


name: ftp_rawlist
purpose: Returns a detailed list of files in the given directory
manual_id: function.ftp-rawlist
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array where each element corresponds to one line of text. Returns
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> when passed <code class="parameter">directory</code> is invalid.
  </p>
  <p class="para">
   The output is not parsed in any way. The system type identifier returned by
   <span class="function">ftp_systype</span> can be used to determine how the results 
   should be interpreted.
  </p>


name: ftp_rename
purpose: Renames a file or a directory on the FTP server
manual_id: function.ftp-rename
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. Upon failure (such as attempting to rename a non-existent
   file), an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> error will be emitted.
  </p>


name: ftp_set_option
purpose: Set miscellaneous runtime FTP options
manual_id: function.ftp-set-option
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the option could be set; <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. A warning
   message will be thrown if the <code class="parameter">option</code> is not
   supported or the passed <code class="parameter">value</code> doesn&#039;t match the
   expected value for the given <code class="parameter">option</code>.
  </p>


name: ftp_systype
purpose: Returns the system type identifier of the remote FTP server
manual_id: function.ftp-systype
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the remote system type, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: GearmanClient.addTask
purpose: Add a task to be run in parallel
manual_id: gearmanclient.addtask
version: PECL gearman >= 0.5.0
return_type: false
return_description:
<p class="para">
   A <span class="classname">GearmanTask</span> object or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the task could not be added.
  </p>


name: GearmanClient.addTaskStatus
purpose: Add a task to get status
manual_id: gearmanclient.addtaskstatus
version: PECL gearman >= 0.5.0
return_type: false
return_description:
<p class="para">
   A <span class="classname">GearmanTask</span> object or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: GearmanClient.clone
purpose: Create a copy of a GearmanClient object
manual_id: gearmanclient.clone
version: PECL gearman >= 0.5.0
return_type: GearmanClient
return_description:
<p class="para">
   A <span class="classname">GearmanClient</span> on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: GearmanClient.context
purpose: Get the application context
manual_id: gearmanclient.context
version: PECL gearman >= 0.6.0
return_type: string
return_description:
<p class="para">
   The same context data structure set with  <span class="methodname">GearmanClient::setContext</span>
  </p>


name: GearmanClient.data
purpose: Get the application data (deprecated)
manual_id: gearmanclient.data
version: PECL gearman <= 0.5.0
return_type: string
return_description:
<p class="para">
   The same string data set with  <span class="methodname">GearmanClient::setData</span>
  </p>


name: GearmanClient.doStatus
purpose: Get the status for the running task
manual_id: gearmanclient.dostatus
version: PECL gearman >= 0.5.0
return_type: array
return_description:
<p class="para">
   An array representing the percentage completion given as a fraction, with the
   first element the numerator and the second element the denomintor.
  </p>


name: GearmanClient.error
purpose: Returns an error string for the last error encountered
manual_id: gearmanclient.error
version: PECL gearman >= 0.5.0
return_type: false
return_description:
<p class="para">
   A human readable error string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there is no error message available.
  </p>


name: GearmanClient.jobStatus
purpose: Get the status of a background job
manual_id: gearmanclient.jobstatus
version: PECL gearman >= 0.5.0
return_type: array
return_description:
<p class="para">
   An array containing status information for the job corresponding to the supplied
   job handle.  The first array element is a boolean indicating whether the job is
   even known, the second is a boolean indicating whether the job is still running,
   and the third and fourth elements correspond to the numerator and denominator
   of the fractional completion percentage, respectively.
  </p>


name: GearmanClient.timeout
purpose: Get current socket I/O activity timeout value
manual_id: gearmanclient.timeout
version: PECL gearman >= 0.6.0
return_type: int
return_description:
<p class="para">
   Timeout in milliseconds to wait for I/O activity.  A negative value means an infinite timeout.
  </p>


name: GearmanClient.wait
purpose: Wait for I/O activity on all connections in a client
manual_id: gearmanclient.wait
version: PECL gearman >= 0.6.0
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on an error.
  </p>


name: GearmanJob.functionName
purpose: Get function name
manual_id: gearmanjob.functionname
version: PECL gearman >= 0.5.0
return_type: string
return_description:
<p class="para">
   The name of a function, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the job has not yet been initialized.
  </p>


name: GearmanJob.handle
purpose: Get the job handle
manual_id: gearmanjob.handle
version: PECL gearman >= 0.5.0
return_type: string
return_description:
<p class="para">
   An opaque job handle, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the job has not yet been initialized.
  </p>


name: GearmanJob.unique
purpose: Get the unique identifier
manual_id: gearmanjob.unique
version: PECL gearman >= 0.5.0
return_type: string
return_description:
<p class="para">
   An opaque unique identifier, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the job has not yet been initialized.
  </p>


name: GearmanTask.create
purpose: Create a task (deprecated)
manual_id: gearmantask.create
version: PECL gearman <= 0.5.0
return_type: false
return_description:
<p class="para">
   A <span class="classname">GearmanTask</span> oject or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: GearmanTask.data
purpose: Get data returned for a task
manual_id: gearmantask.data
version: PECL gearman >= 0.5.0
return_type: string
return_description:
<p class="para">
   The serialized data, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if no data is present.
  </p>


name: GearmanTask.dataSize
purpose: Get the size of returned data
manual_id: gearmantask.datasize
version: PECL gearman >= 0.5.0
return_type: false
return_description:
<p class="para">
   The data size, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there is no data.
  </p>


name: GearmanTask.functionName
purpose: Get associated function name
manual_id: gearmantask.functionname
version: PECL gearman >= 0.6.0
return_type: string
return_description:
<p class="para">
   A function name, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the task has not yet been created.
  </p>


name: GearmanTask.isKnown
purpose: Determine if task is known
manual_id: gearmantask.isknown
version: PECL gearman >= 0.5.0
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the task is known, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: GearmanTask.isRunning
purpose: Test whether the task is currently running
manual_id: gearmantask.isrunning
version: PECL gearman >= 0.5.0
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the task is running, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: GearmanTask.jobHandle
purpose: Get the job handle
manual_id: gearmantask.jobhandle
version: PECL gearman >= 0.5.0
return_type: string
return_description:
<p class="para">
   The opaque job handle, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the task has not yet been created.
  </p>


name: GearmanTask.recvData
purpose: Read work or result data into a buffer for a task
manual_id: gearmantask.recvdata
version: PECL gearman >= 0.5.0
return_type: array
return_description:
<p class="para">
   An array whose first element is the length of data read and the second is the data buffer.
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the read failed.
  </p>


name: GearmanTask.sendData
purpose: Send data for a task (deprecated)
manual_id: gearmantask.senddata
version: PECL gearman <= 0.5.0
return_type: int
return_description:
<p class="para">
   The length of data sent, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the send failed.
  </p>


name: GearmanTask.taskDenominator
purpose: Get completion percentage denominator
manual_id: gearmantask.taskdenominator
version: PECL gearman >= 0.5.0
return_type: int
return_description:
<p class="para">
   A number between 0 and 100, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if cannot be determined.
  </p>


name: GearmanTask.unique
purpose: Get the unique identifier for a task
manual_id: gearmantask.unique
version: PECL gearman >= 0.6.0
return_type: string
return_description:
<p class="para">
   The unique identifier, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if no identifier is assigned.
  </p>


name: GearmanWorker.setId
manual_id: gearmanworker.setid
return_type: bool
purpose:
Give the worker an identifier so it can be tracked when asking gearmand for the list of available workers


name: GearmanWorker.timeout
purpose: Get socket I/O activity timeout
manual_id: gearmanworker.timeout
version: PECL gearman >= 0.6.0
return_type: int
return_description:
<p class="para">
   A time period is milliseconds.  A negative value indicates an infinite timeout.
  </p>


name: ldap_8859_to_t61
purpose: Translate 8859 characters to t61 characters
manual_id: function.ldap-8859-to-t61
version: PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Return the <code class="literal">t61</code> translation of
   <code class="parameter">value</code>,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ldap_add_ext
purpose: Add entries to LDAP directory
manual_id: function.ldap-add-ext
version: PHP 7 >= 7.3.0, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="classname">LDAP\Result</span> instance, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ldap_compare
purpose: Compare value of attribute found in entry specified with DN
manual_id: function.ldap-compare
version: PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if <code class="parameter">value</code> matches otherwise returns
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Returns -1 on error.
  </p>


name: ldap_connect
purpose: Connect to an LDAP server
manual_id: function.ldap-connect
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="classname">LDAP\Connection</span> instance when the provided LDAP URI
   seems plausible. It&#039;s a syntactic check of the provided parameter but the server(s) will not
   be contacted! If the syntactic check fails it returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
   <span class="function">ldap_connect</span> will otherwise
   return a <span class="classname">LDAP\Connection</span> instance as it does not actually connect but just
   initializes the connecting parameters.  The actual connect happens with
   the next calls to ldap_* functions, usually with
   <span class="function">ldap_bind</span>.
  </p>
  <p class="para">
   If no argument is specified then the <span class="classname">LDAP\Connection</span> instance of the already
   opened connection will be returned.
  </p>


name: ldap_count_entries
purpose: Count the number of entries in a search
manual_id: function.ldap-count-entries
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns number of entries in the result, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ldap_dn2ufn
purpose: Convert DN to User Friendly Naming format
manual_id: function.ldap-dn2ufn
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the user friendly name,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ldap_exop_passwd
purpose: PASSWD extended operation helper
manual_id: function.ldap-exop-passwd
version: PHP 7 >= 7.2.0, PHP 8
return_type: bool
return_description:
<p class="para">
    Returns the generated password if <code class="parameter">new_password</code> is empty or omitted.
    Otherwise returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ldap_exop_refresh
purpose: Refresh extended operation helper
manual_id: function.ldap-exop-refresh
version: PHP 7 >= 7.3.0, PHP 8
return_type: false
return_description:
<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.html#constant.false">false</a></code></strong> will be returned on error.
  </p>


name: ldap_exop_whoami
purpose: WHOAMI extended operation helper
manual_id: function.ldap-exop-whoami
version: PHP 7 >= 7.2.0, PHP 8
return_type: false
return_description:
<p class="para">
   The data returned by the server, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: ldap_exop
purpose: Performs an extended operation
manual_id: function.ldap-exop
version: PHP 7 >= 7.2.0, PHP 8
return_type: mixed
return_description:
<p class="para">
   When used with <code class="parameter">response_data</code>, returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
   When used without <code class="parameter">response_data</code>, returns a result identifier or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: ldap_explode_dn
purpose: Splits DN into its component parts
manual_id: function.ldap-explode-dn
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of all DN components,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   The first element in the array has <code class="literal">count</code> key and
   represents the number of returned values, next elements are numerically
   indexed DN components.
  </p>


name: ldap_first_attribute
purpose: Return first attribute
manual_id: function.ldap-first-attribute
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the first attribute in the entry on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   error.
  </p>


name: ldap_first_entry
purpose: Return first result id
manual_id: function.ldap-first-entry
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="classname">LDAP\ResultEntry</span> instance, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ldap_get_dn
purpose: Get the DN of a result entry
manual_id: function.ldap-get-dn
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the DN of the result entry and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: ldap_get_entries
purpose: Get all result entries
manual_id: function.ldap-get-entries
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a complete result information in a multi-dimensional array on
   success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   The structure of the array is as follows.
   The attribute index is converted to lowercase. (Attributes are
   case-insensitive for directory servers, but not when used as
   array indices.)
   <div class="informalexample">
    <div class="example-contents">
<div class="cdata"><pre>
return_value[&quot;count&quot;] = number of entries in the result
return_value[0] : refers to the details of first entry

return_value[i][&quot;dn&quot;] =  DN of the ith entry in the result

return_value[i][&quot;count&quot;] = number of attributes in ith entry
return_value[i][j] = NAME of the jth attribute in the ith entry in the result

return_value[i][&quot;attribute&quot;][&quot;count&quot;] = number of values for
                                        attribute in ith entry
return_value[i][&quot;attribute&quot;][j] = jth value of attribute in ith entry
</pre></div>
    </div>

   </div>
  </p>


name: ldap_get_values_len
purpose: Get all binary values from a result entry
manual_id: function.ldap-get-values-len
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of values for the attribute on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   error. Individual values are accessed by integer index in the array. The
   first index is 0. The number of values can be found by indexing &quot;count&quot;
   in the resultant array. 
  </p>


name: ldap_get_values
purpose: Get all values from a result entry
manual_id: function.ldap-get-values
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of values for the attribute on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   error. The number of values can be found by indexing &quot;count&quot; in the
   resultant array. Individual values are accessed by integer index in the
   array.  The first index is 0.
  </p>
  <p class="para">
   LDAP allows more than one entry for an attribute, so it can, for example,
   store a number of email addresses for one person&#039;s directory entry all
   labeled with the attribute &quot;mail&quot;
   <div class="informalexample">
    <pre class="literallayout">
    return_value[&quot;count&quot;] = number of values for attribute
    return_value[0] = first value of attribute
    return_value[i] = ith value of attribute
    </pre>
   </div>
  </p>


name: ldap_list
purpose: Single-level search
manual_id: function.ldap-list
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="classname">LDAP\Result</span> instance, an array of <span class="classname">LDAP\Result</span> instances, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ldap_next_attribute
purpose: Get the next attribute in result
manual_id: function.ldap-next-attribute
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the next attribute in an entry on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   error.
  </p>


name: ldap_next_entry
purpose: Get next result entry
manual_id: function.ldap-next-entry
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="classname">LDAP\ResultEntry</span> instance for the next entry in the result whose entries
   are being read starting with <span class="function">ldap_first_entry</span>. If
   there are no more entries in the result then it returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: Memcache.add
purpose: Add an item to the server
manual_id: memcache.add
version: PECL memcache >= 0.2.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if such key already exist. For the rest
   <span class="function">Memcache::add</span> behaves similarly to
   <span class="function">Memcache::set</span>.
  </p>


name: Memcache.decrement
purpose: Decrement item's value
manual_id: memcache.decrement
version: PECL memcache >= 0.2.0
return_type: false
return_description:
<p class="para">
   Returns item&#039;s new value on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Memcache.get
purpose: Retrieve item from the server
manual_id: memcache.get
version: PECL memcache >= 0.2.0
return_type: array
return_description:
<p class="para">
   Returns the value associated with the <code class="parameter">key</code> or
   an array of found key-value pairs when <code class="parameter">key</code> is an <span class="type">array</span>.
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure, <code class="parameter">key</code> is not found or
   <code class="parameter">key</code> is an empty <span class="type">array</span>.
  </p>


name: Memcache.getExtendedStats
purpose: Get statistics from all servers in pool
manual_id: memcache.getextendedstats
version: PECL memcache >= 2.0.0
return_type: array
return_description:
<p class="para">
   Returns a two-dimensional associative array of server statistics or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   on failure.
  </p>


name: Memcache.getStats
purpose: Get statistics of the server
manual_id: memcache.getstats
version: PECL memcache >= 0.2.0
return_type: false
return_description:
<p class="para">
   Returns an associative array of server statistics or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Memcache.getVersion
purpose: Return version of the server
manual_id: memcache.getversion
version: PECL memcache >= 0.2.0
return_type: false
return_description:
<p class="para">
   Returns a string of server version number or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Memcache.increment
purpose: Increment item's value
manual_id: memcache.increment
version: PECL memcache >= 0.2.0
return_type: false
return_description:
<p class="para">
   Returns new items value on success  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Memcache.pconnect
purpose: Open memcached server persistent connection
manual_id: memcache.pconnect
version: PECL memcache >= 0.4.0
return_type: mixed
return_description:
<p class="para">
   Returns a Memcache object or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: memcache_debug
purpose: Turn debug output on/off
manual_id: function.memcache-debug
version: PECL memcache >= 0.2.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if PHP was built with --enable-debug option, otherwise
   returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: Memcached.add
purpose: Add an item under a new key
manual_id: memcached.add
version: PECL memcached >= 0.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   The  <span class="methodname">Memcached::getResultCode</span> will return
   <strong><code><a href="memcached.constants.html#memcached.constants.res-notstored">Memcached::RES_NOTSTORED</a></code></strong> if the key already exists.
  </p>


name: Memcached.append
purpose: Append data to an existing item
manual_id: memcached.append
version: PECL memcached >= 0.1.0
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> when compression is on.
  </p>

errors:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> and raises an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> when
   compression is enabled.
  </p>


name: Memcached.cas
purpose: Compare and swap an item
manual_id: memcached.cas
version: PECL memcached >= 0.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   The  <span class="methodname">Memcached::getResultCode</span> will return
   <strong><code><a href="memcached.constants.html#memcached.constants.res-data-exists">Memcached::RES_DATA_EXISTS</a></code></strong> if the item you are trying
   to store has been modified since you last fetched it.
  </p>


name: Memcached.delete
purpose: Delete an item
manual_id: memcached.delete
version: PECL memcached >= 0.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   The  <span class="methodname">Memcached::getResultCode</span> will return
   <strong><code><a href="memcached.constants.html#memcached.constants.res-notfound">Memcached::RES_NOTFOUND</a></code></strong> if the key does not exist.
  </p>


name: Memcached.deleteMulti
purpose: Delete multiple items
manual_id: memcached.deletemulti
version: PECL memcached >= 2.0.0
return_type: array
return_description:
<p class="para">
   Returns an array indexed by <code class="parameter">keys</code>. Each element
   is <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the corresponding key was deleted, or one of the
   <strong><code>Memcached::RES_*</code></strong> constants if the corresponding deletion
   failed.
   </p>
  <p class="para">
   The  <span class="methodname">Memcached::getResultCode</span> will return
   the result code for the last executed delete operation, that is, the delete
   operation for the last element of <code class="parameter">keys</code>.
  </p>


name: Memcached.fetch
purpose: Fetch the next result
manual_id: memcached.fetch
version: PECL memcached >= 0.1.0
return_type: false
return_description:
<p class="para">
   Returns the next result or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
   The  <span class="methodname">Memcached::getResultCode</span> will return
   <strong><code><a href="memcached.constants.html#memcached.constants.res-end">Memcached::RES_END</a></code></strong> if result set is exhausted.
  </p>


name: Memcached.fetchAll
purpose: Fetch all the remaining results
manual_id: memcached.fetchall
version: PECL memcached >= 0.1.0
return_type: false
return_description:
<p class="para">
   Returns the results or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   Use  <span class="methodname">Memcached::getResultCode</span> if necessary.
  </p>


name: Memcached.flush
purpose: Invalidate all items in the cache
manual_id: memcached.flush
version: PECL memcached >= 0.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   Use  <span class="methodname">Memcached::getResultCode</span> if necessary.
  </p>


name: Memcached.get
purpose: Retrieve an item
manual_id: memcached.get
version: PECL memcached >= 0.1.0
return_type: mixed
return_description:
<p class="para">
   Returns the value stored in the cache or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
   If the <code class="parameter">get_flags</code> is set to <strong><code><a href="memcached.constants.html#memcached.constants.get-extended">Memcached::GET_EXTENDED</a></code></strong>,
   an array containing the value and the CAS token is returned instead of only the value.
   The  <span class="methodname">Memcached::getResultCode</span> will return
   <strong><code><a href="memcached.constants.html#memcached.constants.res-notfound">Memcached::RES_NOTFOUND</a></code></strong> if the key does not exist.
  </p>


name: Memcached.getAllKeys
purpose: Gets the keys stored on all the servers
manual_id: memcached.getallkeys
version: PECL memcached >= 2.0.0
return_type: false
return_description:
<p class="para">
   Returns the keys stored on all the servers on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Memcached.getByKey
purpose: Retrieve an item from a specific server
manual_id: memcached.getbykey
version: PECL memcached >= 0.1.0
return_type: mixed
return_description:
<p class="para">
   Returns the value stored in the cache or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
   The  <span class="methodname">Memcached::getResultCode</span> will return
   <strong><code><a href="memcached.constants.html#memcached.constants.res-notfound">Memcached::RES_NOTFOUND</a></code></strong> if the key does not exist.
  </p>


name: Memcached.getMulti
purpose: Retrieve multiple items
manual_id: memcached.getmulti
version: PECL memcached >= 0.1.0
return_type: false
return_description:
<p class="para">
   Returns the array of found items or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   Use  <span class="methodname">Memcached::getResultCode</span> if necessary.
  </p>


name: Memcached.getOption
purpose: Retrieve a Memcached option value
manual_id: memcached.getoption
version: PECL memcached >= 0.1.0
return_type: mixed
return_description:
<p class="para">
   Returns the value of the requested option, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   error.
  </p>


name: Memcached.getServerByKey
purpose: Map a key to a server
manual_id: memcached.getserverbykey
version: PECL memcached >= 0.1.0
return_type: false
return_description:
<p class="para">
   Returns an array containing three keys of <code class="literal">host</code>,
   <code class="literal">port</code>, and <code class="literal">weight</code> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   Use  <span class="methodname">Memcached::getResultCode</span> if necessary.
  </p>


name: Memcached.getStats
purpose: Get server pool statistics
manual_id: memcached.getstats
version: PECL memcached >= 0.1.0
return_type: false
return_description:
<p class="para">
   Array of server statistics, one entry per server,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Memcached.increment
purpose: Increment numeric item's value
manual_id: memcached.increment
version: PECL memcached >= 0.1.0
return_type: false
return_description:
<p class="para">
   Returns new item&#039;s value on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Memcached.isPersistent
purpose: Check if a persitent connection to memcache is being used
manual_id: memcached.ispersistent
version: PECL memcached >= 2.0.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if Memcache instance uses a persistent connection, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Memcached.isPristine
purpose: Check if the instance was recently created
manual_id: memcached.ispristine
version: PECL memcached >= 2.0.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if instance is recently created, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Memcached.replace
purpose: Replace the item under an existing key
manual_id: memcached.replace
version: PECL memcached >= 0.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   The  <span class="methodname">Memcached::getResultCode</span> will return
   <strong><code><a href="memcached.constants.html#memcached.constants.res-notstored">Memcached::RES_NOTSTORED</a></code></strong> if the key does not exist.
  </p>


name: checkdnsrr
purpose: Check DNS records corresponding to a given Internet host name or IP address
manual_id: function.checkdnsrr
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if any records are found; returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if no records
   were found or if an error occurred.
  </p>


name: dns_get_record
purpose: Fetch DNS Resource Records associated with a hostname
manual_id: function.dns-get-record
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   This function returns an array of associative arrays,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. Each associative array contains
   <em>at minimum</em> the following keys:
   <table class="doctable table">
    <caption><strong>Basic DNS attributes</strong></caption>
    
     <thead>
      <tr>
       <th>Attribute</th>
       <th>Meaning</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>host</td>
       <td>
        The record in the DNS namespace to which the rest of the associated data refers.
       </td>
      </tr>

      <tr>
       <td>class</td>
       <td>
        <span class="function">dns_get_record</span> only returns Internet class records and as
        such this parameter will always return <code class="literal">IN</code>.
       </td>
      </tr>

      <tr>
       <td>type</td>
       <td>
        String containing the record type.  Additional attributes will also be contained
        in the resulting array dependant on the value of type. See table below.
       </td>
      </tr>

      <tr>
       <td>ttl</td>
       <td>
        <code class="literal">&quot;Time To Live&quot;</code> remaining for this record. This will <em>not</em> equal
        the record&#039;s original ttl, but will rather equal the original ttl minus whatever
        length of time has passed since the authoritative name server was queried.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
  <p class="para">
   <table class="doctable table">
    <caption><strong>Other keys in associative arrays dependant on &#039;type&#039;</strong></caption>
    
     <thead>
      <tr>
       <th>Type</th>
       <th>Extra Columns</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><code class="literal">A</code></td>
       <td>
        <code class="literal">ip</code>: An IPv4 addresses in dotted decimal notation.
       </td>
      </tr>

      <tr>
       <td><code class="literal">MX</code></td>
       <td>
        <code class="literal">pri</code>: Priority of mail exchanger.
        Lower numbers indicate greater priority.
        <code class="literal">target</code>: FQDN of the mail exchanger.
        See also <span class="function">dns_get_mx</span>.
       </td>
      </tr>

      <tr>
       <td><code class="literal">CNAME</code></td>
       <td>
        <code class="literal">target</code>: FQDN of location in DNS namespace to which
        the record is aliased.
       </td>
      </tr>

      <tr>
       <td><code class="literal">NS</code></td>
       <td>
        <code class="literal">target</code>: FQDN of the name server which is authoritative
        for this hostname.
       </td>
      </tr>

      <tr>
       <td><code class="literal">PTR</code></td>
       <td>
        <code class="literal">target</code>: Location within the DNS namespace to which
        this record points.
       </td>
      </tr>

       <tr>
       <td><code class="literal">TXT</code></td>
       <td>
        <code class="literal">txt</code>: Arbitrary string data associated with this record.
       </td>
      </tr>

      <tr>
       <td><code class="literal">HINFO</code></td>
       <td>
        <code class="literal">cpu</code>: IANA number designating the CPU of the machine
        referenced by this record.
        <code class="literal">os</code>: IANA number designating the Operating System on
        the machine referenced by this record.
        See IANA&#039;s <a href="http://www.iana.org/assignments/operating-system-names" class="link external">&raquo;&nbsp;<code class="literal">Operating System
        Names</code></a> for the meaning of these values.
       </td>
      </tr>

      <tr>
       <td><code class="literal">CAA</code></td>
       <td>
        <code class="literal">flags</code>: A one-byte bitfield; currently only bit 0 is defined,
        meaning &#039;critical&#039;; other bits are reserved and should be ignored.
        <code class="literal">tag</code>: The CAA tag name (alphanumeric ASCII string).
        <code class="literal">value</code>: The CAA tag value (binary string, may use subformats).
        For additional information see: <a href="http://www.faqs.org/rfcs/rfc6844" class="link external">&raquo;&nbsp;RFC 6844</a>
       </td>
      </tr>

      <tr>
       <td><code class="literal">SOA</code></td>
       <td>
        <code class="literal">mname</code>: FQDN of the machine from which the resource
        records originated.
        <code class="literal">rname</code>: Email address of the administrative contact
        for this domain.
        <code class="literal">serial</code>: Serial # of this revision of the requested
        domain.
        <code class="literal">refresh</code>: Refresh interval (seconds) secondary name
        servers should use when updating remote copies of this domain.
        <code class="literal">retry</code>: Length of time (seconds) to wait after a
        failed refresh before making a second attempt.
        <code class="literal">expire</code>: Maximum length of time (seconds) a secondary
        DNS server should retain remote copies of the zone data without a
        successful refresh before discarding.
        <code class="literal">minimum-ttl</code>: Minimum length of time (seconds) a
        client can continue to use a DNS resolution before it should request
        a new resolution from the server.  Can be overridden by individual
        resource records.
       </td>
      </tr>

      <tr>
       <td><code class="literal">AAAA</code></td>
       <td>
        <code class="literal">ipv6</code>: IPv6 address
       </td>
      </tr>

      <tr>
       <td><code class="literal">A6</code></td>
       <td>
        <code class="literal">masklen</code>: Length (in bits) to inherit from the target
        specified by <code class="parameter">chain</code>.
        <code class="literal">ipv6</code>: Address for this specific record to merge with
        <code class="parameter">chain</code>.
        <code class="literal">chain</code>: Parent record to merge with
        <code class="parameter">ipv6</code> data.
       </td>
      </tr>

      <tr>
       <td><code class="literal">SRV</code></td>
       <td>
        <code class="literal">pri</code>: (Priority) lowest priorities should be used first.
        <code class="literal">weight</code>: Ranking to weight which of commonly prioritized
        <code class="parameter">targets</code> should be chosen at random.
        <code class="literal">target</code> and <code class="literal">port</code>: hostname and port
        where the requested service can be found.
        For additional information see: <a href="http://www.faqs.org/rfcs/rfc2782" class="link external">&raquo;&nbsp;RFC 2782</a>
       </td>
      </tr>

      <tr>
       <td><code class="literal">NAPTR</code></td>
       <td>
        <code class="literal">order</code> and <code class="literal">pref</code>: Equivalent to
        <code class="parameter">pri</code> and <code class="parameter">weight</code> above.
        <code class="literal">flags</code>, <code class="literal">services</code>, <code class="literal">regex</code>,
        and <code class="literal">replacement</code>: Parameters as defined by
        <a href="http://www.faqs.org/rfcs/rfc2915" class="link external">&raquo;&nbsp;RFC 2915</a>.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: fsockopen
purpose: Open Internet or Unix domain socket connection
manual_id: function.fsockopen
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">fsockopen</span> returns a file pointer which may be used
   together with the other file functions (such as
   <span class="function">fgets</span>, <span class="function">fgetss</span>,
   <span class="function">fwrite</span>, <span class="function">fclose</span>, and
   <span class="function">feof</span>). If the call fails, it will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>

errors:
<p class="para">
   Throws <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> if <code class="parameter">hostname</code> is
   not a valid domain.
  </p>


name: gethostbyaddr
purpose: Get the Internet host name corresponding to a given IP address
manual_id: function.gethostbyaddr
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the host name on success, the unmodified <code class="parameter">ip</code>
   on failure, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on malformed input.
  </p>


name: gethostbyname
purpose: Get the IPv4 address corresponding to a given Internet host name
manual_id: function.gethostbyname
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the IPv4 address or a string containing the unmodified
   <code class="parameter">hostname</code> on failure.
  </p>


name: gethostbynamel
purpose: Get a list of IPv4 addresses corresponding to a given Internet host name
manual_id: function.gethostbynamel
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of IPv4 addresses or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if
   <code class="parameter">hostname</code> could not be resolved.
  </p>


name: gethostname
purpose: Gets the host name
manual_id: function.gethostname
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a string with the hostname on success, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is 
   returned.
  </p>


name: getprotobyname
purpose: Get protocol number associated with protocol name
manual_id: function.getprotobyname
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the protocol number,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: getprotobynumber
purpose: Get protocol name associated with protocol number
manual_id: function.getprotobynumber
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the protocol name as a string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: getservbyname
purpose: Get port number associated with an Internet service and protocol
manual_id: function.getservbyname
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the port number, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">service</code> or
   <code class="parameter">protocol</code> is not found.
  </p>


name: getservbyport
purpose: Get Internet service which corresponds to port and protocol
manual_id: function.getservbyport
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the Internet service name as a string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: header
purpose: Send a raw HTTP header
manual_id: function.header
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   On failure to schedule the header to be sent, <span class="function">header</span>
   issues an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error.
  </p>


name: headers_sent
purpose: Checks if or where headers have been sent
manual_id: function.headers-sent
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <span class="function">headers_sent</span> will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if no HTTP headers
   have already been sent or <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> otherwise.
  </p>


name: http_response_code
purpose: Get or Set the HTTP response code
manual_id: function.http-response-code
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   If <code class="parameter">response_code</code> is provided, then the previous
   status code will be returned. If <code class="parameter">response_code</code> is not
   provided, then the current status code will be returned. Both of these
   values will default to a <code class="literal">200</code> status code if used in a web
   server environment.
  </p>
  <p class="para">
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> will be returned if <code class="parameter">response_code</code> is not
   provided and it is not invoked in a web server environment (such as from a
   CLI application). <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> will be returned if
   <code class="parameter">response_code</code> is provided and it is not invoked in a
   web server environment (but only when no previous response status has been
   set).
  </p>


name: inet_ntop
purpose: Converts a packed internet address to a human readable representation
manual_id: function.inet-ntop
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a string representation of the address or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: inet_pton
purpose: Converts a human readable IP address to its packed in_addr representation
manual_id: function.inet-pton
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the <code class="literal">in_addr</code> representation of the given
   <code class="parameter">ip</code>, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if a syntactically invalid
   <code class="parameter">ip</code> is given (for example, an IPv4 address
   without dots or an IPv6 address without colons).
  </p>


name: ip2long
purpose: Converts a string containing an (IPv4) Internet Protocol dotted address into a long integer
manual_id: function.ip2long
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the long integer or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">ip</code>
   is invalid.
  </p>


name: long2ip
purpose: Converts a long integer address into a string in (IPv4) Internet standard dotted format
manual_id: function.long2ip
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the Internet IP address as a string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: net_get_interfaces
purpose: Get network interfaces
manual_id: function.net-get-interfaces
version: PHP 7 >= 7.3, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an associative <span class="type">array</span> where the key is the name of the interface and
   the value an associative array of interface attributes,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   Each interface associative array contains:
   <table class="doctable table">
    <caption><strong>Interface attributes</strong></caption>
    
     <thead>
      <tr>
       <th>Name</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>description</td>
       <td>
        Optional string value for description of the interface.
        Windows only.
       </td>
      </tr>

      <tr>
       <td>mac</td>
       <td>
        Optional string value for MAC address of the interface.
        Windows only.
       </td>
      </tr>

      <tr>
       <td>mtu</td>
       <td>
        Integer value for Maximum transmission unit (MTU) of the interface.
        Windows only.
       </td>
      </tr>

      <tr>
       <td>unicast</td>
       <td>
        Array of associative arrays, see Unicast attributes below.
       </td>
      </tr>

      <tr>
       <td>up</td>
       <td>
        Boolean status (on/off) for interface.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
  <p class="para">
   <table class="doctable table">
    <caption><strong>Unicast attributes</strong></caption>
    
     <thead>
      <tr>
       <th>Name</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>flags</td>
       <td>
        Integer value.
       </td>
      </tr>

      <tr>
       <td>family</td>
       <td>
        Integer value.
       </td>
      </tr>

      <tr>
       <td>address</td>
       <td>
        String value for address in either IPv4 or IPv6.
       </td>
      </tr>

      <tr>
       <td>netmask</td>
       <td>
        String value for netmask in either IPv4 or IPv6.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>

errors:
<p class="para">
   Emits an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> on failure to get interface information.
  </p>


name: pfsockopen
purpose: Open persistent Internet or Unix domain socket connection
manual_id: function.pfsockopen
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">pfsockopen</span> returns a file pointer which may be used
   together with the other file functions (such as
   <span class="function">fgets</span>, <span class="function">fgetss</span>,
   <span class="function">fwrite</span>, <span class="function">fclose</span>, and
   <span class="function">feof</span>), or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: setcookie
purpose: Send a cookie
manual_id: function.setcookie
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   If output exists prior to calling this function,
   <span class="function">setcookie</span> will fail and return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. If
   <span class="function">setcookie</span> successfully runs, it will return <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.
   This does not indicate whether the user accepted the cookie.
  </p>


name: rrd_first
purpose: Gets the timestamp of the first sample from rrd file
manual_id: function.rrd-first
version: PECL rrd >= 0.9.0
return_type: int
return_description:
<p class="para">
   Integer number of unix timestamp, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: rrd_graph
purpose: Creates image from a data
manual_id: function.rrd-graph
version: PECL rrd >= 0.9.0
return_type: array
return_description:
<p class="para">
   Array with information about generated image is returned, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: rrd_info
purpose: Gets information about rrd file
manual_id: function.rrd-info
version: PECL rrd >= 0.9.0
return_type: array
return_description:
<p class="para">
   Array with information about requested RRD file, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: rrd_lastupdate
purpose: Gets information about last updated data
manual_id: function.rrd-lastupdate
version: PECL rrd >= 0.9.0
return_type: array
return_description:
<p class="para">
   Array of information about last update, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: rrd_xport
purpose: Exports the information about RRD database
manual_id: function.rrd-xport
version: PECL rrd >= 0.9.0
return_type: array
return_description:
<p class="para">
   Array with information about RRD database file, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: RRDGraph.save
purpose: Saves the result of query into image
manual_id: rrdgraph.save
version: PECL rrd >= 0.9.0
return_type: array
return_description:
<p class="para">
   Returns array with information about generated image, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: RRDGraph.saveVerbose
purpose: Saves the RRD database query into image and returns the verbose information about generated graph
manual_id: rrdgraph.saveverbose
version: PECL rrd >= 0.9.0
return_type: array
return_description:
<p class="para">
   Returns array with detailed information about generated image, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: scoutapm_get_calls
purpose: Returns a list of instrumented calls that have occurred
manual_id: function.scoutapm-get-calls
version: PECL scoutapm >= 1.0.0
return_type: array
return_description:
<p class="para">
   <span class="function">scoutapm_get_calls</span> returns an array containing a list
   of all recorded calls to instrumented function calls.
  </p>


name: scoutapm_list_instrumented_functions
purpose: List functions scoutapm will instrument.
manual_id: function.scoutapm-list-instrumented-functions
version: PECL scoutapm >= 1.0.2
return_type: array
return_description:
<p class="para">
   <span class="function">scoutapm_list_instrumented_functions</span> returns an array
   containing a list of all functions that the scoutapm extension is able to
   instrument in the current installation.
  </p>


name: snmp_get_quick_print
purpose: Fetches the current value of the NET-SNMP library's quick_print setting
manual_id: function.snmp-get-quick-print
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if quick_print is on, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: snmp_get_valueretrieval
purpose: Return the method how the SNMP values will be returned
manual_id: function.snmp-get-valueretrieval
version: PHP 4 >= 4.3.3, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   OR-ed combitantion of constants ( <strong><code><a href="snmp.constants.html#constant.snmp-value-library">SNMP_VALUE_LIBRARY</a></code></strong> or
   <strong><code><a href="snmp.constants.html#constant.snmp-value-plain">SNMP_VALUE_PLAIN</a></code></strong> ) with
   possible SNMP_VALUE_OBJECT set.
  </p>


name: snmp2_get
purpose: Fetch an SNMP object
manual_id: function.snmp2-get
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns <acronym class="acronym">SNMP</acronym> object value on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: snmp2_getnext
purpose: Fetch the SNMP object which follows the given object id
manual_id: function.snmp2-getnext
version: PHP >= 5.2.0, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns <acronym class="acronym">SNMP</acronym> object value on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
   In case of an error, an E_WARNING message is shown.
  </p>


name: snmp2_real_walk
purpose: Return all objects including their respective object ID within the specified one
manual_id: function.snmp2-real-walk
version: PHP >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an associative array of the <acronym class="acronym">SNMP</acronym> object ids and their values on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
   In case of an error, an E_WARNING message is shown.
  </p>


name: snmp2_set
purpose: Set the value of an SNMP object
manual_id: function.snmp2-set
version: PHP >= 5.2.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   If the SNMP host rejects the data type, an E_WARNING message like &quot;Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length.&quot; is shown.
   If an unknown or invalid OID is specified the warning probably reads &quot;Could not add variable&quot;.
  </p>


name: snmp2_walk
purpose: Fetch all the SNMP objects from an agent
manual_id: function.snmp2-walk
version: PHP >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of <acronym class="acronym">SNMP</acronym> object values starting from the
   <code class="parameter">object_id</code> as root or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: snmp3_real_walk
purpose: Return all objects including their respective object ID within the specified one
manual_id: function.snmp3-real-walk
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an associative array of the
   <acronym class="acronym">SNMP</acronym> object ids and their values on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
   In case of an error, an E_WARNING message is shown.
  </p>


name: snmpwalkoid
purpose: Query for a tree of information about a network entity
manual_id: function.snmpwalkoid
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an associative array with object ids and their respective
   object value starting from the <code class="parameter">object_id</code>
   as root or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: SNMP.__construct
purpose: Creates SNMP instance representing session to remote SNMP agent
manual_id: snmp.construct
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
errors:
<p class="para">
    <span class="methodname">SNMP::__construct</span> throws an exception when
   parameters count or types are wrong or unknown <acronym class="acronym">SNMP</acronym>
   protocol version specified.
  </p>


name: SNMP.get
purpose: Fetch an SNMP object
manual_id: snmp.get
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns <acronym class="acronym">SNMP</acronym> objects requested as string or array
   depending on <code class="parameter">objectId</code> type or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>

errors:
<p class="para">
 This method does not throw any exceptions by default.
 To enable throwing an SNMPException exception when some of library errors occur
 the SNMP class parameter <code class="parameter">exceptions_enabled</code>
 should be set to a corresponding value. See <a href="class.snmp.html#snmp.props.exceptions-enabled" class="link">
 <code class="parameter">SNMP::$exceptions_enabled</code> explanation</a> for more details.
</p>


name: SNMP.walk
purpose: Fetch SNMP object subtree
manual_id: snmp.walk
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an associative array of the <acronym class="acronym">SNMP</acronym> object ids and their values on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
   When a <acronym class="acronym">SNMP</acronym> error occures  <span class="methodname">SNMP::getErrno</span> and
    <span class="methodname">SNMP::getError</span> can be used for retrieving error
   number (specific to SNMP extension, see class constants) and error message
   respectively.
  </p>


name: socket_accept
purpose: Accepts a connection on a socket
manual_id: function.socket-accept
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a new <span class="classname">Socket</span> instance on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error. The actual
   error code can be retrieved by calling
   <span class="function">socket_last_error</span>. This error code may be passed to
   <span class="function">socket_strerror</span> to get a textual explanation of the
   error.
  </p>


name: socket_addrinfo_bind
purpose: Create and bind to a socket from a given addrinfo
manual_id: function.socket-addrinfo-bind
version: PHP 7 >= 7.2.0, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a <span class="classname">Socket</span> instance on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: socket_addrinfo_explain
purpose: Get information about addrinfo
manual_id: function.socket-addrinfo-explain
version: PHP 7 >= 7.2.0, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array containing the fields in the <code class="literal">addrinfo</code> structure.
  </p>


name: socket_addrinfo_lookup
purpose: Get array with contents of getaddrinfo about the given hostname
manual_id: function.socket-addrinfo-lookup
version: PHP 7 >= 7.2.0, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of <span class="classname">AddressInfo</span> instances that can be used with the other socket_addrinfo functions.
   On failure, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: socket_bind
purpose: Binds a name to a socket
manual_id: function.socket-bind
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   The error code can be retrieved with <span class="function">socket_last_error</span>.
   This code may be passed to <span class="function">socket_strerror</span> to get a
   textual explanation of the error.
  </p>


name: socket_connect
purpose: Initiates a connection on a socket
manual_id: function.socket-connect
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. The error code can be retrieved with
   <span class="function">socket_last_error</span>. This code may be passed to
   <span class="function">socket_strerror</span> to get a textual explanation of the
   error.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    If the socket is non-blocking then this function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> with an
    error <code class="literal">Operation now in progress</code>.
   </p>
  </p></blockquote>


name: socket_create_listen
purpose: Opens a socket on port to accept connections
manual_id: function.socket-create-listen
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">socket_create_listen</span> returns a new <span class="classname">Socket</span> instance
   on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error. The error code can be retrieved with
   <span class="function">socket_last_error</span>. This code may be passed to
   <span class="function">socket_strerror</span> to get a textual explanation of the
   error.
  </p>


name: socket_create
purpose: Create a socket (endpoint for communication)
manual_id: function.socket-create
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">socket_create</span> returns a <span class="classname">Socket</span> instance on success,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error. The actual error code can be retrieved by calling
   <span class="function">socket_last_error</span>. This error code may be passed to
   <span class="function">socket_strerror</span> to get a textual explanation of the
   error.
  </p>

errors:
<p class="para">
   If an invalid <code class="parameter">domain</code> or
   <code class="parameter">type</code> is given, <span class="function">socket_create</span>
   defaults to <strong><code><a href="sockets.constants.html#constant.af-inet">AF_INET</a></code></strong> and
   <strong><code><a href="sockets.constants.html#constant.sock-stream">SOCK_STREAM</a></code></strong> respectively and additionally emits an
   <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> message.
  </p>


name: socket_export_stream
purpose: Export a socket into a stream that encapsulates a socket
manual_id: function.socket-export-stream
version: PHP 7 >= 7.0.7, PHP 8
return_type: false
return_description:
<p class="para">
   Return resource or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: socket_get_option
purpose: Gets socket options for the socket
manual_id: function.socket-get-option
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the value of the given option,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: socket_getpeername
manual_id: function.socket-getpeername
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: bool
purpose:
Queries the remote side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type

return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. <span class="function">socket_getpeername</span> may also return
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the socket type is not any of <strong><code><a href="sockets.constants.html#constant.af-inet">AF_INET</a></code></strong>,
   <strong><code><a href="sockets.constants.html#constant.af-inet6">AF_INET6</a></code></strong>, or <strong><code><a href="sockets.constants.html#constant.af-unix">AF_UNIX</a></code></strong>, in which
   case the last socket error code is <em>not</em> updated.
  </p>


name: socket_getsockname
manual_id: function.socket-getsockname
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: bool
purpose:
Queries the local side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type

return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. <span class="function">socket_getsockname</span> may also return
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the socket type is not any of <strong><code><a href="sockets.constants.html#constant.af-inet">AF_INET</a></code></strong>,
   <strong><code><a href="sockets.constants.html#constant.af-inet6">AF_INET6</a></code></strong>, or <strong><code><a href="sockets.constants.html#constant.af-unix">AF_UNIX</a></code></strong>, in which
   case the last socket error code is <em>not</em> updated.
  </p>


name: socket_import_stream
purpose: Import a stream
manual_id: function.socket-import-stream
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: socket_listen
purpose: Listens for a connection on a socket
manual_id: function.socket-listen
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. The error code can be retrieved with
   <span class="function">socket_last_error</span>. This code may be passed to
   <span class="function">socket_strerror</span> to get a textual explanation of the
   error.
  </p>


name: socket_read
purpose: Reads a maximum of length bytes from a socket
manual_id: function.socket-read
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">socket_read</span> returns the data as a string on success,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error (including if the remote host has closed the
   connection). The error code can be retrieved with
   <span class="function">socket_last_error</span>. This code may be passed to
   <span class="function">socket_strerror</span> to get a textual representation of
   the error.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    <span class="function">socket_read</span> returns a zero length string (&quot;&quot;)
    when there is no more data to read.
   </p>
  </p></blockquote>


name: socket_recv
purpose: Receives data from a connected socket
manual_id: function.socket-recv
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">socket_recv</span> returns the number of bytes received,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there was an error. The actual error code can be retrieved by 
   calling <span class="function">socket_last_error</span>. This error code may be
   passed to <span class="function">socket_strerror</span> to get a textual explanation
   of the error.
  </p>


name: socket_recvfrom
purpose: Receives data from a socket whether or not it is connection-oriented
manual_id: function.socket-recvfrom
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">socket_recvfrom</span> returns the number of bytes received,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there was an error. The actual error code can be retrieved by 
   calling <span class="function">socket_last_error</span>. This error code may be
   passed to <span class="function">socket_strerror</span> to get a textual explanation
   of the error.
  </p>


name: socket_select
purpose: Runs the select() system call on the given arrays of sockets with a specified timeout
manual_id: function.socket-select
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   On success <span class="function">socket_select</span> returns the number of
   sockets contained in the modified arrays, which may be zero if
   the timeout expires before anything interesting happens.On error <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   is returned. The error code can be retrieved with
   <span class="function">socket_last_error</span>.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    Be sure to use the <code class="literal">===</code> operator when checking for an
    error. Since the <span class="function">socket_select</span> may return 0 the
    comparison with <code class="literal">==</code> would evaluate to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>:
    <div class="example" id="example-22">
     <p><strong>Example # Understanding <span class="function">socket_select</span>&#039;s result</strong></p>
     <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$e </span><span style="color: #007700">= </span><span style="color: #0000BB">NULL</span><span style="color: #007700">;<br />if (</span><span style="color: #0000BB">false </span><span style="color: #007700">=== </span><span style="color: #0000BB">socket_select</span><span style="color: #007700">(</span><span style="color: #0000BB">$r</span><span style="color: #007700">, </span><span style="color: #0000BB">$w</span><span style="color: #007700">, </span><span style="color: #0000BB">$e</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">)) {<br />    echo </span><span style="color: #DD0000">"socket_select() failed, reason: " </span><span style="color: #007700">.<br />        </span><span style="color: #0000BB">socket_strerror</span><span style="color: #007700">(</span><span style="color: #0000BB">socket_last_error</span><span style="color: #007700">()) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
     </div>

    </div>
   </p>
  </p></blockquote>


name: socket_send
purpose: Sends data to a connected socket
manual_id: function.socket-send
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">socket_send</span> returns the number of bytes sent, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error. 
  </p>


name: socket_sendmsg
purpose: Send a message
manual_id: function.socket-sendmsg
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the number of bytes sent,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: socket_sendto
purpose: Sends a message to a socket, whether it is connected or not
manual_id: function.socket-sendto
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">socket_sendto</span> returns the number of bytes sent to the
   remote host, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>


name: socket_strerror
purpose: Return a string describing a socket error
manual_id: function.socket-strerror
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the error message associated with the <code class="parameter">error_code</code>
   parameter.
  </p>


name: socket_write
purpose: Write to a socket
manual_id: function.socket-write
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the number of bytes successfully written to the socket or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   The error code can be retrieved with
   <span class="function">socket_last_error</span>. This code may be passed to
   <span class="function">socket_strerror</span> to get a textual explanation of the
   error.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    It is perfectly valid for <span class="function">socket_write</span> to
    return zero which means no bytes have been written. Be sure to use the
    <code class="literal">===</code> operator to check for <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> in case of an
    error.
   </p>
  </p></blockquote>


name: socket_wsaprotocol_info_export
purpose: Exports the WSAPROTOCOL_INFO Structure
manual_id: function.socket-wsaprotocol-info-export
version: PHP 7 >= 7.3.0, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an identifier to be used for the import,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: socket_wsaprotocol_info_import
purpose: Imports a Socket from another Process
manual_id: function.socket-wsaprotocol-info-import
version: PHP 7 >= 7.3.0, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a <span class="classname">Socket</span> instance on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: ssh2_auth_none
purpose: Authenticate as "none"
manual_id: function.ssh2-auth-none
version: PECL ssh2 >= 0.9.0
return_type: mixed
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the server does accept &quot;none&quot; as an authentication
   method, or an array of accepted authentication methods on failure.
  </p>


name: ssh2_connect
purpose: Connect to an SSH server
manual_id: function.ssh2-connect
version: PECL ssh2 >= 0.9.0
return_type: false
return_description:
<p class="para">
   Returns a resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: ssh2_exec
purpose: Execute a command on a remote server
manual_id: function.ssh2-exec
version: PECL ssh2 >= 0.9.0
return_type: false
return_description:
<p class="para">
   Returns a stream on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ssh2_forward_listen
purpose: Bind a port on the remote server and listen for connections
manual_id: function.ssh2-forward-listen
version: PECL ssh2 >= 0.9.0
return_type: false
return_description:
<p class="para">
   Returns an SSH2 Listener,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ssh2_publickey_init
purpose: Initialize Publickey subsystem
manual_id: function.ssh2-publickey-init
version: PECL ssh2 >= 0.10
return_type: false
return_description:
<p class="para">
   Returns an <code class="literal">SSH2 Publickey Subsystem</code> resource for use
   with all other ssh2_publickey_*() methods or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ssh2_publickey_list
purpose: List currently authorized publickeys
manual_id: function.ssh2-publickey-list
version: PECL ssh2 >= 0.10
return_type: array
return_description:
<p class="para">
   Returns a numerically indexed array of keys,
   each of which is an associative array containing:
   name, blob, and attrs elements.
  </p>
  <p class="para">
   <table class="doctable table">
    <caption><strong>Publickey elements</strong></caption>
    
     <thead>
      <tr>
       <th>Array Key</th>
       <th>Meaning</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>name</td>
       <td>Name of algorithm used by this publickey, for example:
       <code class="literal">ssh-dss</code> or <code class="literal">ssh-rsa</code>.</td>
      </tr>

      <tr>
       <td>blob</td>
       <td>Publickey blob as raw binary data.</td>
      </tr>

      <tr>
       <td>attrs</td>
       <td>Attributes assigned to this publickey. The most common
       attribute, and the only one supported by publickey version 1
       servers, is <code class="literal">comment</code>, which may be any freeform
       string.</td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: ssh2_sftp_lstat
purpose: Stat a symbolic link
manual_id: function.ssh2-sftp-lstat
version: PECL ssh2 >= 0.9.0
return_type: array
return_description:
<p class="para">
   See the documentation for <span class="function">stat</span> for details on the
   values which may be returned.
  </p>


name: ssh2_sftp
purpose: Initialize SFTP subsystem
manual_id: function.ssh2-sftp
version: PECL ssh2 >= 0.9.0
return_type: false
return_description:
<p class="para">
   This method returns an <code class="literal">SSH2 SFTP</code> resource for use with
   all other ssh2_sftp_*() methods and the
   <a href="wrappers.ssh2.html" class="link">ssh2.sftp://</a> fopen wrapper,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ssh2_shell
purpose: Request an interactive shell
manual_id: function.ssh2-shell
version: PECL ssh2 >= 0.9.0
return_type: false
return_description:
<p class="para">
   Returns a stream <a href="language.types.resource.html" class="link">resource</a> on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: stomp_connect_error
purpose: Returns a string description of the last connect error
manual_id: function.stomp-connect-error
version: PECL stomp >= 0.3.0
return_type: string
return_description:
<p class="para">
   A string that describes the error, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if no error occurred. 
  </p>


name: Stomp.__construct
purpose: Opens a connection
manual_id: stomp.construct
version: PECL stomp >= 0.1.0
return_type: resource
return_description:
<blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">A transaction header may be specified, indicating that the message acknowledgment should be part of the named transaction.</p></p></blockquote>


name: Stomp.error
purpose: Gets the last stomp error
manual_id: stomp.error
version: PECL stomp >= 0.1.0
return_type: string
return_description:
<p class="para">
   Returns an error string or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if no error occurred.
  </p>


name: Stomp.getSessionId
purpose: Gets the current stomp session ID
manual_id: stomp.getsessionid
version: PECL stomp >= 0.1.0
return_type: false
return_description:
<p class="para">
    <span class="type">string</span> session id on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Stomp.hasFrame
purpose: Indicates whether or not there is a frame ready to read
manual_id: stomp.hasframe
version: PECL stomp >= 0.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a frame is ready to read, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Stomp.send
purpose: Sends a message
manual_id: stomp.send
version: PECL stomp >= 0.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. 
  </p>


name: SVM.__construct
purpose: Construct a new SVM object
manual_id: svm.construct
version: PECL svm >= 0.1.0
errors:
<p class="para">
   Throws a <span class="classname">SVMException</span> if the libsvm
   library could not be loaded.
  </p>


name: SVM.crossvalidate
purpose: Test training params on subsets of the training data
manual_id: svm.crossvalidate
version: PECL svm >= 0.1.0
return_type: float
return_description:
<p class="para">
   The correct percentage, expressed as a floating point number from 0-1. 
   In the case of NU_SVC or EPSILON_SVR kernels the mean squared error will 
   returned instead. 
  </p>


name: SVM.train
purpose: Create a SVMModel based on training data
manual_id: svm.train
version: PECL svm >= 0.1.0
return_type: SVMModel
return_description:
<p class="para">
   Returns an SVMModel that can be used to classify previously unseen data.
   Throws SVMException on error
  </p>


name: SVMModel.predict_probability
purpose: Return class probabilities for previous unseen data
manual_id: svmmodel.predict-probability
version: PECL svm >= 0.1.4
return_type: float
return_description:
<p class="para">
   Float the predicted value. This will be a class label in the case of 
   classification, a real value in the case of regression.
   Throws SVMException on error
  </p>


name: svn_auth_get_parameter
purpose: Retrieves authentication parameter
manual_id: function.svn-auth-get-parameter
version: PECL svn >= 0.1.0
return_type: string
return_description:
<p class="para">
   Returns the string value of the parameter at <code class="parameter">key</code>;
   returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if parameter does not exist.
  </p>


name: svn_blame
purpose: Get the SVN blame for a file
manual_id: function.svn-blame
version: PECL svn >= 0.3.0
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span> of SVN blame information separated by line
   which includes the revision number, line number, line of code,
   author, and date.
  </p>


name: svn_cat
purpose: Returns the contents of a file in a repository
manual_id: function.svn-cat
version: PECL svn >= 0.1.0
return_type: string
return_description:
<p class="para">
   Returns the string contents of the item from the repository on
   success, and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: svn_commit
purpose: Sends changes from the local working copy to the repository
manual_id: function.svn-commit
version: PECL svn >= 0.1.0
return_type: array
return_description:
<p class="para">
   Returns array in form of:
  </p>
    <div class="example-contents screen">
<div class="cdata"><pre>
array(
    0 =&gt; integer revision number of commit
    1 =&gt; string ISO 8601 date and time of commit
    2 =&gt; name of committer
)
</pre></div>
    </div>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: svn_diff
purpose: Recursively diffs two paths
manual_id: function.svn-diff
version: PECL svn >= 0.1.0
return_type: array
return_description:
<p class="para">
   Returns an array-list consisting of two streams: the first is the diff output
   and the second contains error stream output. The streams can be
   read using <span class="function">fread</span>. Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on
   error.
  </p>
  <p class="para">
   The diff output will, by default, be in the form of Subversion&#039;s
   custom unified diff format, but an
   <a href="http://svnbook.red-bean.com/en/1.2/svn.advanced.externaldifftools.html" class="link external">&raquo;&nbsp;external
   diff engine</a> may be
   used depending on Subversion&#039;s configuration.
  </p>


name: svn_fs_is_dir
purpose: Determines if a path points to a directory
manual_id: function.svn-fs-is-dir
version: PECL svn >= 0.2.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the path points to a directory, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: svn_fs_is_file
purpose: Determines if a path points to a file
manual_id: function.svn-fs-is-file
version: PECL svn >= 0.2.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the path points to a file, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: svn_log
purpose: Returns the commit log messages of a repository URL
manual_id: function.svn-log
version: PECL svn >= 0.1.0
return_type: array
return_description:
<p class="para">
   On success, this function returns an array file listing in the format
   of:
   <div class="example-contents screen">
<div class="cdata"><pre>
[0] =&gt; Array, ordered most recent (highest) revision first
(
    [rev] =&gt; integer revision number
    [author] =&gt; string author name
    [msg] =&gt; string log message
    [date] =&gt; string date formatted per ISO 8601, i.e. date(&#039;c&#039;)
    [paths] =&gt; Array, describing changed files
        (
            [0] =&gt; Array
                (
                    [action] =&gt; string letter signifying change
                    [path] =&gt;  absolute repository path of changed file
                )
            [1] =&gt; ...
        )
)
[1] =&gt; ...
</pre></div>
    </div>
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    The output will always be a numerically indexed array of arrays,
    even when there are none or only one log message(s).
   </p>
  </p></blockquote>
  <p class="para">
   The value of <var class="varname">action</var> is a subset of the
   <a href="http://svnbook.red-bean.com/en/1.2/svn.ref.svn.c.status.html" class="link external">&raquo;&nbsp;status output
   in the first column</a>, where possible values are:
  </p>
  <table class="doctable table">
   <caption><strong>Actions</strong></caption>
   
     <thead>
      <tr>
       <th>Letter</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>M</td>
       <td>Item/props was modified</td>
      </tr>

      <tr>
       <td>A</td>
       <td>Item was added</td>
      </tr>

      <tr>
       <td>D</td>
       <td>Item was deleted</td>
      </tr>

      <tr>
       <td>R</td>
       <td>Item was replaced</td>
      </tr>

     </tbody>
    
  </table>

  <p class="para">
   If no changes were made to the item, an empty array is returned.
  </p>


name: svn_ls
purpose: Returns list of directory contents in repository URL, optionally at revision number
manual_id: function.svn-ls
version: PECL svn >= 0.1.0
return_type: array
return_description:
<p class="para">
   On success, this function returns an array file listing in the format
   of:
   <div class="example-contents screen">
<div class="cdata"><pre>
[0] =&gt; Array
    (
        [created_rev] =&gt; integer revision number of last edit
        [last_author] =&gt; string author name of last edit
        [size] =&gt; integer byte file size of file
        [time] =&gt; string date of last edit in form &#039;M d H:i&#039;
                  or &#039;M d Y&#039;, depending on how old the file is
        [time_t] =&gt; integer unix timestamp of last edit
        [name] =&gt; name of file/directory
        [type] =&gt; type, can be &#039;file&#039; or &#039;dir&#039;
    )
[1] =&gt; ...
</pre></div>
    </div>
  </p>


name: svn_status
purpose: Returns the status of working copy files and directories
manual_id: function.svn-status
version: PECL svn >= 0.1.0
return_type: array
return_description:
<p class="para">
   Returns a numerically indexed array of associative arrays detailing
   the status of items in the repository:
  </p>
  <div class="example-contents screen">
<div class="cdata"><pre>
Array (
    [0] =&gt; Array (
        // information on item
    )
    [1] =&gt; ...
)
</pre></div>
  </div>
  <p class="para">
   The information on the item is an associative array that can contain
   the following keys:
  </p>
  <dl>
   
    <dt><var class="varname">path</var></dt>
     <dd>
      <span class="simpara">
       String path to file/directory of this entry on local filesystem.
      </span>
     </dd>
   
   
    <dt><var class="varname">text_status</var></dt>
     <dd>
      <span class="simpara">
       Status of item&#039;s text. Refer to <a href="svn.constants.html#svn.constants.status" class="link">status constants</a> for possible values.
      </span>
     </dd>
   
   
    <dt><var class="varname">repos_text_status</var></dt>
     <dd>
      <span class="simpara">
       Status of item&#039;s text in repository. Only accurate if
       <code class="parameter">update</code> was set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.
       Refer to <a href="svn.constants.html#svn.constants.status" class="link">status constants</a> for possible values.
      </span>
     </dd>
   
   
    <dt><var class="varname">prop_status</var></dt>
     <dd>
      <span class="simpara">
       Status of item&#039;s properties. Refer to <a href="svn.constants.html#svn.constants.status" class="link">status constants</a> for possible values.
      </span>
     </dd>
   
   
    <dt><var class="varname">repos_prop_status</var></dt>
     <dd>
      <span class="simpara">
       Status of item&#039;s property in repository. Only accurate if
       <code class="parameter">update</code> was set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>. Refer to <a href="svn.constants.html#svn.constants.status" class="link">status constants</a> for possible values.
      </span>
     </dd>
   
   
    <dt><var class="varname">locked</var></dt>
     <dd>
      <span class="simpara">
       Whether or not the item is locked. (Only set if <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.)
      </span>
     </dd>
   
   
    <dt><var class="varname">copied</var></dt>
     <dd>
      <span class="simpara">
       Whether or not the item was copied (scheduled for addition with
       history). (Only set if <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.)
      </span>
     </dd>
   
   
    <dt><var class="varname">switched</var></dt>
     <dd>
      <span class="simpara">
       Whether or not the item was switched using the switch command.
       (Only set if <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>)
      </span>
     </dd>
   
  </dl>
  <p class="para">
   These keys are only set if the item is versioned:
  </p>
  <dl>
   
    <dt><var class="varname">name</var></dt>
     <dd>
      <span class="simpara">
       Base name of item in repository.
      </span>
     </dd>
   
   
    <dt><var class="varname">url</var></dt>
     <dd>
      <span class="simpara">
       URL of item in repository.
      </span>
     </dd>
   
   
    <dt><var class="varname">repos</var></dt>
     <dd>
      <span class="simpara">
       Base URL of repository.
      </span>
     </dd>
   
   
    <dt><var class="varname">revision</var></dt>
     <dd>
      <span class="simpara">
       Integer revision of item in working copy.
      </span>
     </dd>
   
   
    <dt><var class="varname">kind</var></dt>
     <dd>
      <span class="simpara">
       Type of item, i.e. file or directory. Refer to <a href="svn.constants.html#svn.constants.type" class="link">type constants</a> for possible values.
      </span>
     </dd>
   
   
    <dt><var class="varname">schedule</var></dt>
     <dd>
      <span class="simpara">
       Scheduled action for item, i.e. addition or deletion. Constants
       for these magic numbers are not available, they can
       be emulated by using:
      </span>
       <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">if (!</span><span style="color: #0000BB">defined</span><span style="color: #007700">(</span><span style="color: #DD0000">'svn_wc_schedule_normal'</span><span style="color: #007700">)) {<br />    </span><span style="color: #0000BB">define</span><span style="color: #007700">(</span><span style="color: #DD0000">'svn_wc_schedule_normal'</span><span style="color: #007700">,  </span><span style="color: #0000BB">0</span><span style="color: #007700">); </span><span style="color: #FF8000">// nothing special<br />    </span><span style="color: #0000BB">define</span><span style="color: #007700">(</span><span style="color: #DD0000">'svn_wc_schedule_add'</span><span style="color: #007700">,     </span><span style="color: #0000BB">1</span><span style="color: #007700">); </span><span style="color: #FF8000">// item will be added<br />    </span><span style="color: #0000BB">define</span><span style="color: #007700">(</span><span style="color: #DD0000">'svn_wc_schedule_delete'</span><span style="color: #007700">,  </span><span style="color: #0000BB">2</span><span style="color: #007700">); </span><span style="color: #FF8000">// item will be deleted<br />    </span><span style="color: #0000BB">define</span><span style="color: #007700">(</span><span style="color: #DD0000">'svn_wc_schedule_replace'</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">); </span><span style="color: #FF8000">// item will be added and deleted<br /></span><span style="color: #007700">}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
      </div>

     </dd>
   
   
    <dt><var class="varname">deleted</var></dt>
     <dd>
      <span class="simpara">
       Whether or not the item was deleted, but parent revision lags
       behind. (Only set if <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.)
      </span>
     </dd>
   
   
    <dt><var class="varname">absent</var></dt>
     <dd>
      <span class="simpara">
       Whether or not the item is absent, that is, Subversion knows that
       there should be something there but there isn&#039;t. (Only set if
       <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.)
      </span>
     </dd>
   
   
    <dt><var class="varname">incomplete</var></dt>
     <dd>
      <span class="simpara">
       Whether or not the entries file for a directory is incomplete.
       (Only set if <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.)
      </span>
     </dd>
   
   
    <dt><var class="varname">cmt_date</var></dt>
     <dd>
      <span class="simpara">
       Integer Unix timestamp of last commit date. (Unaffected by <code class="parameter">update</code>.)
      </span>
     </dd>
   
   
    <dt><var class="varname">cmt_rev</var></dt>
     <dd>
      <span class="simpara">
       Integer revision of last commit. (Unaffected by <code class="parameter">update</code>.)
      </span>
     </dd>
   
   
    <dt><var class="varname">cmt_author</var></dt>
     <dd>
      <span class="simpara">
       String author of last commit. (Unaffected by <code class="parameter">update</code>.)
      </span>
     </dd>
   
   
    <dt><var class="varname">prop_time</var></dt>
     <dd>
      <span class="simpara">
       Integer Unix timestamp of last up-to-date time for properties
      </span>
     </dd>
   
   
    <dt><var class="varname">text_time</var></dt>
     <dd>
      <span class="simpara">
       Integer Unix timestamp of last up-to-date time for text
      </span>
     </dd>
   
   
  </dl>


name: svn_update
purpose: Update working copy
manual_id: function.svn-update
version: PECL svn >= 0.1.0
return_type: int
return_description:
<p class="para">
   Returns new revision number on success, returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: tcpwrap_check
purpose: Performs a tcpwrap check
manual_id: function.tcpwrap-check
version: PECL tcpwrap >= 0.1.0
return_type: bool
return_description:
<p class="para">
   This function returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if access should be granted, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: VarnishAdmin.auth
purpose: Authenticate on a varnish instance
manual_id: varnishadmin.auth
version: PECL varnish >= 0.3
return_type: bool
return_description:
<p class="para">
  Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: VarnishStat.getSnapshot
purpose: Get the current varnish instance statistics snapshot
manual_id: varnishstat.getsnapshot
version: PECL varnish >= 0.3
return_type: array
return_description:
<p class="para">
   Array with the varnish statistic snapshot. The array keys are identical to
   that in the varnishstat tool.
  </p>


name: yaz_addinfo
purpose: Returns additional error information
manual_id: function.yaz-addinfo
version: PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
return_type: string
return_description:
<p class="para">
   A string containing additional error information or an empty string if the
   last operation was successful or if no additional information was provided
   by the server.
  </p>


name: yaz_connect
purpose: Prepares for a connection to a Z39.50 server
manual_id: function.yaz-connect
version: PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
return_type: mixed
return_description:
<p class="para">
   A connection resource on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: yaz_errno
purpose: Returns error number
manual_id: function.yaz-errno
version: PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
return_type: int
return_description:
<p class="para">
   Returns an error code. The error code is either a Z39.50 diagnostic code
   (usually a Bib-1 diagnostic) or a client side error code which is 
   generated by PHP/YAZ itself, such as &quot;Connect failed&quot;, &quot;Init Rejected&quot;, 
   etc.  
  </p>


name: yaz_error
purpose: Returns error description
manual_id: function.yaz-error
version: PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
return_type: string
return_description:
<p class="para">
   Returns an error text message for server (last request), identified by
   parameter <code class="parameter">id</code>. An empty string is returned if the
   last operation was successful.
  </p>


name: yaz_es_result
purpose: Inspects Extended Services Result
manual_id: function.yaz-es-result
version: PHP 4 >= 4.2.0, PECL yaz >= 0.9.0
return_type: array
return_description:
<p class="para">
   Returns array with element <code class="literal">targetReference</code>
   for the reference for the extended service operation (generated
   and returned from the server).
  </p>


name: yaz_get_option
purpose: Returns value of option for connection
manual_id: function.yaz-get-option
version: PECL yaz >= 0.9.0
return_type: string
return_description:
<p class="para">
   Returns the value of the specified option or an empty string if the option
   wasn&#039;t set.
  </p>


name: yaz_hits
purpose: Returns number of hits for last search
manual_id: function.yaz-hits
version: PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
return_type: int
return_description:
<p class="para">
   Returns the number of hits for the last search or 0 if no search was 
   performed.
  </p>
  <p class="para">
   The search result array (if supplied) holds information that
   is returned by a Z39.50 server in the SearchResult-1
   format part of a search response.
   The SearchResult-1 format can be used to obtain information
   about hit counts for various parts of the query (subquery).
   In particular, it is possible to obtain hit counts for the individual
   search terms in a query. Information for first
   subquery is in $array[0], second subquery in $array[1], and so forth.
  </p>
  <table class="doctable table">
   <caption><strong>searchresult members</strong></caption>
   
    <col width="1*" />
    <col width="2*" />
    <thead>
     <tr>
      <th>Element</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td><code class="literal">id</code></td>
      <td>Sub query ID2 (string)</td>
     </tr>

     <tr>
      <td><code class="literal">count</code></td>
      <td>Result count / hits (integer)</td>
     </tr>

     <tr>
      <td><code class="literal">subquery.term</code></td>
      <td>Sub query term (string)</td>
     </tr>

     <tr>
      <td><code class="literal">interpretation.term</code></td>
      <td>Interpretated sub query term (string)</td>
     </tr>

     <tr>
      <td><code class="literal">recommendation.term</code></td>
      <td>Recommended sub query term (string)</td>
     </tr>

    </tbody>
   
  </table>
     
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    The SearchResult facility requires PECL YAZ 1.0.5
    or later and YAZ 2.1.9 or later.
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    Very few Z39.50 implementations support the SearchResult facility.
   </p>
  </p></blockquote>


name: yaz_record
purpose: Returns a record
manual_id: function.yaz-record
version: PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
return_type: string
return_description:
<p class="para">    
   Returns the record at position <code class="parameter">pos</code> or an empty
   string if no record exists at the given position.
  </p>
  <p class="para">
   If no database record exists at the given position an empty string is 
   returned.
  </p>


name: yaz_scan_result
purpose: Returns Scan Response result
manual_id: function.yaz-scan-result
version: PHP 4 >= 4.0.5, PECL yaz >= 0.9.0
return_type: array
return_description:
<p class="para">
   Returns an array (0..n-1) where n is the number of terms returned. Each 
   value is a pair where the first item is the term, and the second item is 
   the result-count.
  </p>


name: yaz_wait
purpose: Wait for Z39.50 requests to complete
manual_id: function.yaz-wait
version: PHP 4 >= 4.0.1, PECL yaz >= 0.9.0
return_type: mixed
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   In event mode, returns resource  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ZMQContext.__construct
purpose: Construct a new ZMQContext object
manual_id: zmqcontext.construct
version: PECL zmq >= 0.5.0
errors:
<p class="para">
   Throws <span class="classname">ZMQContextException</span> if context initialization fails.
  </p>


name: ZMQContext.getOpt
purpose: Get context option
manual_id: zmqcontext.getopt
version: PECL zmq >= 1.0.4
return_type: mixed
return_description:
<p class="para">
   Returns either a <span class="type">string</span> or an <span class="type">int</span> depending on <code class="parameter">key</code>. Throws
   ZMQContextException on error. 
  </p>


name: ZMQContext.isPersistent
purpose: Whether the context is persistent
manual_id: zmqcontext.ispersistent
version: PECL zmq >= 0.5.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the context is persistent and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the context is non-persistent.
  </p>


name: ZMQSocket.getEndpoints
purpose: Get list of endpoints
manual_id: zmqsocket.getendpoints
version: PECL zmq >= 0.5.0
return_type: array
return_description:
<p class="para">
   Returns an array containing elements &#039;bind&#039; and &#039;connect&#039;. 
  </p>


name: ZMQSocket.getPersistentId
purpose: Get the persistent id
manual_id: zmqsocket.getpersistentid
version: PECL zmq >= 0.5.0
return_type: string
return_description:
<p class="para">
   Returns the persistent id string assigned of the object and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if socket is not persistent.
  </p>


name: ZMQSocket.getSocketType
purpose: Get the socket type
manual_id: zmqsocket.getsockettype
version: PECL zmq >= 0.5.0
return_type: int
return_description:
<p class="para">
   Returns an integer representing the socket type. The integer can be compared against
   <strong><code>ZMQ::SOCKET_*</code></strong> constants.
  </p>


name: ZMQSocket.getSockOpt
purpose: Get socket option
manual_id: zmqsocket.getsockopt
version: PECL zmq >= 0.5.0
return_type: mixed
return_description:
<p class="para">
   Returns either a <span class="type">string</span> or an <span class="type">int</span> depending on <code class="parameter">key</code>. Throws
   ZMQSocketException on error. 
  </p>


name: ZMQSocket.isPersistent
purpose: Whether the socket is persistent
manual_id: zmqsocket.ispersistent
version: PECL zmq >= 0.5.0
return_type: bool
return_description:
<p class="para">
   Returns a <span class="type">bool</span> based on whether the socket is persistent or not.
  </p>


name: ZMQSocket.recv
purpose: Receives a message
manual_id: zmqsocket.recv
version: PECL zmq >= 0.5.0
return_type: string
errors: <p class="para"> Throws <span class="classname">ZMQSocketException</span> on error. </p>
return_description:
<p class="para">
   Returns the message. If <strong><code><a href="class.zmq.html#zmq.constants.mode-dontwait">ZMQ::MODE_DONTWAIT</a></code></strong> 
   is used and the operation would block <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> shall be returned.
  </p>


name: ZMQSocket.recvMulti
purpose: Receives a multipart message
manual_id: zmqsocket.recvmulti
version: PECL zmq >= 0.8.0
return_type: array
return_description:
<p class="para">
   Returns the array of message parts. Throws ZMQSocketException in error. 
   If <strong><code><a href="class.zmq.html#zmq.constants.mode-noblock">ZMQ::MODE_NOBLOCK</a></code></strong> is used and the operation would 
   block <span class="type">bool</span> false shall be returned.
  </p>


name: ZMQSocket.send
purpose: Sends a message
manual_id: zmqsocket.send
version: PECL zmq >= 0.5.0
return_type: ZMQSocket
return_description:
<p class="para">
   Returns the current object. Throws ZMQSocketException on error. 
   If <strong><code><a href="class.zmq.html#zmq.constants.mode-noblock">ZMQ::MODE_NOBLOCK</a></code></strong> is used and the operation would 
   block <span class="type">bool</span> false shall be returned.
  </p>


name: ZMQPoll.add
purpose: Add item to the poll set
manual_id: zmqpoll.add
version: PECL zmq >= 0.5.0
return_type: string
return_description:
<p class="para">
   Returns a string id of the added item which can be later used to remove the item. 
   Throws ZMQPollException on error.
  </p>


name: ZMQPoll.count
purpose: Count items in the poll set
manual_id: zmqpoll.count
version: PECL zmq >= 0.5.0
return_type: int
return_description:
<p class="para">
   Returns an <span class="type">int</span> representing the amount of items in the poll set.
  </p>


name: ZMQPoll.getLastErrors
purpose: Get poll errors
manual_id: zmqpoll.getlasterrors
version: PECL zmq >= 0.5.0
return_type: array
return_description:
<p class="para">
   Returns an array containing ids for the items that had errors in the last poll. Empty array is 
   returned if there were no errors.
  </p>


name: ZMQPoll.remove
purpose: Remove item from poll set
manual_id: zmqpoll.remove
version: PECL zmq >= 0.5.0
return_type: bool
return_description:
<p class="para">
   Returns true if the item was removed and false if the object 
   with given id does not exist in the poll set.
  </p>


name: ZMQDevice.__construct
purpose: Construct a new device
manual_id: zmqdevice.construct
version: PECL zmq >= 0.5.0
return_description:
<p class="para">
   Call to this method will prepare the device. Usually devices are very long
   running processes so running this method from interactive script is not recommended. This
   method throw ZMQDeviceException if the device cannot be started.
  </p>


name: ZMQDevice.run
purpose: Run the new device
manual_id: zmqdevice.run
return_type: void
return_description:
<p class="para">
   Call to this method will block until the device is running. It is not recommended
   that devices are used from interactive scripts. On failure this method will throw
   ZMQDeviceException.
  </p>


name: Zookeeper.addAuth
purpose: Specify application credentials
manual_id: zookeeper.addauth
version: PECL zookeeper >= 0.1.0
return_type: bool
errors:
<p class="para">
   This method emits PHP error/warning when parameters count or types are wrong or operation fails.
  </p>
  <div class="caution"><strong class="caution">Caution</strong>
    <p class="para">
      Since version 0.3.0, this method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives.
    </p>
  </div>


name: Zookeeper.close
purpose: Close the zookeeper handle and free up any resources
manual_id: zookeeper.close
version: PECL zookeeper >= 0.5.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   This method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives when closing an uninitialized instance.
  </p>


name: Zookeeper.connect
purpose: Create a handle to used communicate with zookeeper
manual_id: zookeeper.connect
version: PECL zookeeper >= 0.2.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   This method emits PHP error/warning when parameters count or types are wrong or could not init instance.
  </p>
  <div class="caution"><strong class="caution">Caution</strong>
    <p class="para">
      Since version 0.3.0, this method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives.
    </p>
  </div>


name: Zookeeper.create
purpose: Create a node synchronously
manual_id: zookeeper.create
version: PECL zookeeper >= 0.1.0
return_type: string
return_description:
<p class="para">
   Returns the path of the new node (this might be different than the supplied path because of the ZOO_SEQUENCE flag) on success, and false on failure.
  </p>

errors:
<p class="para">
   This method emits PHP error/warning when parameters count or types are wrong or fail to create node.
  </p>
  <div class="caution"><strong class="caution">Caution</strong>
    <p class="para">
      Since version 0.3.0, this method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives.
    </p>
  </div>


name: Zookeeper.delete
purpose: Delete a node in zookeeper synchronously
manual_id: zookeeper.delete
version: PECL zookeeper >= 0.2.0
return_type: bool
errors:
<p class="para">
   This method emits PHP error/warning when parameters count or types are wrong or fail to delete node.
  </p>
  <div class="caution"><strong class="caution">Caution</strong>
    <p class="para">
      Since version 0.3.0, this method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives.
    </p>
  </div>


name: Zookeeper.exists
purpose: Checks the existence of a node in zookeeper synchronously
manual_id: zookeeper.exists
version: PECL zookeeper >= 0.1.0
return_type: array
return_description:
<p class="para">
   Returns the value of stat for the path if the given node exists, otherwise false.
  </p>

errors:
<p class="para">
   This method emits PHP error/warning when parameters count or types are wrong or fail to check the existence of a node.
  </p>
  <div class="caution"><strong class="caution">Caution</strong>
    <p class="para">
      Since version 0.3.0, this method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives.
    </p>
  </div>


name: Zookeeper.get
purpose: Gets the data associated with a node synchronously
manual_id: zookeeper.get
version: PECL zookeeper >= 0.1.0
return_type: string
return_description: <p class="para"> Returns the data on success, and false on failure. </p>
errors:
<p class="para">
   This method emits PHP error/warning when parameters count or types are wrong or fail to get value from node.
  </p>
  <div class="caution"><strong class="caution">Caution</strong>
    <p class="para">
      Since version 0.3.0, this method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives.
    </p>
  </div>


name: Zookeeper.getAcl
purpose: Gets the acl associated with a node synchronously
manual_id: zookeeper.getacl
version: PECL zookeeper >= 0.1.0
return_type: array
return_description: <p class="para"> Return acl array on success and false on failure. </p>
errors:
<p class="para">
   This method emits PHP error/warning when parameters count or types are wrong or fail to get ACL of a node.
  </p>
  <div class="caution"><strong class="caution">Caution</strong>
    <p class="para">
      Since version 0.3.0, this method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives.
    </p>
  </div>


name: Zookeeper.getChildren
purpose: Lists the children of a node synchronously
manual_id: zookeeper.getchildren
version: PECL zookeeper >= 0.1.0
return_type: array
return_description: <p class="para"> Returns an array with children paths on success, and false on failure. </p>
errors:
<p class="para">
   This method emits PHP error/warning when parameters count or types are wrong or fail to list children of a node.
  </p>
  <div class="caution"><strong class="caution">Caution</strong>
    <p class="para">
      Since version 0.3.0, this method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives.
    </p>
  </div>


name: Zookeeper.getClientId
manual_id: zookeeper.getclientid
version: PECL zookeeper >= 0.1.0
return_type: int
return_description: <p class="para"> Returns the client session id on success, and false on failure. </p>
purpose:
Return the client session id, only valid if the connections is currently connected (ie. last watcher state is ZOO_CONNECTED_STATE)

errors:
<p class="para">
   This method emits PHP error/warning when it could not get client session id.
  </p>
  <div class="caution"><strong class="caution">Caution</strong>
    <p class="para">
      Since version 0.3.0, this method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives.
    </p>
  </div>


name: Zookeeper.getRecvTimeout
manual_id: zookeeper.getrecvtimeout
version: PECL zookeeper >= 0.1.0
return_type: int
return_description: <p class="para"> Returns the timeout for this session on success, and false on failure. </p>
purpose:
Return the timeout for this session, only valid if the connections is currently connected (ie. last watcher state is ZOO_CONNECTED_STATE). This value may change after a server re-connect

errors:
<p class="para">
   This method emits PHP error/warning when operation fails.
  </p>
  <div class="caution"><strong class="caution">Caution</strong>
    <p class="para">
      Since version 0.3.0, this method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives.
    </p>
  </div>


name: Zookeeper.getState
purpose: Get the state of the zookeeper connection
manual_id: zookeeper.getstate
version: PECL zookeeper >= 0.1.0
return_type: int
return_description:
<p class="para">
   Returns the state of zookeeper connection on success, and false on failure.
  </p>

errors:
<p class="para">
   This method emits PHP error/warning when it fails to get state of zookeeper connection.
  </p>
  <div class="caution"><strong class="caution">Caution</strong>
    <p class="para">
      Since version 0.3.0, this method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives.
    </p>
  </div>


name: Zookeeper.set
purpose: Sets the data associated with a node
manual_id: zookeeper.set
version: PECL zookeeper >= 0.1.0
return_type: bool
errors:
<p class="para">
   This method emits PHP error/warning when parameters count or types are wrong or fail to save value to node.
  </p>
  <div class="caution"><strong class="caution">Caution</strong>
    <p class="para">
      Since version 0.3.0, this method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives.
    </p>
  </div>


name: Zookeeper.setAcl
purpose: Sets the acl associated with a node synchronously
manual_id: zookeeper.setacl
version: PECL zookeeper >= 0.1.0
return_type: bool
errors:
<p class="para">
   This method emits PHP error/warning when parameters count or types are wrong or fail to set ACL for a node.
  </p>
  <div class="caution"><strong class="caution">Caution</strong>
    <p class="para">
      Since version 0.3.0, this method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives.
    </p>
  </div>


name: Zookeeper.setDebugLevel
purpose: Sets the debugging level for the library
manual_id: zookeeper.setdebuglevel
version: PECL zookeeper >= 0.1.0
return_type: bool
errors:
<p class="para">
   This method emits PHP error/warning when parameters count or types are wrong or fail to set debug level.
  </p>
  <div class="caution"><strong class="caution">Caution</strong>
    <p class="para">
      Since version 0.3.0, this method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives.
    </p>
  </div>


name: Zookeeper.setWatcher
purpose: Set a watcher function
manual_id: zookeeper.setwatcher
version: PECL zookeeper >= 0.1.0
return_type: bool
errors:
<p class="para">
   This method emits PHP error/warning when parameters count or types are wrong or fail to set watcher.
  </p>
  <div class="caution"><strong class="caution">Caution</strong>
    <p class="para">
      Since version 0.3.0, this method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives.
    </p>
  </div>


name: ZookeeperConfig.add
purpose: Add servers to the ensemble
manual_id: zookeeperconfig.add
version: PECL zookeeper >= 0.6.0, ZooKeeper >= 3.5.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   This method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives when parameters count or types are wrong or fail to save value to node.
  </p>


name: ZookeeperConfig.get
manual_id: zookeeperconfig.get
version: PECL zookeeper >= 0.6.0, ZooKeeper >= 3.5.0
return_type: string
return_description: <p class="para"> Returns the configuration string on success, and false on failure. </p>
purpose:
Gets the last committed configuration of the ZooKeeper cluster as it is known to the server to which the client is connected, synchronously

errors:
<p class="para">
   This method emits <span class="classname">ZookeeperException</span> and it&#039;s derivatives when parameters count or types are wrong or fail to get configuration.
  </p>


name: solr_get_version
purpose: Returns the current version of the Apache Solr extension
manual_id: function.solr-get-version
version: PECL solr >= 0.9.1
return_type: string
errors: <p class="para"> This function throws no errors or exceptions. </p>
return_description:
<p class="para">
   It returns a string on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SolrUtils.digestXmlResponse
purpose: Parses an response XML string into a SolrObject
manual_id: solrutils.digestxmlresponse
version: PECL solr >= 0.9.2
return_type: SolrObject
return_description:
<p class="para">
   Returns the SolrObject representing the XML response.
  </p>
  
  <p class="para">If the parse_mode parameter is set to SolrResponse::PARSE_SOLR_OBJ Solr documents will be parses as SolrObject instances.</p>
 
  <p class="para">If it is set to SolrResponse::PARSE_SOLR_DOC, they will be parsed as SolrDocument instances.</p>


name: SolrUtils.escapeQueryChars
purpose: Escapes a lucene query string
manual_id: solrutils.escapequerychars
version: PECL solr >= 0.9.2
return_type: false
return_description:
<p class="para">
  Returns the escaped string or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SolrInputDocument.addChildDocument
purpose: Adds a child document for block indexing
manual_id: solrinputdocument.addchilddocument
version: PECL solr >= 2.3.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Throws <span class="classname">SolrIllegalArgumentException</span> on failure.
  </p>
  <p class="para">
   Throws <span class="classname">SolrException</span> on internal failure.
  </p>


name: SolrInputDocument.fieldExists
purpose: Checks if a field exists
manual_id: solrinputdocument.fieldexists
version: PECL solr >= 0.9.2
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the field was found and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it was not found.
  </p>


name: SolrInputDocument.getBoost
purpose: Retrieves the current boost value for the document
manual_id: solrinputdocument.getboost
version: PECL solr >= 0.9.2
return_type: float
return_description:
<p class="para">
  Returns the boost value on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SolrInputDocument.getField
purpose: Retrieves a field by name
manual_id: solrinputdocument.getfield
version: PECL solr >= 0.9.2
return_type: SolrDocumentField
return_description:
<p class="para">
   Returns a SolrDocumentField object on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SolrInputDocument.getFieldBoost
purpose: Retrieves the boost value for a particular field
manual_id: solrinputdocument.getfieldboost
version: PECL solr >= 0.9.2
return_type: float
return_description:
<p class="para">
   Returns the boost value for the field or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there was an error.
  </p>


name: SolrInputDocument.getFieldCount
purpose: Returns the number of fields in the document
manual_id: solrinputdocument.getfieldcount
version: PECL solr >= 0.9.2
return_type: false
return_description:
<p class="para">
  Returns an integer on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SolrInputDocument.getFieldNames
purpose: Returns an array containing all the fields in the document
manual_id: solrinputdocument.getfieldnames
version: PECL solr >= 0.9.2
return_type: array
return_description:
<p class="para">
   Returns an array on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SolrInputDocument.merge
purpose: Merges one input document into another
manual_id: solrinputdocument.merge
version: PECL solr >= 0.9.2
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. In the future, this will be modified to return the number of fields in the new document.
  </p>


name: SolrInputDocument.toArray
purpose: Returns an array representation of the input document
manual_id: solrinputdocument.toarray
version: PECL solr >= 0.9.2
return_type: array
return_description:
<p class="para">
   Returns an array containing the fields. It returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SolrDocument.fieldExists
purpose: Checks if a field exists in the document
manual_id: solrdocument.fieldexists
version: PECL solr >= 0.9.2
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the field is present and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it does not.
  </p>


name: SolrDocument.getField
purpose: Retrieves a field by name
manual_id: solrdocument.getfield
version: PECL solr >= 0.9.2
return_type: SolrDocumentField
return_description:
<p class="para">
   Returns a SolrDocumentField on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SolrDocument.getFieldCount
purpose: Returns the number of fields in this document
manual_id: solrdocument.getfieldcount
version: PECL solr >= 0.9.2
return_type: int
return_description:
<p class="para">
   Returns an integer on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SolrDocument.getInputDocument
purpose: Returns a SolrInputDocument equivalent of the object
manual_id: solrdocument.getinputdocument
version: PECL solr >= 0.9.2
return_type: SolrInputDocument
return_description:
<p class="para">
   Returns a SolrInputDocument on success and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: SolrDocument.valid
purpose: Checks if the current position internally is still valid
manual_id: solrdocument.valid
version: PECL solr >= 0.9.2
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the current position is no longer valid.
  </p>


name: SolrClient.addDocument
purpose: Adds a document to the index
manual_id: solrclient.adddocument
version: PECL solr >= 0.9.2
return_type: SolrUpdateResponse
return_description:
<p class="para">
   Returns a <span class="type">SolrUpdateResponse</span> object or throws an Exception on failure.
  </p>

errors:
<p class="para">
   Throws <span class="classname">SolrClientException</span> if the client had failed, or there was a connection issue.
  </p>
  <p class="para">
   Throws <span class="classname">SolrServerException</span> if the Solr Server had failed to process the request.
  </p>


name: SolrClient.addDocuments
purpose: Adds a collection of SolrInputDocument instances to the index
manual_id: solrclient.adddocuments
version: PECL solr >= 0.9.2
return_type: void
return_description:
<p class="para">
    Returns a <span class="type">SolrUpdateResponse</span> object or throws an exception on failure.
  </p>

errors:
<p class="para">
   Throws <span class="classname">SolrClientException</span> if the client had failed, or there was a connection issue.
  </p>
  <p class="para">
   Throws <span class="classname">SolrServerException</span> if the Solr Server had failed to process the request.
  </p>


name: SolrClient.commit
purpose: Finalizes all add/deletes made to the index
manual_id: solrclient.commit
version: PECL solr >= 0.9.2
return_type: SolrUpdateResponse
return_description:
<p class="para">
   Returns a <span class="classname">SolrUpdateResponse</span> object on success or throws an exception on failure.
  </p>

errors:
<p class="para">
   Throws <span class="classname">SolrClientException</span> if the client had failed, or there was a connection issue.
  </p>
  <p class="para">
   Throws <span class="classname">SolrServerException</span> if the Solr Server had failed to process the request.
  </p>


name: SolrClient.__construct
purpose: Constructor for the SolrClient object
manual_id: solrclient.construct
version: PECL solr >= 0.9.2
errors:
<p class="para">
   Throws <span class="classname">SolrIllegalArgumentException</span> on failure.
  </p>


name: SolrClient.deleteById
purpose: Delete by Id
manual_id: solrclient.deletebyid
version: PECL solr >= 0.9.2
return_type: SolrUpdateResponse
return_description:
<p class="para">
   Returns a <span class="type">SolrUpdateResponse</span> on success and throws an exception on failure.
  </p>


name: SolrClient.deleteByQueries
purpose: Removes all documents matching any of the queries
manual_id: solrclient.deletebyqueries
version: PECL solr >= 0.9.2
return_type: SolrUpdateResponse
return_description:
<p class="para">
   Returns a SolrUpdateResponse on success and throws a SolrClientException on failure.
  </p>


name: SolrClient.getOptions
purpose: Returns the client options set internally
manual_id: solrclient.getoptions
version: PECL solr >= 0.9.6
return_type: array
return_description:
<p class="para">
   Returns an array containing all the options for the SolrClient object set internally.
  </p>


name: SolrClient.optimize
purpose: Defragments the index
manual_id: solrclient.optimize
version: PECL solr >= 0.9.2
return_type: SolrUpdateResponse
return_description:
<p class="para">
   Returns a SolrUpdateResponse on success or throws an exception on failure.
  </p>


name: SolrClient.ping
purpose: Checks if Solr server is still up
manual_id: solrclient.ping
version: PECL solr >= 0.9.2
return_type: SolrPingResponse
return_description:
<p class="para">
   Returns a <span class="type">SolrPingResponse</span> object on success and throws an exception on failure.
  </p>

errors:
<p class="para">
   Throws <span class="classname">SolrClientException</span> if the client had failed, or there was a connection issue.
  </p>
  <p class="para">
    Throws <span class="classname">SolrServerException</span> if the Solr Server had failed to satisfy the request.
  </p>


name: SolrClient.query
purpose: Sends a query to the server
manual_id: solrclient.query
version: PECL solr >= 0.9.2
return_type: SolrQueryResponse
return_description:
<p class="para">
   Returns a <span class="type">SolrQueryResponse</span> object on success and throws an exception on failure.
  </p>

errors:
<p class="para">
   Throws <span class="classname">SolrClientException</span> if the client had failed, or there was a connection issue.
  </p>
  <p class="para">
    Throws <span class="classname">SolrServerException</span> if the Solr Server had failed to satisfy the query.
  </p>


name: SolrClient.request
purpose: Sends a raw update request
manual_id: solrclient.request
version: PECL solr >= 0.9.2
return_type: SolrUpdateResponse
return_description:
<p class="para">
   Returns a <span class="type">SolrUpdateResponse</span> on success. Throws an exception on failure.
  </p>

errors:
<p class="para">
   Throws <span class="classname">SolrIllegalArgumentException</span> if <code class="parameter">raw_request</code> was an empty string
  </p>
  <p class="para">
   Throws <span class="classname">SolrClientException</span> if the client had failed, or there was a connection issue.
  </p>
  <p class="para">
   Throws <span class="classname">SolrServerException</span> if the Solr Server had failed to satisfy the query.
  </p>


name: SolrClient.rollback
purpose: Rollbacks all add/deletes made to the index since the last commit
manual_id: solrclient.rollback
version: PECL solr >= 0.9.2
return_type: SolrUpdateResponse
return_description:
<p class="para">
   Returns a SolrUpdateResponse on success or throws a SolrClientException on failure.
  </p>


name: SolrClient.system
purpose: Retrieve Solr Server information
manual_id: solrclient.system
version: PECL solr >= 2.0.0
return_type: void
return_description:
<p class="para">
   Returns a <span class="type">SolrGenericResponse</span> object on success.
  </p>

errors:
<p class="para">
   Emits <span class="classname">SolrClientException</span> if the client failed, or there was a connection issue.
  </p>
  <p class="para">
    Emits <span class="classname">SolrServerException</span> if the Solr Server failed to satisfy the query.
  </p>


name: SolrClient.threads
purpose: Checks the threads status
manual_id: solrclient.threads
version: PECL solr >= 0.9.2
return_type: void
return_description: <p class="para"> Returns a SolrGenericResponse object. </p>
errors:
<p class="para">
   Throws <span class="classname">SolrClientException</span> if the client failed, or there was a connection issue.
  </p>
  <p class="para">
    throws <span class="classname">SolrServerException</span> if the Solr Server failed to process the request.
  </p>


name: SolrResponse.success
purpose: Was the request a success
manual_id: solrresponse.success
version: PECL solr >= 0.9.2
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if it was successful and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it was not.
  </p>


name: SolrParams.addParam
purpose: Adds a parameter to the object
manual_id: solrparams.addparam
version: PECL solr >= 0.9.2
return_type: SolrParams
return_description:
<p class="para">
   Returns a SolrParam object on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SolrParams.setParam
purpose: Sets the parameter to the specified value
manual_id: solrparams.setparam
version: PECL solr >= 0.9.2
return_type: SolrParams
return_description:
<p class="para">
   Returns a SolrParam object on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on value.
  </p>


name: SolrParams.toString
purpose: Returns all the name-value pair parameters in the object
manual_id: solrparams.tostring
version: PECL solr >= 0.9.2
return_type: string
return_description:
<p class="para">
 Returns a string on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SolrQuery.__construct
purpose: Constructor
manual_id: solrquery.construct
version: PECL solr >= 0.9.2
return_description: <p class="para"> None </p>
errors:
<p class="para">
   Emits <span class="classname">SolrIllegalArgumentException</span> in case of an invalid parameter was passed.
  </p>


name: SolrQuery.getFacet
purpose: Returns the value of the facet parameter
manual_id: solrquery.getfacet
version: PECL solr >= 0.9.2
return_type: bool
return_description:
<p class="para">
Returns a boolean on success and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not set
  </p>


name: SolrQuery.getFacetDateEnd
purpose: Returns the value for the facet.date.end parameter
manual_id: solrquery.getfacetdateend
version: PECL solr >= 0.9.2
return_type: string
return_description:
<p class="para">
Returns a string on success and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not set
  </p>


name: SolrQuery.getFacetDateFields
purpose: Returns all the facet.date fields
manual_id: solrquery.getfacetdatefields
version: PECL solr >= 0.9.2
return_type: array
return_description:
<p class="para">
   Returns all the facet.date fields as an array or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if none was set
  </p>


name: SolrQuery.getFacetDateOther
purpose: Returns the value for the facet.date.other parameter
manual_id: solrquery.getfacetdateother
version: PECL solr >= 0.9.2
return_type: array
return_description:
<p class="para">
Returns an <span class="type">array</span> on success and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not set.
  </p>


name: SolrQuery.getFacetFields
purpose: Returns all the facet fields
manual_id: solrquery.getfacetfields
version: PECL solr >= 0.9.2
return_type: array
return_description:
<p class="para">
Returns an array of all the fields and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if none was set
  </p>


name: SolrQuery.getFacetLimit
purpose: Returns the maximum number of constraint counts that should be returned for the facet fields
manual_id: solrquery.getfacetlimit
version: PECL solr >= 0.9.2
return_type: int
return_description:
<p class="para">
Returns an integer on success and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not set
  </p>


name: SolrQuery.getFacetMethod
purpose: Returns the value of the facet.method parameter
manual_id: solrquery.getfacetmethod
version: PECL solr >= 0.9.2
return_type: string
return_description:
<p class="para">
   Returns a string on success and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not set
  </p>


name: SolrQuery.getFacetPrefix
purpose: Returns the facet prefix
manual_id: solrquery.getfacetprefix
version: PECL solr >= 0.9.2
return_type: string
return_description:
<p class="para">
Returns a string on success and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not set.
  </p>


name: SolrQuery.getFacetQueries
purpose: Returns all the facet queries
manual_id: solrquery.getfacetqueries
version: PECL solr >= 0.9.2
return_type: array
return_description:
<p class="para">
Returns an array on success and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not set.
  </p>


name: SolrQuery.getFacetSort
purpose: Returns the facet sort type
manual_id: solrquery.getfacetsort
version: PECL solr >= 0.9.2
return_type: int
return_description:
<p class="para">
   Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) on success or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not set. 
  </p>


name: SolrQuery.getHighlight
purpose: Returns the state of the hl parameter
manual_id: solrquery.gethighlight
version: PECL solr >= 0.9.2
return_type: bool
return_description:
<p class="para">
Returns a boolean on success and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not set.
  </p>


name: SolrQuery.getHighlightFragsize
purpose: Returns the number of characters of fragments to consider for highlighting
manual_id: solrquery.gethighlightfragsize
version: PECL solr >= 0.9.2
return_type: int
return_description:
<p class="para">
Returns an integer on success or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not set.
  </p>


name: SolrQuery.getHighlightMaxAlternateFieldLength
purpose: Returns the maximum number of characters of the field to return
manual_id: solrquery.gethighlightmaxalternatefieldlength
version: PECL solr >= 0.9.2
return_type: int
return_description:
<p class="para">
Returns an integer on success and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not set.
  </p>


name: SolrQuery.getHighlightRegexSlop
purpose: Returns the deviation factor from the ideal fragment size
manual_id: solrquery.gethighlightregexslop
version: PECL solr >= 0.9.2
return_type: float
return_description:
<p class="para">
   Returns a <span class="type">float</span> on success and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not set.
  </p>


name: SolrQuery.getMltMaxNumTokens
manual_id: solrquery.getmltmaxnumtokens
version: PECL solr >= 0.9.2
return_type: int
purpose:
Returns the maximum number of tokens to parse in each document field that is not stored with TermVector support


name: SolrQuery.getMltMinDocFrequency
manual_id: solrquery.getmltmindocfrequency
version: PECL solr >= 0.9.2
return_type: int
purpose:
Returns the treshold frequency at which words will be ignored which do not occur in at least this many docs


name: SolrQuery.getSortFields
purpose: Returns all the sort fields
manual_id: solrquery.getsortfields
version: PECL solr >= 0.9.2
return_type: array
return_description:
<p class="para">
Returns an array on success and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if none of the parameters was set.
  </p>


name: SolrQuery.getTimeAllowed
purpose: Returns the time in milliseconds allowed for the query to finish
manual_id: solrquery.gettimeallowed
version: PECL solr >= 0.9.2
return_type: int
return_description:
<p class="para">
Returns and integer on success and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if it is not set.
  </p>


name: SolrQuery.setGroupMain
manual_id: solrquery.setgroupmain
version: PECL solr >= 2.2.0
return_type: SolrQuery
return_description: <p class="para"> Returns an instance of <span class="classname">SolrQuery</span>. </p>
purpose:
If true, the result of the first field grouping command is used as the main result list in the response, using group.format=simple


name: SolrDisMaxQuery.setQueryPhraseSlop
manual_id: solrdismaxquery.setqueryphraseslop
return_type: SolrDisMaxQuery
return_description: <p class="para"> <span class="type">SolrDisMaxQuery</span> </p>
purpose:
Specifies the amount of slop permitted on phrase queries explicitly included in the user's query string (qf parameter)


name: SolrException.getInternalInfo
purpose: Returns internal information where the Exception was thrown
manual_id: solrexception.getinternalinfo
version: PECL solr >= 0.9.2
return_type: array
return_description:
<p class="para">
   Returns an array containing internal information where the error was thrown. Used only for debugging by extension developers.
  </p>


name: apache_get_version
purpose: Fetch Apache version
manual_id: function.apache-get-version
version: PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the Apache version on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: apache_getenv
purpose: Get an Apache subprocess_env variable
manual_id: function.apache-getenv
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The value of the Apache environment variable on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   failure
  </p>


name: apache_lookup_uri
purpose: Perform a partial request for the specified URI and return all info about it
manual_id: function.apache-lookup-uri
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An <span class="type">object</span> of related URI information. The properties of
   this <span class="type">object</span> are:
  </p>
  <p class="para">
   <ul class="simplelist">
    <li>status</li>
    <li>the_request</li>
    <li>status_line</li>
    <li>method</li>
    <li>content_type</li>
    <li>handler</li>
    <li>uri</li>
    <li>filename</li>
    <li>path_info</li>
    <li>args</li>
    <li>boundary</li>
    <li>no_cache</li>
    <li>no_local_copy</li>
    <li>allowed</li>
    <li>send_bodyct</li>
    <li>bytes_sent</li>
    <li>byterange</li>
    <li>clength</li>
    <li>unparsed_uri</li>
    <li>mtime</li>
    <li>request_time</li>
   </ul>
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: apache_note
purpose: Get and set apache request notes
manual_id: function.apache-note
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   If <code class="parameter">note_value</code> is omitted or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, it returns the current value of note
   <code class="literal">note_name</code>. Otherwise, it
   sets the value of note <code class="literal">note_name</code> to
   <code class="literal">note_value</code> and returns the previous value of
   note <code class="literal">note_name</code>.
   If the note cannot be retrieved, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: apache_request_headers
purpose: Fetch all HTTP request headers
manual_id: function.apache-request-headers
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An associative array of all the HTTP headers in the current request, or
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: apache_response_headers
purpose: Fetch all HTTP response headers
manual_id: function.apache-response-headers
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An array of all Apache response headers on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: virtual
purpose: Perform an Apache sub-request
manual_id: function.virtual
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Performs the virtual command on success, or returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: fpm_get_status
purpose: Returns the current FPM pool status
manual_id: function.fpm-get-status
version: PHP 7 >= 7.3, PHP 8
return_type: false
return_description:
<p class="para">
   Associative array containing the full FPM pool status, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: session_cache_expire
purpose: Get and/or set current cache expire
manual_id: function.session-cache-expire
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the current setting of <code class="literal">session.cache_expire</code>.
   The value returned should be read in minutes, defaults to 180.
   On failure to change the value, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: session_cache_limiter
purpose: Get and/or set the current cache limiter
manual_id: function.session-cache-limiter
version: PHP 4 >= 4.0.3, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the name of the current cache limiter.
   On failure to change the value, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: session_create_id
purpose: Create new session id
manual_id: function.session-create-id
version: PHP 7 >= 7.1.0, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">session_create_id</span> returns new collision free
   session id for the current session. If it is used without active
   session, it omits collision check.
   On failure, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: session_encode
purpose: Encodes the current session data as a session encoded string
manual_id: function.session-encode
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the contents of the current session encoded,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: session_gc
purpose: Perform session data garbage collection
manual_id: function.session-gc
version: PHP 7 >= 7.1.0, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">session_gc</span> returns number of deleted session
   data for success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> for failure.
  </p>
  <p class="para">
   Old save handlers do not return number of deleted session data, but 
   only success/failure flag. If this is the case, number of deleted
   session data became 1 regardless of actually deleted data.
  </p>


name: session_get_cookie_params
purpose: Get the session cookie parameters
manual_id: function.session-get-cookie-params
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array with the current session cookie information, the array
   contains the following items:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      <a href="session.configuration.html#ini.session.cookie-lifetime" class="link">&quot;lifetime&quot;</a> -  The
      lifetime of the cookie in seconds.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <a href="session.configuration.html#ini.session.cookie-path" class="link">&quot;path&quot;</a> -  The path where
      information is stored.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <a href="session.configuration.html#ini.session.cookie-domain" class="link">&quot;domain&quot;</a> -  The domain
      of the cookie.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <a href="session.configuration.html#ini.session.cookie-secure" class="link">&quot;secure&quot;</a> -  The cookie
      should only be sent over secure connections.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <a href="session.configuration.html#ini.session.cookie-httponly" class="link">&quot;httponly&quot;</a> - The
      cookie can only be accessed through the HTTP protocol.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <a href="session.configuration.html#ini.session.cookie-samesite" class="link">&quot;samesite&quot;</a> - Controls
      the cross-domain sending of the cookie.
     </span>
    </li>
   </ul>
  </p>


name: session_id
purpose: Get and/or set the current session id
manual_id: function.session-id
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">session_id</span> returns the session id for the current
   session or the empty string (<code class="literal">&quot;&quot;</code>) if there is no current
   session (no current session id exists).
   On failure, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: session_module_name
purpose: Get and/or set the current session module
manual_id: function.session-module-name
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the name of the current session module,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: session_name
purpose: Get and/or set the current session name
manual_id: function.session-name
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the name of the current session. If <code class="parameter">name</code> is given
   and function updates the session name, name of the <em>old</em> session
   is returned,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: session_register_shutdown
purpose: Session shutdown function
manual_id: function.session-register-shutdown
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Emits <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> if registering the shutdown function
   fails.
  </p>


name: session_save_path
purpose: Get and/or set the current session save path
manual_id: function.session-save-path
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the path of the current directory used for data storage,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: session_start
purpose: Start new or resume existing session
manual_id: function.session-start
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   This function returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a session was successfully started,
   otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: session_status
purpose: Returns the current session status
manual_id: function.session-status
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara"><strong><code><a href="session.constants.html#constant.php-session-disabled">PHP_SESSION_DISABLED</a></code></strong> if sessions are disabled.</span>
    </li>
    <li class="listitem">
     <span class="simpara"><strong><code><a href="session.constants.html#constant.php-session-none">PHP_SESSION_NONE</a></code></strong> if sessions are enabled, but none exists.</span>
    </li>
    <li class="listitem">
     <span class="simpara"><strong><code><a href="session.constants.html#constant.php-session-active">PHP_SESSION_ACTIVE</a></code></strong> if sessions are enabled, and one exists.</span>
    </li>
   </ul>
  </p>


name: SessionHandler.close
purpose: Close the session
manual_id: sessionhandler.close
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   The return value (usually <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure). Note this value is returned internally to PHP for processing.
  </p>


name: SessionHandler.gc
purpose: Cleanup old sessions
manual_id: sessionhandler.gc
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the number of deleted sessions on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   Note this value is returned internally to PHP for processing.
  </p>


name: SessionHandler.read
purpose: Read session data
manual_id: sessionhandler.read
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an encoded string of the read data. If nothing was read, it must return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Note this value is returned internally to PHP for processing.
  </p>


name: SessionIdInterface.create_sid
purpose: Create session ID
manual_id: sessionidinterface.create-sid
version: PHP 5 >= 5.5.1, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The new session ID.
   Note that this value is returned internally to PHP for processing.
  </p>


name: SessionUpdateTimestampHandlerInterface.updateTimestamp
purpose: Update timestamp
manual_id: sessionupdatetimestamphandlerinterface.updatetimestamp
version: PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the timestamp was updated, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
   Note that this value is returned internally to PHP for processing.
  </p>


name: SessionUpdateTimestampHandlerInterface.validateId
purpose: Validate ID
manual_id: sessionupdatetimestamphandlerinterface.validateid
version: PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> for valid ID, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
   Note that this value is returned internally to PHP for processing.
  </p>


name: CommonMark\Interfaces\IVisitor.enter
purpose: Visitation
manual_id: commonmark-interfaces-ivisitor.enter
version: cmark >= 1.0.0
return_type: null
return_description:
<p class="para">
   Returning <var class="varname">CommonMark\Interfaces\IVisitor::Done</var> will cause the backing iterator to exit.
  </p>
  <p class="para">
  Returning <var class="varname">CommonMark\Interfaces\IVisitor::Enter</var> will reset the backing iterator at entering the current <span class="classname">IVisitable</span>
  </p>
  <p class="para">
  Returning <var class="varname">CommonMark\Interfaces\IVisitor::Leave</var> will reset the backing iterator at exiting the current <span class="classname">IVisitable</span>
  </p>
  <p class="para">
  Returning an <span class="classname">IVisitable</span> will reset the backing iterator at entering the given <span class="classname">IVisitable</span>
  </p>
  <p class="para">
  Returning nothing will allow the backing iterator to continue
  </p>


name: CommonMark\Interfaces\IVisitor.leave
purpose: Visitation
manual_id: commonmark-interfaces-ivisitor.leave
version: cmark >= 1.0.0
return_type: null
return_description:
<p class="para">
   Returning <var class="varname">CommonMark\Interfaces\IVisitor::Done</var> will cause the backing iterator to exit.
  </p>
  <p class="para">
  Returning <var class="varname">CommonMark\Interfaces\IVisitor::Enter</var> will reset the backing iterator at entering the current <span class="classname">IVisitable</span>
  </p>
  <p class="para">
  Returning <var class="varname">CommonMark\Interfaces\IVisitor::Leave</var> will reset the backing iterator at exiting the current <span class="classname">IVisitable</span>
  </p>
  <p class="para">
  Returning an <span class="classname">IVisitable</span> will reset the backing iterator at exiting the given <span class="classname">IVisitable</span>
  </p>
  <p class="para">
  Returning nothing will allow the backing iterator to continue
  </p>


name: Parle\Parser.validate
purpose: Validate input
manual_id: parle-parser.validate
version: PECL parle >= 0.5.1
return_type: bool
return_description:
<p class="para">
   Returns <span class="type">bool</span> witnessing whether the input chimes or not with the defined rules.
  </p>


name: Parle\RParser.validate
purpose: Validate input
manual_id: parle-rparser.validate
version: PECL parle >= 0.7.0
return_type: bool
return_description:
<p class="para">
   Returns <span class="type">bool</span> whitnessing whether the input chimes or not with the defined rules.
  </p>


name: preg_filter
purpose: Perform a regular expression search and replace
manual_id: function.preg-filter
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns an <span class="type">array</span> if the <code class="parameter">subject</code>
   parameter is an <span class="type">array</span>, or a <span class="type">string</span> otherwise.
  </p>
  <p class="para">
   If no matches are found or an error occurred, an empty <span class="type">array</span> 
   is returned when <code class="parameter">subject</code> is an <span class="type">array</span>
   or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> otherwise.
  </p>

errors:
<p class="para">
If the regex pattern passed does not compile to a valid regex, an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted.
</p>


name: preg_grep
purpose: Return array entries that match the pattern
manual_id: function.preg-grep
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array indexed using the keys from the
   <code class="parameter">array</code> array,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
If the regex pattern passed does not compile to a valid regex, an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted.
</p>


name: preg_last_error
purpose: Returns the error code of the last PCRE regex execution
manual_id: function.preg-last-error
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns one of the following constants (<a href="pcre.constants.html" class="link">explained on their own page</a>):
   <ul class="simplelist">
    <li><strong><code><a href="pcre.constants.html#constant.preg-no-error">PREG_NO_ERROR</a></code></strong></li>
    <li><strong><code><a href="pcre.constants.html#constant.preg-internal-error">PREG_INTERNAL_ERROR</a></code></strong></li>
    <li><strong><code><a href="pcre.constants.html#constant.preg-backtrack-limit-error">PREG_BACKTRACK_LIMIT_ERROR</a></code></strong> (see also <a href="pcre.configuration.html#ini.pcre.backtrack-limit" class="link">pcre.backtrack_limit</a>)</li>
    <li><strong><code><a href="pcre.constants.html#constant.preg-recursion-limit-error">PREG_RECURSION_LIMIT_ERROR</a></code></strong> (see also <a href="pcre.configuration.html#ini.pcre.recursion-limit" class="link">pcre.recursion_limit</a>)</li>
    <li><strong><code><a href="pcre.constants.html#constant.preg-bad-utf8-error">PREG_BAD_UTF8_ERROR</a></code></strong></li>
    <li><strong><code><a href="pcre.constants.html#constant.preg-bad-utf8-offset-error">PREG_BAD_UTF8_OFFSET_ERROR</a></code></strong></li>
    <li><strong><code><a href="pcre.constants.html#constant.preg-jit-stacklimit-error">PREG_JIT_STACKLIMIT_ERROR</a></code></strong></li>
   </ul>
  </p>


name: preg_match_all
purpose: Perform a global regular expression match
manual_id: function.preg-match-all
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the number of full pattern matches (which might be zero), or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
If the regex pattern passed does not compile to a valid regex, an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted.
</p>


name: preg_match
purpose: Perform a regular expression match
manual_id: function.preg-match
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">preg_match</span> returns 1 if the <code class="parameter">pattern</code>
   matches given <code class="parameter">subject</code>, 0 if it does not, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>


name: preg_replace_callback_array
purpose: Perform a regular expression search and replace using callbacks
manual_id: function.preg-replace-callback-array
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   <span class="function">preg_replace_callback_array</span> returns an array if the
   <code class="parameter">subject</code> parameter is an array, or a string
   otherwise. On errors the return value is <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
  </p>
  <p class="para">
   If matches are found, the new subject will be returned, otherwise
   <code class="parameter">subject</code> will be returned unchanged. 
  </p>


name: preg_replace_callback
purpose: Perform a regular expression search and replace using a callback
manual_id: function.preg-replace-callback
version: PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   <span class="function">preg_replace_callback</span> returns an array if the
   <code class="parameter">subject</code> parameter is an array, or a string
   otherwise. On errors the return value is <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
  </p>
  <p class="para">
   If matches are found, the new subject will be returned, otherwise
   <code class="parameter">subject</code> will be returned unchanged.
  </p>


name: preg_replace
purpose: Perform a regular expression search and replace
manual_id: function.preg-replace
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   <span class="function">preg_replace</span> returns an array if the
   <code class="parameter">subject</code> parameter is an array, or a string
   otherwise.
  </p>
  <p class="para">
   If matches are found, the new <code class="parameter">subject</code> will
   be returned, otherwise <code class="parameter">subject</code> will be
   returned unchanged or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if an error occurred.
  </p>

errors:
<p class="para">
   Using the &quot;\e&quot; modifier is an error;
   an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted in this case.
  </p>
  <p class="para">
If the regex pattern passed does not compile to a valid regex, an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted.
</p>


name: preg_split
purpose: Split string by a regular expression
manual_id: function.preg-split
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array containing substrings of <code class="parameter">subject</code>
   split along boundaries matched by <code class="parameter">pattern</code>,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ssdeep_fuzzy_compare
purpose: Calculates the match score between two fuzzy hash signatures
manual_id: function.ssdeep-fuzzy-compare
version: PECL ssdeep >= 1.0.0
return_type: int
return_description:
<p class="para">
   Returns an integer from 0 to 100 on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise. 
  </p>


name: ssdeep_fuzzy_hash_filename
purpose: Create a fuzzy hash from a file
manual_id: function.ssdeep-fuzzy-hash-filename
version: PECL ssdeep >= 1.0.0
return_type: string
return_description:
<p class="para">
   Returns a string on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: convert_uudecode
purpose: Decode a uuencoded string
manual_id: function.convert-uudecode
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the decoded data as a string  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: count_chars
purpose: Return information about characters used in a string
manual_id: function.count-chars
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Depending on <code class="parameter">mode</code>
   <span class="function">count_chars</span> returns one of the following:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      0 - an array with the byte-value as key and the frequency of
      every byte as value.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      1 - same as 0 but only byte-values with a frequency greater
      than zero are listed.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      2 - same as 0 but only byte-values with a frequency equal to
      zero are listed.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      3 - a string containing all unique characters is returned.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      4 - a string containing all not used characters is returned.
     </span>
    </li>
   </ul>
  </p>


name: crc32
purpose: Calculates the crc32 polynomial of a string
manual_id: function.crc32
version: PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the crc32 checksum of <code class="parameter">string</code> as an integer.
  </p>


name: crypt
purpose: One-way string hashing
manual_id: function.crypt
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the hashed string or a string that is shorter than 13 characters
   and is guaranteed to differ from the salt on failure.
  </p>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="simpara">
    When validating passwords, a string comparison function that isn&#039;t
    vulnerable to timing attacks should be used to compare the output of
    <span class="function">crypt</span> to the previously known hash. PHP
    provides <span class="function">hash_equals</span> for this purpose.
   </p>
  </div>


name: explode
purpose: Split a string by a string
manual_id: function.explode
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an <span class="type">array</span> of <span class="type">string</span>s
   created by splitting the <code class="parameter">string</code> parameter on
   boundaries formed by the <code class="parameter">separator</code>.
  </p>
  <p class="para">
   If <code class="parameter">separator</code> is an empty <span class="type">string</span> (&quot;&quot;),
   <span class="function">explode</span> throws a <span class="classname">ValueError</span>.
   If <code class="parameter">separator</code> contains a value that is not
   contained in <code class="parameter">string</code> and a negative
   <code class="parameter">limit</code> is used, then an empty <span class="type">array</span> will be
   returned, otherwise an <span class="type">array</span> containing
   <code class="parameter">string</code> will be returned. If <code class="parameter">separator</code> 
   values appear at the start or end of <code class="parameter">string</code>, said values 
   will be added as an empty <span class="type">array</span> value either in the first or last 
   position of the returned <span class="type">array</span> respectively.
  </p>


name: fprintf
purpose: Write a formatted string to a stream
manual_id: function.fprintf
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description: <p class="para"> Returns the length of the string written. </p>
errors:
<p class="para">
   As of PHP 8.0.0, a <span class="classname">ValueError</span> is thrown if the number of arguments is zero.
   Prior to PHP 8.0.0, a <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> was emitted instead.
  </p>
  <p class="para">
   As of PHP 8.0.0, a <span class="classname">ValueError</span> is thrown if <code class="literal">[width]</code> is less than zero or bigger than <strong><code><a href="reserved.constants.html#constant.php-int-max">PHP_INT_MAX</a></code></strong>.
   Prior to PHP 8.0.0, a <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> was emitted instead.
  </p>
  <p class="para">
   As of PHP 8.0.0, a <span class="classname">ValueError</span> is thrown if <code class="literal">[precision]</code> is less than zero or bigger than <strong><code><a href="reserved.constants.html#constant.php-int-max">PHP_INT_MAX</a></code></strong>.
   Prior to PHP 8.0.0, a <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> was emitted instead.
  </p>
  <p class="para">
   As of PHP 8.0.0, a <span class="classname">ArgumentCountError</span> is thrown when less arguments are given than required.
   Prior to PHP 8.0.0, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> was returned and a <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> emitted instead.
  </p>


name: get_html_translation_table
purpose: Returns the translation table used by htmlspecialchars and htmlentities
manual_id: function.get-html-translation-table
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns the translation table as an array, with the original characters
   as keys and entities as values.
  </p>


name: hex2bin
purpose: Decodes a hexadecimally encoded binary string
manual_id: function.hex2bin
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the binary representation of the given data  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   If the hexadecimal input string is of odd length or invalid hexadecimal string
   an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error is thrown.
  </p>


name: htmlentities
purpose: Convert all applicable characters to HTML entities
manual_id: function.htmlentities
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the encoded string.
  </p>
  <p class="para">
   If the input <code class="parameter">string</code> contains an invalid code unit
   sequence within the given <code class="parameter">encoding</code> an empty string
   will be returned, unless either the <strong><code><a href="string.constants.html#constant.ent-ignore">ENT_IGNORE</a></code></strong> or
   <strong><code><a href="string.constants.html#constant.ent-substitute">ENT_SUBSTITUTE</a></code></strong> flags are set.
  </p>


name: htmlspecialchars
purpose: Convert special characters to HTML entities
manual_id: function.htmlspecialchars
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The converted <span class="type">string</span>.
  </p>
  <p class="para">
   If the input <code class="parameter">string</code> contains an invalid code unit
   sequence within the given <code class="parameter">encoding</code> an empty string
   will be returned, unless either the <strong><code><a href="string.constants.html#constant.ent-ignore">ENT_IGNORE</a></code></strong> or
   <strong><code><a href="string.constants.html#constant.ent-substitute">ENT_SUBSTITUTE</a></code></strong> flags are set.
  </p>


name: implode
purpose: Join array elements with a string
manual_id: function.implode
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns a string containing a string representation of all the array
   elements in the same order, with the separator string between each element.
  </p>


name: levenshtein
purpose: Calculate Levenshtein distance between two strings
manual_id: function.levenshtein
version: PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   This function returns the Levenshtein-Distance between the
   two argument strings.
  </p>


name: localeconv
purpose: Get numeric formatting information
manual_id: function.localeconv
version: PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   <span class="function">localeconv</span> returns data based upon the current locale
   as set by <span class="function">setlocale</span>.  The associative array that is
   returned contains the following fields:
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Array element</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>decimal_point</td>
       <td>Decimal point character</td>
      </tr>

      <tr>
       <td>thousands_sep</td>
       <td>Thousands separator</td>
      </tr>

      <tr>
       <td>grouping</td>
       <td>Array containing numeric groupings</td>
      </tr>

      <tr>
       <td>int_curr_symbol</td>
       <td>International currency symbol (i.e. USD)</td>
      </tr>

      <tr>
       <td>currency_symbol</td>
       <td>Local currency symbol (i.e. $)</td>
      </tr>

      <tr>
       <td>mon_decimal_point</td>
       <td>Monetary decimal point character</td>
      </tr>

      <tr>
       <td>mon_thousands_sep</td>
       <td>Monetary thousands separator</td>
      </tr>

      <tr>
       <td>mon_grouping</td>
       <td>Array containing monetary groupings</td>
      </tr>

      <tr>
       <td>positive_sign</td>
       <td>Sign for positive values</td>
      </tr>

      <tr>
       <td>negative_sign</td>
       <td>Sign for negative values</td>
      </tr>

      <tr>
       <td>int_frac_digits</td>
       <td>International fractional digits</td>
      </tr>

      <tr>
       <td>frac_digits</td>
       <td>Local fractional digits</td>
      </tr>

      <tr>
       <td>p_cs_precedes</td>
       <td>
        <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if currency_symbol precedes a positive value, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
        if it succeeds one
       </td>
      </tr>

      <tr>
       <td>p_sep_by_space</td>
       <td>
        <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a space separates currency_symbol from a positive
        value, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise
       </td>
      </tr>

      <tr>
       <td>n_cs_precedes</td>
       <td>
        <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if currency_symbol precedes a negative value, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
        if it succeeds one
       </td>
      </tr>

      <tr>
       <td>n_sep_by_space</td>
       <td>
        <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a space separates currency_symbol from a negative
        value, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise
       </td>
      </tr>

      <tr style="vertical-align: top;">
       <td>p_sign_posn</td>
       <td>
        <ul class="simplelist">
         <li>0 - Parentheses surround the quantity and currency_symbol</li>
         <li>1 - The sign string precedes the quantity and currency_symbol</li>
         <li>2 - The sign string succeeds the quantity and currency_symbol</li>
         <li>3 - The sign string immediately precedes the currency_symbol</li>
         <li>4 - The sign string immediately succeeds the currency_symbol</li>
        </ul>
       </td>
      </tr>

      <tr style="vertical-align: top;">
       <td>n_sign_posn</td>
       <td>
        <ul class="simplelist">
         <li>0 - Parentheses surround the quantity and currency_symbol</li>
         <li>1 - The sign string precedes the quantity and currency_symbol</li>
         <li>2 - The sign string succeeds the quantity and currency_symbol</li>
         <li>3 - The sign string immediately precedes the currency_symbol</li>
         <li>4 - The sign string immediately succeeds the currency_symbol</li>
        </ul>
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
  <p class="para">
   The <code class="literal">p_sign_posn</code>, and <code class="literal">n_sign_posn</code> contain a string
   of formatting options. Each number representing one of the above listed conditions.
  </p>
  <p class="para">
   The grouping fields contain arrays that define the way numbers should be
   grouped. For example, the monetary grouping field for the nl_NL locale (in
   UTF-8 mode with the euro sign), would contain a 2 item array with the
   values 3 and 3. The higher the index in the array, the farther left the
   grouping is. If an array element is equal to <strong><code><a href="string.constants.html#constant.char-max">CHAR_MAX</a></code></strong>,
   no further grouping is done. If an array element is equal to 0, the previous
   element should be used.
  </p>


name: ltrim
purpose: Strip whitespace (or other characters) from the beginning of a string
manual_id: function.ltrim
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   This function returns a string with whitespace stripped from the
   beginning of <code class="parameter">string</code>.
   Without the second parameter,
   <span class="function">ltrim</span> will strip these characters:
   
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      &quot; &quot; (<acronym class="acronym">ASCII</acronym> <code class="literal">32</code>
      (<code class="literal">0x20</code>)), an ordinary space.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;\t&quot; (<acronym class="acronym">ASCII</acronym> <code class="literal">9</code>
      (<code class="literal">0x09</code>)), a tab.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;\n&quot; (<acronym class="acronym">ASCII</acronym> <code class="literal">10</code>
      (<code class="literal">0x0A</code>)), a new line (line feed).
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;\r&quot; (<acronym class="acronym">ASCII</acronym> <code class="literal">13</code>
      (<code class="literal">0x0D</code>)), a carriage return.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;\0&quot; (<acronym class="acronym">ASCII</acronym> <code class="literal">0</code>
      (<code class="literal">0x00</code>)), the <code class="literal">NUL</code>-byte.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;\v&quot; (<acronym class="acronym">ASCII</acronym> <code class="literal">11</code>
      (<code class="literal">0x0B</code>)), a vertical tab.
     </span>
    </li>
   </ul>
  </p>


