# functions

name: money_format
purpose: Formats a number as a currency string
manual_id: function.money-format
version: PHP 4 >= 4.3.0, PHP 5, PHP 7
return_type: string
return_description:
<p class="para">
   Returns the formatted string. Characters before and after the formatting
   string will be returned unchanged.
   Non-numeric <code class="parameter">number</code> causes returning <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> and
   emitting <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong>.
  </p>


name: nl_langinfo
purpose: Query language and locale information
manual_id: function.nl-langinfo
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the element as a string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">item</code>
   is not valid.
  </p>


name: quotemeta
purpose: Quote meta characters
manual_id: function.quotemeta
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the string with meta characters quoted, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an empty
   string is given as <code class="parameter">string</code>.
  </p>


name: setlocale
purpose: Set locale information
manual_id: function.setlocale
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the new current locale, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the locale functionality is
   not implemented on your platform, the specified locale does not exist or
   the category name is invalid.
  </p>
  <p class="para">
   An invalid category name also causes a warning message. Category/locale
   names can be found in <a href="http://www.faqs.org/rfcs/rfc1766" class="link external">&raquo;&nbsp;RFC 1766</a>
   and <a href="http://www.loc.gov/standards/iso639-2/php/code_list.php" class="link external">&raquo;&nbsp;ISO 639</a>.
   Different systems have different naming schemes for locales.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    The return value of <span class="function">setlocale</span> depends
    on the system that PHP is running.  It returns exactly
    what the system <code class="literal">setlocale</code> function returns.
   </p>
  </p></blockquote>


name: similar_text
purpose: Calculate the similarity between two strings
manual_id: function.similar-text
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the number of matching chars in both strings.
  </p>
  <p class="para">
   The number of matching characters is calculated by finding the longest first
   common substring, and then doing this for the prefixes and the suffixes,
   recursively. The lengths of all found common substrings are added.
  </p>


name: soundex
purpose: Calculate the soundex key of a string
manual_id: function.soundex
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the soundex key as a <span class="type">string</span> with four characters.
   If at least one letter is contained in <code class="parameter">string</code>, the returned
   string starts with a letter. Otherwise <code class="literal">&quot;0000&quot;</code> is returned.
  </p>


name: sprintf
purpose: Return a formatted string
manual_id: function.sprintf
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns a string produced according to the formatting string
   <code class="parameter">format</code>.
  </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: sscanf
purpose: Parses input from a string according to a format
manual_id: function.sscanf
version: PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   If only two parameters were passed to this function, 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>
  <p class="para">
   If there are more substrings expected in the <code class="parameter">format</code>
   than there are available within <code class="parameter">string</code>,
   <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> will be returned.
  </p>


name: str_contains
purpose: Determine if a string contains a given substring
manual_id: function.str-contains
version: 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 <code class="parameter">needle</code> is in
   <code class="parameter">haystack</code>, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: str_decrement
purpose: Decrement an alphanumeric string
manual_id: function.str-decrement
version: PHP 8 >= 8.3.0
return_type: string
return_description:
<p class="para">
   Returns the decremented alphanumeric <acronym class="acronym">ASCII</acronym> string.
  </p>

errors:
<p class="para">
   A <span class="classname">ValueError</span> is thrown if
   <code class="parameter">string</code> is empty.
  </p>
  <p class="para">
   A <span class="classname">ValueError</span> is thrown if
   <code class="parameter">string</code> is not an alphanumeric
   <acronym class="acronym">ASCII</acronym> string.
  </p>
  <p class="para">
   A <span class="classname">ValueError</span> is thrown if
   <code class="parameter">string</code> cannot be decremented.
   For example, <code class="literal">&quot;A&quot;</code> or <code class="literal">&quot;0&quot;</code>.
  </p>


name: str_ends_with
purpose: Checks if a string ends with a given substring
manual_id: function.str-ends-with
version: 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 <code class="parameter">haystack</code> ends with
   <code class="parameter">needle</code>, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: str_increment
purpose: Increment an alphanumeric string
manual_id: function.str-increment
version: PHP 8 >= 8.3.0
return_type: string
return_description:
<p class="para">
   Returns the incremented alphanumeric <acronym class="acronym">ASCII</acronym> string.
  </p>

errors:
<p class="para">
   A <span class="classname">ValueError</span> is thrown if
   <code class="parameter">string</code> is empty.
  </p>
  <p class="para">
   A <span class="classname">ValueError</span> is thrown if
   <code class="parameter">string</code> is not an alphanumeric
   <acronym class="acronym">ASCII</acronym> string.
  </p>


name: str_split
purpose: Convert a string to an array
manual_id: function.str-split
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   If the optional <code class="parameter">length</code> parameter is
   specified, the returned array will be broken down into chunks with each
   being <code class="parameter">length</code> in length, except the final chunk
   which may be shorter if the string does not divide evenly.  The default
   <code class="parameter">length</code> is <code class="literal">1</code>, meaning every chunk will be one byte in size.
  </p>

errors:
<p class="para">
   If <code class="parameter">length</code> is less than <code class="literal">1</code>,
   a <span class="classname">ValueError</span> will be thrown.
  </p>


name: str_starts_with
purpose: Checks if a string starts with a given substring
manual_id: function.str-starts-with
version: 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 <code class="parameter">haystack</code> begins with
   <code class="parameter">needle</code>, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: str_word_count
purpose: Return information about words used in a string
manual_id: function.str-word-count
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns an array or an integer, depending on the
   <code class="parameter">format</code> chosen.
  </p>


name: strcasecmp
purpose: Binary safe case-insensitive string comparison
manual_id: function.strcasecmp
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns <code class="literal">-1</code> if <code class="parameter">string1</code> is less than
   <code class="parameter">string2</code>; <code class="literal">1</code> if <code class="parameter">string1</code>
   is greater than <code class="parameter">string2</code>, and <code class="literal">0</code> if they are
   equal.
  </p>


name: strcoll
purpose: Locale based string comparison
manual_id: function.strcoll
version: PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns &lt; 0 if <code class="parameter">string1</code> is less than
   <code class="parameter">string2</code>; &gt; 0 if
   <code class="parameter">string1</code> is greater than
   <code class="parameter">string2</code>, and 0 if they are equal.
  </p>


name: strcspn
purpose: Find length of initial segment not matching mask
manual_id: function.strcspn
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the length of the initial segment of <code class="parameter">string</code>
   which consists entirely of characters <em>not</em> in <code class="parameter">characters</code>.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    When a <code class="parameter">offset</code> parameter is set, the returned length
    is counted starting from this position, not from the beginning of
    <code class="parameter">string</code>.
   </p>
  </p></blockquote>


name: stripos
purpose: Find the position of the first occurrence of a case-insensitive substring in a string
manual_id: function.stripos
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the position of where the needle exists relative to the beginning of
   the <code class="parameter">haystack</code> string (independent of offset).
   Also note that string positions start at 0, and not 1.
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the needle was 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: stripslashes
purpose: Un-quotes a quoted string
manual_id: function.stripslashes
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns a string with backslashes stripped off.
   (<code class="literal">\&#039;</code> becomes <code class="literal">&#039;</code> and so on.)
   Double backslashes (<code class="literal">\\</code>) are made into a single
   backslash (<code class="literal">\</code>).
  </p>


name: stristr
purpose: Case-insensitive strstr
manual_id: function.stristr
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the matched substring. If <code class="parameter">needle</code> is not
   found, returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: strnatcasecmp
purpose: Case insensitive string comparisons using a "natural order" algorithm
manual_id: function.strnatcasecmp
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Similar to other string comparison functions, this one returns <code class="literal">-1</code> if
   <code class="parameter">string1</code> is less than <code class="parameter">string2</code>
   <code class="literal">1</code> if <code class="parameter">string1</code> is greater than
   <code class="parameter">string2</code>, and <code class="literal">0</code> if they are equal.
  </p>


name: strnatcmp
purpose: String comparisons using a "natural order" algorithm
manual_id: function.strnatcmp
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Similar to other string comparison functions, this one returns <code class="literal">-1</code> if
   <code class="parameter">string1</code> is less than <code class="parameter">string2</code>;
   <code class="literal">1</code> if <code class="parameter">string1</code> is greater than
   <code class="parameter">string2</code>, and <code class="literal">0</code> if they are equal.
  </p>


name: strncasecmp
purpose: Binary safe case-insensitive string comparison of the first n characters
manual_id: function.strncasecmp
version: PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns <code class="literal">-1</code> if <code class="parameter">string1</code> is less than
   <code class="parameter">string2</code>; <code class="literal">1</code> if <code class="parameter">string1</code> is
   greater than <code class="parameter">string2</code>, and <code class="literal">0</code> if they are equal.
  </p>


name: strpbrk
purpose: Search a string for any of a set of characters
manual_id: function.strpbrk
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a string starting from the character found, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it is
   not found.
  </p>


name: strrchr
purpose: Find the last occurrence of a character in a string
manual_id: function.strrchr
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   This function returns the portion of string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if
   <code class="parameter">needle</code> is not found.
  </p>


name: strripos
purpose: Find the position of the last occurrence of a case-insensitive substring in a string
manual_id: function.strripos
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the position where the needle exists relative to the beginnning of
   the <code class="parameter">haystack</code> string (independent of search direction
   or offset).
   <blockquote class="note"><p><strong class="note">Note</strong>: 
    <span class="simpara">
     String positions start at 0, and not 1.
    </span>
   </p></blockquote>
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the needle was 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: strrpos
purpose: Find the position of the last occurrence of a substring in a string
manual_id: function.strrpos
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the position where the needle exists relative to the beginning of
   the <code class="parameter">haystack</code> string (independent of search direction
   or offset).
   <blockquote class="note"><p><strong class="note">Note</strong>: 
    <span class="simpara">
     String positions start at 0, and not 1.
    </span>
   </p></blockquote>
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the needle was 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: strspn
manual_id: function.strspn
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
purpose:
Finds the length of the initial segment of a string consisting   entirely of characters contained within a given mask

return_description:
<p class="para">
   Returns the length of the initial segment of <code class="parameter">string</code>
   which consists entirely of characters in <code class="parameter">characters</code>.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    When a <code class="parameter">offset</code> parameter is set, the returned length
    is counted starting from this position, not from the beginning of
    <code class="parameter">string</code>.
   </p>
  </p></blockquote>


name: strstr
purpose: Find the first occurrence of a string
manual_id: function.strstr
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the portion of string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">needle</code>
   is not found.
  </p>


name: strtok
purpose: Tokenize string
manual_id: function.strtok
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   A <span class="type">string</span> token, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if no more tokens are available.
  </p>


name: substr_compare
purpose: Binary safe comparison of two strings from an offset, up to length characters
manual_id: function.substr-compare
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns <code class="literal">-1</code> if <code class="parameter">haystack</code> from position
   <code class="parameter">offset</code> is less than <code class="parameter">needle</code>, <code class="literal">1</code>
   if it is greater than <code class="parameter">needle</code>, and <code class="literal">0</code> if they are equal.
   If <code class="parameter">offset</code> is equal to (prior to PHP 7.2.18, 7.3.5) or
   greater than the length of <code class="parameter">haystack</code>, or the
   <code class="parameter">length</code> is set and is less than 0,
   <span class="function">substr_compare</span> prints a warning and returns
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: substr_replace
purpose: Replace text within a portion of a string
manual_id: function.substr-replace
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   The result string is returned. If <code class="parameter">string</code> is an
   array then array is returned.
  </p>


name: substr
purpose: Return part of a string
manual_id: function.substr
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the extracted part of <code class="parameter">string</code>, or
   an empty string.
  </p>


name: utf8_decode
purpose: Converts a string from UTF-8 to ISO-8859-1, replacing invalid or unrepresentable characters
manual_id: function.utf8-decode
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the ISO-8859-1 translation of <code class="parameter">string</code>.
  </p>


name: vfprintf
purpose: Write a formatted string to a stream
manual_id: function.vfprintf
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description: <p class="para"> Returns the length of the outputted string. </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">ValueError</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: vsprintf
purpose: Return a formatted string
manual_id: function.vsprintf
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Return array values as a formatted string according to
   <code class="parameter">format</code>.
  </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">ValueError</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: array_chunk
purpose: Split an array into chunks
manual_id: function.array-chunk
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns a multidimensional numerically indexed array, starting with zero,
   with each dimension containing <code class="parameter">length</code> elements.
  </p>

errors:
<p class="para">
   If <code class="parameter">length</code> is less than <code class="literal">1</code>,
   a <span class="classname">ValueError</span> will be thrown.
  </p>


name: array_column
purpose: Return the values from a single column in the input array
manual_id: function.array-column
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array of values representing a single column from the input array.
  </p>


name: array_combine
purpose: Creates an array by using one array for keys and another for its values
manual_id: function.array-combine
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description: <p class="para"> Returns the combined <span class="type">array</span>. </p>
errors:
<p class="para">
   As of PHP 8.0.0, a <span class="classname">ValueError</span> is thrown if the number of elements in
   <code class="parameter">keys</code> and <code class="parameter">values</code> does not
   match.
   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>


name: array_count_values
purpose: Counts the occurrences of each distinct value in an array
manual_id: function.array-count-values
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns an associative array of values from <code class="parameter">array</code> as
   keys and their count as value.
  </p>

errors:
<p class="para">
   Throws <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> for every element which is not
   <span class="type">string</span> or <span class="type">int</span>.
  </p>


name: array_diff_assoc
purpose: Computes the difference of arrays with additional index check
manual_id: function.array-diff-assoc
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an <span class="type">array</span> containing all the values from
   <code class="parameter">array</code> that are not present in any of the other arrays.
  </p>


name: array_diff_key
purpose: Computes the difference of arrays using keys for comparison
manual_id: function.array-diff-key
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an <span class="type">array</span> containing all the entries from
   <code class="parameter">array</code> whose keys are absent from all of the
   other arrays.
  </p>


name: array_diff_uassoc
manual_id: function.array-diff-uassoc
version: PHP 5, PHP 7, PHP 8
return_type: array
purpose:
Computes the difference of arrays with additional index check which is performed by a user supplied callback function

return_description:
<p class="para">
   Returns an <span class="type">array</span> containing all the entries from
   <code class="parameter">array</code> that are not present in any of the other arrays.
  </p>


name: array_diff
purpose: Computes the difference of arrays
manual_id: function.array-diff
version: PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an <span class="type">array</span> containing all the entries from
   <code class="parameter">array</code> that are not present in any of the other arrays.
   Keys in the <code class="parameter">array</code> array are preserved.
  </p>


name: array_fill
purpose: Fill an array with values
manual_id: function.array-fill
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: array
return_description: <p class="para"> Returns the filled array </p>
errors:
<p class="para">
   Throws a <span class="classname">ValueError</span> if <code class="parameter">count</code> is
   out of range.
  </p>


name: array_intersect_assoc
purpose: Computes the intersection of arrays with additional index check
manual_id: function.array-intersect-assoc
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an associative array containing all the values in 
   <code class="parameter">array</code> that are present in all of the arguments.
  </p>


name: array_intersect_key
purpose: Computes the intersection of arrays using keys for comparison
manual_id: function.array-intersect-key
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an associative array containing all the entries of 
   <code class="parameter">array</code> which have keys that are present in all
   arguments.
  </p>


name: array_intersect_uassoc
manual_id: function.array-intersect-uassoc
version: PHP 5, PHP 7, PHP 8
return_type: array
purpose:
Computes the intersection of arrays with additional index check, compares indexes by a callback function

return_description:
<p class="para">
   Returns the values of <code class="parameter">array</code> whose values exist
   in all of the arguments.
  </p>


name: array_intersect_ukey
purpose: Computes the intersection of arrays using a callback function on the keys for comparison
manual_id: function.array-intersect-ukey
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns the values of <code class="parameter">array</code> whose keys exist
   in all the arguments.
  </p>


name: array_intersect
purpose: Computes the intersection of arrays
manual_id: function.array-intersect
version: PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array containing all of the values in 
   <code class="parameter">array</code> whose values exist in all of the parameters.
  </p>


name: array_is_list
purpose: Checks whether a given array is a list
manual_id: function.array-is-list
version: PHP 8 >= 8.1.0
return_type: array
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if <code class="parameter">array</code> is a list, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   otherwise.
  </p>


name: array_key_exists
purpose: Checks if the given key or index exists in the array
manual_id: function.array-key-exists
version: PHP 4 >= 4.0.7, 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>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    <span class="function">array_key_exists</span> will search for the keys in the first dimension only.
    Nested keys in multidimensional arrays will not be found.
   </p>
  </p></blockquote>


name: array_key_first
purpose: Gets the first key of an array
manual_id: function.array-key-first
version: PHP 7 >= 7.3.0, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the first key of <code class="parameter">array</code> if the array is not empty;
   <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> otherwise.
  </p>


name: array_key_last
purpose: Gets the last key of an array
manual_id: function.array-key-last
version: PHP 7 >= 7.3.0, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the last key of <code class="parameter">array</code> if the array is not empty;
   <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> otherwise.
  </p>


name: array_keys
purpose: Return all the keys or a subset of the keys of an array
manual_id: function.array-keys
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array of all the keys in <code class="parameter">array</code>.
  </p>


name: array_map
purpose: Applies the callback to the elements of the given arrays
manual_id: function.array-map
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array containing the results of applying the <code class="parameter">callback</code>
   function to the corresponding value of <code class="parameter">array</code>
   (and <code class="parameter">arrays</code> if more arrays are provided)
   used as arguments for the callback.
  </p>
  <p class="para">
   The returned array will preserve the keys of the array argument if and only
   if exactly one array is passed. If more than one array is passed, the
   returned array will have sequential integer keys.
  </p>


name: array_merge_recursive
purpose: Merge one or more arrays recursively
manual_id: function.array-merge-recursive
version: PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An array of values resulted from merging the arguments together.
   If called without any arguments, returns an empty <span class="type">array</span>.
  </p>


name: array_merge
purpose: Merge one or more arrays
manual_id: function.array-merge
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns the resulting array.
   If called without any arguments, returns an empty <span class="type">array</span>.
  </p>


name: array_pad
purpose: Pad array to the specified length with a value
manual_id: function.array-pad
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns a copy of the <code class="parameter">array</code> padded to size specified
   by <code class="parameter">length</code> with value 
   <code class="parameter">value</code>. If <code class="parameter">length</code> is 
   positive then the array is padded on the right, if it&#039;s negative then 
   on the left. If the absolute value of <code class="parameter">length</code> is less
   than or equal to the length of the <code class="parameter">array</code> then no
   padding takes place.
  </p>


name: array_pop
purpose: Pop the element off the end of array
manual_id: function.array-pop
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns the value of the last element of <code class="parameter">array</code>.
   If <code class="parameter">array</code> is empty,
   <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> will be returned.
  </p>


name: array_rand
purpose: Pick one or more random keys out of an array
manual_id: function.array-rand
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   When picking only one entry, <span class="function">array_rand</span> returns
   the key for a random entry. Otherwise, an array of keys for the random
   entries is returned. This is done so that random keys can be picked
   from the array as well as random values. If multiple keys are returned,
   they will be returned in the order they were present in the original array.
  </p>

errors:
<p class="para">
   Throws a <span class="classname">ValueError</span> if <code class="parameter">array</code> is empty,
   or if <code class="parameter">num</code> is out of range.
  </p>


name: array_reduce
purpose: Iteratively reduce the array to a single value using a callback function
manual_id: function.array-reduce
version: PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns the resulting value.
  </p>
  <p class="para">
   If the array is empty and <code class="parameter">initial</code> is not passed,
   <span class="function">array_reduce</span> returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>


name: array_search
purpose: Searches the array for a given value and returns the first corresponding key if successful
manual_id: function.array-search
version: PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the key for <code class="parameter">needle</code> if it is found in the
   array, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>
  <p class="para">
   If <code class="parameter">needle</code> is found in <code class="parameter">haystack</code>
   more than once, the first matching key is returned. To return the keys for
   all matching values, use <span class="function">array_keys</span> with the optional
   <code class="parameter">filter_value</code> parameter instead.
  </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: array_shift
purpose: Shift an element off the beginning of array
manual_id: function.array-shift
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns the shifted value, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if <code class="parameter">array</code> is
   empty or is not an array.
  </p>


name: array_slice
purpose: Extract a slice of the array
manual_id: function.array-slice
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns the slice. If the offset is larger than the size of the array,
   an empty array is returned.
  </p>


name: array_sum
purpose: Calculate the sum of values in an array
manual_id: function.array-sum
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: float
return_description:
<p class="para">
   Returns the sum of values as an integer or float; <code class="literal">0</code> if the
   <code class="parameter">array</code> is empty.
  </p>


name: array_udiff_assoc
purpose: Computes the difference of arrays with additional index check, compares data by a callback function
manual_id: function.array-udiff-assoc
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   <span class="function">array_udiff_assoc</span> returns an <span class="type">array</span>
   containing all the values from <code class="parameter">array</code>
   that are not present in any of the other arguments.
   Note that the keys are used in the comparison unlike
   <span class="function">array_diff</span> and <span class="function">array_udiff</span>.
   The comparison of arrays&#039; data is performed by using an user-supplied
   callback. In this aspect the behaviour is opposite to the behaviour of
   <span class="function">array_diff_assoc</span> which uses internal function for
   comparison.
  </p>


name: array_udiff_uassoc
manual_id: function.array-udiff-uassoc
version: PHP 5, PHP 7, PHP 8
return_type: array
purpose:
Computes the difference of arrays with additional index check, compares data and indexes by a callback function

return_description:
<p class="para">
   Returns an <span class="type">array</span> containing all the values from
   <code class="parameter">array</code> that are not present in any of the other
   arguments.
  </p>


name: array_udiff
purpose: Computes the difference of arrays by using a callback function for data comparison
manual_id: function.array-udiff
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array containing all the values of <code class="parameter">array</code>
   that are not present in any of the other arguments.
  </p>


name: array_uintersect_assoc
manual_id: function.array-uintersect-assoc
version: PHP 5, PHP 7, PHP 8
return_type: array
purpose:
Computes the intersection of arrays with additional index check, compares data by a callback function

return_description:
<p class="para">
   Returns an array containing all the values of
   <code class="parameter">array</code> that are present in all the arguments.
  </p>


name: array_uintersect_uassoc
manual_id: function.array-uintersect-uassoc
version: PHP 5, PHP 7, PHP 8
return_type: array
purpose:
Computes the intersection of arrays with additional index check, compares data and indexes by separate callback functions

return_description:
<p class="para">
   Returns an array containing all the values of
   <code class="parameter">array1</code> that are present in all the arguments.
  </p>


name: array_uintersect
purpose: Computes the intersection of arrays, compares data by a callback function
manual_id: function.array-uintersect
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array containing all the values of <code class="parameter">array</code>
   that are present in all the arguments.
  </p>


name: array_unshift
purpose: Prepend one or more elements to the beginning of an array
manual_id: function.array-unshift
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the new number of elements in the <code class="parameter">array</code>.
  </p>


name: array_walk
purpose: Apply a user supplied function to every member of an array
manual_id: function.array-walk
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   As of PHP 7.1.0, an <span class="classname">ArgumentCountError</span> will be thrown if the <code class="parameter">callback</code> function 
   requires more than 2 parameters (the value and key of the array member),
   or more than 3 parameters if the <code class="parameter">arg</code> is also passed.
   Previously, in this case
   an error of level <a href="errorfunc.constants.html" class="link">E_WARNING</a> would be generated each time 
   <span class="function">array_walk</span> calls <code class="parameter">callback</code>.
  </p>


name: array
purpose: Create an array
manual_id: function.array
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array of the parameters.  The parameters can be given
   an index with the <code class="literal">=&gt;</code> operator.  Read the section
   on the <a href="language.types.array.html" class="link">array type</a> for more
   information on what an array is.
  </p>


name: compact
purpose: Create array containing variables and their values
manual_id: function.compact
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description: <p class="para"> Returns the output array with all the variables added to it. </p>
errors:
<p class="para">
   <span class="function">compact</span> issues an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error if a given string
   refers to an unset variable.
  </p>


name: count
purpose: Counts all elements in an array or in a Countable object
manual_id: function.count
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the number of elements in <code class="parameter">value</code>.
   Prior to PHP 8.0.0, if the parameter was neither an <span class="type">array</span> nor an <span class="type">object</span> that
   implements the <span class="interfacename">Countable</span> interface,
   <code class="literal">1</code> would be returned,
   unless <code class="parameter">value</code> was <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, in which case
   <code class="literal">0</code> would be returned.
  </p>


name: current
purpose: Return the current element in an array
manual_id: function.current
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   The <span class="function">current</span> function simply returns the
   value of the array element that&#039;s currently being pointed to by the
   internal pointer.  It does not move the pointer in any way.  If the
   internal pointer points beyond the end of the elements list or the array is 
   empty, <span class="function">current</span> returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </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: each
purpose: Return the current key and value pair from an array and advance the array cursor
manual_id: function.each
version: PHP 4, PHP 5, PHP 7
return_type: array
return_description:
<p class="para">
   Returns the current key and value pair from the array
   <code class="parameter">array</code>. This pair is returned in a four-element
   array, with the keys <code class="literal">0</code>, <code class="literal">1</code>,
   <code class="literal">key</code>, and <code class="literal">value</code>. Elements
   <code class="literal">0</code> and <code class="literal">key</code> contain the key name of
   the array element, and <code class="literal">1</code> and <code class="literal">value</code>
   contain the data.
  </p>
  <p class="para">
   If the internal pointer for the array points past the end of the
   array contents, <span class="function">each</span> returns
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: end
purpose: Set the internal pointer of an array to its last element
manual_id: function.end
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns the value of the last element or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> for empty array.
  </p>


name: extract
purpose: Import variables into the current symbol table from an array
manual_id: function.extract
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the number of variables successfully imported into the symbol
   table.
  </p>


name: in_array
purpose: Checks if a value exists in an array
manual_id: function.in-array
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 <code class="parameter">needle</code> is found in the array,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: key
purpose: Fetch a key from an array
manual_id: function.key
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The <span class="function">key</span> function simply returns the
   key of the array element that&#039;s currently being pointed to by the
   internal pointer.  It does not move the pointer in any way.  If the
   internal pointer points beyond the end of the elements list or the array is 
   empty, <span class="function">key</span> returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>


name: next
purpose: Advance the internal pointer of an array
manual_id: function.next
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns the array value in the next place that&#039;s pointed to by the
   internal array pointer, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there are no more elements.
  </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: prev
purpose: Rewind the internal array pointer
manual_id: function.prev
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns the array value in the previous place that&#039;s pointed to by
   the internal array pointer, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there are no more
   elements.
  </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: range
purpose: Create an array containing a range of elements
manual_id: function.range
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns a sequence of elements as an <span class="type">array</span> with the first
   element being <code class="parameter">start</code> going up to
   <code class="parameter">end</code>, with each value of the sequence being
   <code class="parameter">step</code> values apart.
  </p>
  <p class="para">
   The last element of the returned array is either <code class="parameter">end</code>
   or the previous element of the sequence,
   depending on the value of <code class="parameter">step</code>.
  </p>
  <p class="para">
   If both <code class="parameter">start</code> and <code class="parameter">end</code> are
   <span class="type">string</span>s, and <code class="parameter">step</code> is <span class="type">int</span>
   the produced array will be a sequence of bytes,
   generally latin <abbr class="abbrev">ASCII</abbr> characters.
  </p>
  <p class="para">
   If at least one of <code class="parameter">start</code>, <code class="parameter">end</code>,
   or <code class="parameter">step</code> is <span class="type">float</span>
   the produced array will be a sequence of <span class="type">float</span>.
  </p>
  <p class="para">
   Otherwise, the produced array will be a sequence of <span class="type">int</span>.
  </p>

errors:
<ul class="itemizedlist">
   <li class="listitem">
    <span class="simpara">
     If <code class="parameter">step</code> is <code class="literal">0</code>,
     a <span class="classname">ValueError</span> is thrown.
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     If <code class="parameter">start</code>, <code class="parameter">end</code>,
     or <code class="parameter">step</code> is not <span class="function">is_finite</span>,
     a <span class="classname">ValueError</span> is thrown.
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     If <code class="parameter">step</code> is negative,
     but the produced range is increasing
     (i.e. <code class="code">$start &lt;= $end</code>),
     a <span class="classname">ValueError</span> is thrown.
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     If <code class="parameter">start</code> or <code class="parameter">end</code>
     is the empty string <code class="literal">&#039;&#039;</code>,
     an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted and
     the empty string will be interpreted as <code class="literal">0</code>.
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     If <code class="parameter">start</code> or <code class="parameter">end</code>
     non-<a href="language.types.numeric-strings.html" class="link">numeric string</a>
     with more than one byte, an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted.
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     If <code class="parameter">start</code> or <code class="parameter">end</code> is a string
     that is implicitly cast to an <span class="type">int</span> because the other boundary
     value is a number, an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted.
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     If <code class="parameter">step</code> is a <span class="type">float</span>,
     and <code class="parameter">start</code> and <code class="parameter">end</code> are
     non-<a href="language.types.numeric-strings.html" class="link">numeric string</a>,
     an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted.
    </span>
   </li>
  </ul>


name: reset
purpose: Set the internal pointer of an array to its first element
manual_id: function.reset
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns the value of the first array element, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the array is
   empty.
  </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: class_exists
purpose: Checks if the class has been defined
manual_id: function.class-exists
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 <code class="parameter">class</code> is a defined class,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: enum_exists
purpose: Checks if the enum has been defined
manual_id: function.enum-exists
version: PHP 8 >= 8.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 <code class="parameter">enum</code> is a defined enum,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: get_called_class
purpose: The "Late Static Binding" class name
manual_id: function.get-called-class
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: string
return_description: <p class="para"> Returns the class name. </p>
errors:
<p class="para">
   If <span class="function">get_called_class</span> is called from outside a class,
   an <span class="classname">Error</span> is thrown. Prior to PHP 8.0.0,
   an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error was raised.
  </p>


name: get_class_methods
purpose: Gets the class methods' names
manual_id: function.get-class-methods
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array of method names defined for the class specified by
   <code class="parameter">object_or_class</code>.
  </p>


name: get_class_vars
purpose: Get the default properties of the class
manual_id: function.get-class-vars
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an associative array of declared properties visible from the
   current scope, with their default value.
   The resulting array elements are in the form of 
   <code class="literal">varname =&gt; value</code>.
   In case of an error, it returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: get_class
purpose: Returns the name of the class of an object
manual_id: function.get-class
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the name of the class of which <code class="parameter">object</code> is an
   instance.
  </p>
  <p class="para">
   If the <code class="parameter">object</code> is an instance of a class which exists 
   in a namespace, the qualified namespaced name of that class is returned.
  </p>

errors:
<p class="para">
   If <span class="function">get_class</span> is called with anything other than an
   object, <span class="classname">TypeError</span> is raised. Prior to PHP 8.0.0,
   an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error was raised.
  </p>
  <p class="para">
   If <span class="function">get_class</span> is called with no arguments from outside a class,
   an <span class="classname">Error</span> is thrown. Prior to PHP 8.0.0,
   an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error was raised.
  </p>


name: get_declared_classes
purpose: Returns an array with the name of the defined classes
manual_id: function.get-declared-classes
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array of the names of the declared classes in the current
   script.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    Note that depending on what extensions you have compiled or
    loaded into PHP, additional classes could be present. This means that
    you will not be able to define your own classes using these
    names. There is a list of predefined classes in the <a href="reserved.classes.html" class="link">Predefined Classes</a> section of
    the appendices.
   </p>
  </p></blockquote>


name: get_declared_interfaces
purpose: Returns an array of all declared interfaces
manual_id: function.get-declared-interfaces
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array of the names of the declared interfaces in the current
   script.
  </p>


name: get_mangled_object_vars
purpose: Returns an array of mangled object properties
manual_id: function.get-mangled-object-vars
version: PHP 7 >= 7.4.0, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an <span class="type">array</span> containing all properties, regardless of visibility, of <code class="parameter">object</code>.
  </p>


name: get_object_vars
purpose: Gets the properties of the given object
manual_id: function.get-object-vars
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an associative array of defined object accessible non-static properties 
   for the specified <code class="parameter">object</code> in scope.
  </p>


name: get_parent_class
purpose: Retrieves the parent class name for object or class
manual_id: function.get-parent-class
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the name of the parent class of the class of which
   <code class="parameter">object_or_class</code> is an instance or the name.
  </p>
  <p class="para">
   If the object does not have a parent or the given class does not exist,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> will be returned.
  </p>


name: interface_exists
purpose: Checks if the interface has been defined
manual_id: function.interface-exists
version: PHP 5 >= 5.0.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 interface given by 
   <code class="parameter">interface</code> has been defined, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: is_a
purpose: Checks whether the object is of a given type or subtype
manual_id: function.is-a
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 <code class="parameter">object_or_class</code> is the
   <code class="parameter">class</code> object type,
   or has <code class="parameter">class</code> as one of its supertypes, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: is_subclass_of
purpose: Checks if the object has this class as one of its parents or implements it
manual_id: function.is-subclass-of
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 the object <code class="parameter">object_or_class</code>,
   belongs to a class which is a subclass of
   <code class="parameter">class</code>, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: method_exists
purpose: Checks if the class method exists
manual_id: function.method-exists
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 the method given by <code class="parameter">method</code>
   has been defined for the given <code class="parameter">object_or_class</code>, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   otherwise.
  </p>


name: property_exists
purpose: Checks if the object or class has a property
manual_id: function.property-exists
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 property exists, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it doesn&#039;t exist.
  </p>


name: trait_exists
purpose: Checks if the trait exists
manual_id: function.trait-exists
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 trait exists, and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ctype_alnum
purpose: Check for alphanumeric character(s)
manual_id: function.ctype-alnum
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if every character in <code class="parameter">text</code> is either
   a letter or a digit, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
   When called with an empty string the result will always be <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ctype_alpha
purpose: Check for alphabetic character(s)
manual_id: function.ctype-alpha
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if every character in <code class="parameter">text</code> is 
   a letter from the current locale, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
   When called with an empty string the result will always be <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ctype_cntrl
purpose: Check for control character(s)
manual_id: function.ctype-cntrl
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if every character in <code class="parameter">text</code> is 
   a control character from the current locale, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
   When called with an empty string the result will always be <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ctype_digit
purpose: Check for numeric character(s)
manual_id: function.ctype-digit
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if every character in the string
   <code class="parameter">text</code> is a decimal digit, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
   When called with an empty string the result will always be <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ctype_graph
purpose: Check for any printable character(s) except space
manual_id: function.ctype-graph
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if every character in <code class="parameter">text</code> is 
   printable and actually creates visible output (no white space), <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   otherwise.
   When called with an empty string the result will always be <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ctype_lower
purpose: Check for lowercase character(s)
manual_id: function.ctype-lower
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if every character in <code class="parameter">text</code> is 
   a lowercase letter in the current locale.
   When called with an empty string the result will always be <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ctype_print
purpose: Check for printable character(s)
manual_id: function.ctype-print
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if every character in <code class="parameter">text</code> 
   will actually create output (including blanks). Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if 
   <code class="parameter">text</code> contains control characters or characters 
   that do not have any output or control function at all.
   When called with an empty string the result will always be <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ctype_punct
purpose: Check for any printable character which is not whitespace or an alphanumeric character
manual_id: function.ctype-punct
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if every character in <code class="parameter">text</code> 
   is printable, but neither letter, digit or blank, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
   When called with an empty string the result will always be <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ctype_space
purpose: Check for whitespace character(s)
manual_id: function.ctype-space
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if every character in <code class="parameter">text</code> 
   creates some sort of white space, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise. Besides the 
   blank character this also includes tab, vertical tab, line feed,
   carriage return and form feed characters.
   When called with an empty string the result will always be <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ctype_upper
purpose: Check for uppercase character(s)
manual_id: function.ctype-upper
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if every character in <code class="parameter">text</code> is 
   an uppercase letter in the current locale.
   When called with an empty string the result will always be <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ctype_xdigit
purpose: Check for character(s) representing a hexadecimal digit
manual_id: function.ctype-xdigit
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if every character in <code class="parameter">text</code> is 
   a hexadecimal &#039;digit&#039;, that is a decimal digit or a character from 
   <code class="literal">[A-Fa-f]</code> , <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
   When called with an empty string the result will always be <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: filter_id
purpose: Returns the filter ID belonging to a named filter
manual_id: function.filter-id
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   ID of a filter on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if filter doesn&#039;t exist.
  </p>


name: filter_input_array
purpose: Gets external variables and optionally filters them
manual_id: function.filter-input-array
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   An array containing the values of the requested variables on success.
   If the input array designated by <code class="parameter">type</code> is not populated,
   the function returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the <strong><code><a href="filter.constants.html#constant.filter-null-on-failure">FILTER_NULL_ON_FAILURE</a></code></strong>
   flag is not given, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise. For other failures, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>
  <p class="para">
   An array value will be <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the filter fails, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if 
   the variable is not set. Or if the flag <strong><code><a href="filter.constants.html#constant.filter-null-on-failure">FILTER_NULL_ON_FAILURE</a></code></strong>
   is used, it returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the variable is not set and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the filter 
   fails. If the <code class="parameter">add_empty</code> parameter is <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, no array
   element will be added for unset variables.
  </p>


name: filter_input
purpose: Gets a specific external variable by name and optionally filters it
manual_id: function.filter-input
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Value of the requested variable on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the filter fails,
   or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the <code class="parameter">var_name</code> variable is not set.
   If the flag <strong><code><a href="filter.constants.html#constant.filter-null-on-failure">FILTER_NULL_ON_FAILURE</a></code></strong> is used, it
   returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the variable is not set and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the filter fails.
   </p>


name: filter_list
purpose: Returns a list of all supported filters
manual_id: function.filter-list
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array of names of all supported filters, empty array if there
   are no such filters. Indexes of this array are not filter IDs, they can be
   obtained with <span class="function">filter_id</span> from a name instead.
  </p>


name: filter_var_array
purpose: Gets multiple variables and optionally filters them
manual_id: function.filter-var-array
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   An array containing the values of the requested variables on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> 
   on failure. An array value will be <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the filter fails, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if 
   the variable is not set.
  </p>


name: filter_var
purpose: Filters a variable with a specified filter
manual_id: function.filter-var
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns the filtered data, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the filter fails.
  </p>


name: call_user_func_array
purpose: Call a callback with an array of parameters
manual_id: function.call-user-func-array
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns the return value of the callback, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: create_function
purpose: Create a function dynamically by evaluating a string of code
manual_id: function.create-function
version: PHP 4 >= 4.0.1, PHP 5, PHP 7
return_type: string
return_description:
<p class="para">
   Returns a unique function name as a string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   Note that the name contains a non-printable character (<code class="literal">&quot;\0&quot;</code>),
   so care should be taken when printing the name or incorporating it in any other
   string.
  </p>


name: forward_static_call_array
purpose: Call a static method and pass the arguments as array
manual_id: function.forward-static-call-array
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns the function result, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: func_get_arg
purpose: Return an item from the argument list
manual_id: function.func-get-arg
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns the specified argument, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>

errors:
<p class="para">
   Generates a warning if called from outside of a user-defined function, or
   if <code class="parameter">position</code> is greater than the number of arguments
   actually passed.
  </p>


name: func_get_args
purpose: Returns an array comprising a function's argument list
manual_id: function.func-get-args
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
errors: <p class="para"> Generates a warning if called from outside of a user-defined function. </p>
return_description:
<p class="para">
   Returns an array in which each element is a copy of the corresponding
   member of the current user-defined function&#039;s argument list. 
  </p>


name: func_num_args
purpose: Returns the number of arguments passed to the function
manual_id: function.func-num-args
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
errors: <p class="para"> Generates a warning if called from outside of a user-defined function. </p>
return_description:
<p class="para">
   Returns the number of arguments passed into the current user-defined
   function.
  </p>


name: function_exists
purpose: Return true if the given function has been defined
manual_id: function.function-exists
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 <code class="parameter">function</code> exists and is a
   function, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    This function will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> for constructs, such as 
    <span class="function">include_once</span> and <span class="function">echo</span>.
   </p>
  </p></blockquote>


name: get_defined_functions
purpose: Returns an array of all defined functions
manual_id: function.get-defined-functions
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns a multidimensional array containing a list of all defined
   functions, both built-in (internal) and user-defined. The internal
   functions will be accessible via <var class="varname">$arr[&quot;internal&quot;]</var>, and
   the user defined ones using <var class="varname">$arr[&quot;user&quot;]</var> (see example
   below).
  </p>


name: QuickHashIntSet.add
purpose: This method adds a new entry to the set
manual_id: quickhashintset.add
version: PECL quickhash >= Unknown
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> when the entry was added, and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the entry was not added.
  </p>


name: QuickHashIntSet.delete
purpose: This method deletes an entry from the set
manual_id: quickhashintset.delete
version: PECL quickhash >= Unknown
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> when the entry was deleted, and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the entry was not deleted.
  </p>


name: QuickHashIntSet.exists
purpose: This method checks whether a key is part of the set
manual_id: quickhashintset.exists
version: PECL quickhash >= Unknown
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> when the entry was found, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> when the entry is not
   found.
  </p>


name: QuickHashIntSet.saveToString
purpose: This method returns a serialized version of the set
manual_id: quickhashintset.savetostring
version: PECL quickhash >= Unknown
return_type: string
return_description:
<p class="para">
   This method returns a string containing a serialized format of the set.
   Each element is stored as a four byte value in the Endianness that the
   current system uses.
  </p>


name: QuickHashIntHash.get
purpose: This method retrieves a value from the hash by its key
manual_id: quickhashinthash.get
version: PECL quickhash >= Unknown
return_type: int
return_description:
<p class="para">
   The value if the key exists, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the key wasn&#039;t part of the hash.
  </p>


name: QuickHashIntHash.saveToString
purpose: This method returns a serialized version of the hash
manual_id: quickhashinthash.savetostring
version: PECL quickhash >= Unknown
return_type: string
return_description:
<p class="para">
   This method returns a string containing a serialized format of the hash.
   Each element is stored as a four byte value in the Endianness that the
   current system uses.
  </p>


name: QuickHashIntHash.set
manual_id: quickhashinthash.set
version: PECL quickhash >= Unknown
return_type: bool
purpose:
This method updates an entry in the hash with a new value, or  adds a new one if the entry doesn't exist

return_description:
<p class="para">
   2 if the entry was found and updated, 1 if the entry was newly added or 0
   if there was an error.
  </p>


name: QuickHashIntHash.update
purpose: This method updates an entry in the hash with a new value
manual_id: quickhashinthash.update
version: PECL quickhash >= Unknown
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> when the entry was found and updated, and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the entry was
   not part of the hash already.
  </p>


name: QuickHashStringIntHash.__construct
purpose: Creates a new QuickHashStringIntHash object
manual_id: quickhashstringinthash.construct
return_description:
<p class="para">
   Returns a new <span class="classname">QuickHashStringIntHash</span> object.
  </p>


name: QuickHashStringIntHash.saveToString
purpose: This method returns a serialized version of the hash
manual_id: quickhashstringinthash.savetostring
return_type: string
return_description:
<p class="para">
   This method returns a serialized format of an existing hash, in the same format
   that  <span class="methodname">QuickHashStringIntHash::loadFromString</span> can read.
  </p>


name: QuickHashIntStringHash.__construct
purpose: Creates a new QuickHashIntStringHash object
manual_id: quickhashintstringhash.construct
version: PECL quickhash >= Unknown
return_description:
<p class="para">
   Returns a new <span class="classname">QuickHashIntStringHash</span> object.
  </p>


name: Reflection.export
purpose: Exports
manual_id: reflection.export
version: PHP 5, PHP 7
return_type: string
return_description:
<p class="para">
   If the <code class="parameter">return</code> parameter
is set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, then the export is returned as a <span class="type">string</span>,
otherwise <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> is returned.
  </p>


name: ReflectionClass.__construct
purpose: Constructs a ReflectionClass
manual_id: reflectionclass.construct
version: PHP 5, PHP 7, PHP 8
errors:
<p class="para">
   Throws <span class="classname">ReflectionException</span> if the class to reflect does not exist.
  </p>


name: ReflectionClass.getAttributes
purpose: Gets Attributes
manual_id: reflectionclass.getattributes
version: PHP 8
return_type: ReflectionAttribute
return_description:
<p class="para">
   Array of attributes, as a <span class="classname">ReflectionAttribute</span> object.
  </p>


name: ReflectionClass.getConstant
purpose: Gets defined constant
manual_id: reflectionclass.getconstant
version: PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Value of the constant with the name <code class="parameter">name</code>.
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the constant was not found in the class.
  </p>


name: ReflectionClass.getConstants
purpose: Gets constants
manual_id: reflectionclass.getconstants
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span> of constants, where the keys hold the name
   and the values the value of the constants.
  </p>


name: ReflectionClass.getConstructor
purpose: Gets the constructor of the class
manual_id: reflectionclass.getconstructor
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   A <span class="classname">ReflectionMethod</span> object reflecting the class&#039; constructor, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the class
   has no constructor.
  </p>


name: ReflectionClass.getDefaultProperties
purpose: Gets default properties
manual_id: reflectionclass.getdefaultproperties
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span> of default properties, with the key being the name of
   the property and the value being the default value of the property or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
   if the property doesn&#039;t have a default value. The function does not distinguish
   between static and non static properties and does not take visibility modifiers
   into account.
  </p>


name: ReflectionClass.getDocComment
purpose: Gets doc comments
manual_id: reflectionclass.getdoccomment
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The doc comment if it exists, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ReflectionClass.getEndLine
purpose: Gets end line
manual_id: reflectionclass.getendline
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The ending line number of the user defined class, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if unknown.
  </p>


name: ReflectionClass.getExtension
purpose: Gets a ReflectionExtension object for the extension which defined the class
manual_id: reflectionclass.getextension
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   A <span class="classname">ReflectionExtension</span> object representing the extension which defined the class,
   or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> for user-defined classes.
  </p>


name: ReflectionClass.getExtensionName
purpose: Gets the name of the extension which defined the class
manual_id: reflectionclass.getextensionname
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The name of the extension which defined the class, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> for user-defined classes.
  </p>


name: ReflectionClass.getFileName
purpose: Gets the filename of the file in which the class has been defined
manual_id: reflectionclass.getfilename
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the filename of the file in which the class has been defined.
   If the class is defined in the PHP core or in a PHP extension, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   is returned.
  </p>


name: ReflectionClass.getInterfaces
purpose: Gets the interfaces
manual_id: reflectionclass.getinterfaces
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An associative <span class="type">array</span> of interfaces, with keys as interface
   names and the array values as <span class="classname">ReflectionClass</span> objects.
  </p>


name: ReflectionClass.getMethod
purpose: Gets a ReflectionMethod for a class method
manual_id: reflectionclass.getmethod
version: PHP 5, PHP 7, PHP 8
return_type: ReflectionMethod
return_description: <p class="para"> A <span class="classname">ReflectionMethod</span>. </p>
errors:
<p class="para">
   A <span class="classname">ReflectionException</span> if the method does not exist.
  </p>


name: ReflectionClass.getMethods
purpose: Gets an array of methods
manual_id: reflectionclass.getmethods
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span> of <span class="classname">ReflectionMethod</span> objects
   reflecting each method.
  </p>


name: ReflectionClass.getModifiers
purpose: Gets the class modifiers
manual_id: reflectionclass.getmodifiers
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns bitmask of <a href="class.reflectionclass.html#reflectionclass.constants.modifiers" class="link">
   modifier constants</a>.
  </p>


name: ReflectionClass.getParentClass
purpose: Gets parent class
manual_id: reflectionclass.getparentclass
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   A <span class="classname">ReflectionClass</span> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there&#039;s no parent.
  </p>


name: ReflectionClass.getReflectionConstant
purpose: Gets a ReflectionClassConstant for a class's constant
manual_id: reflectionclass.getreflectionconstant
version: PHP 7 >= 7.1.0, PHP 8
return_type: false
return_description:
<p class="para">
   A <span class="classname">ReflectionClassConstant</span>,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ReflectionClass.getReflectionConstants
purpose: Gets class constants
manual_id: reflectionclass.getreflectionconstants
version: PHP 7 >= 7.1.0, PHP 8
return_type: array
return_description:
<p class="para">
   An array of <span class="classname">ReflectionClassConstant</span> objects.
  </p>


name: ReflectionClass.getStartLine
purpose: Gets starting line number
manual_id: reflectionclass.getstartline
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The starting line number, as an <span class="type">int</span>, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if unknown.
  </p>


name: ReflectionClass.getTraitAliases
purpose: Returns an array of trait aliases
manual_id: reflectionclass.gettraitaliases
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array with new method names in keys and original names (in the
   format <code class="literal">&quot;TraitName::original&quot;</code>) in values.
  </p>


name: ReflectionClass.getTraits
purpose: Returns an array of traits used by this class
manual_id: reflectionclass.gettraits
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array with trait names in keys and instances of trait&#039;s
   <span class="classname">ReflectionClass</span> in values.
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> in case of an error.
  </p>


name: ReflectionClass.hasConstant
purpose: Checks if constant is defined
manual_id: reflectionclass.hasconstant
version: PHP 5 >= 5.1.2, 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 constant is defined, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ReflectionClass.hasMethod
purpose: Checks if method is defined
manual_id: reflectionclass.hasmethod
version: PHP 5 >= 5.1.2, 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 it has the method, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionClass.hasProperty
purpose: Checks if property is defined
manual_id: reflectionclass.hasproperty
version: PHP 5 >= 5.1.2, 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 it has the property, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionClass.implementsInterface
purpose: Implements interface
manual_id: reflectionclass.implementsinterface
version: PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
    <span class="methodname">ReflectionClass::implementsInterface</span> throws an
   <span class="classname">ReflectionException</span> if <code class="parameter">interface</code>
   is not an interface.
  </p>


name: ReflectionClass.isCloneable
purpose: Returns whether this class is cloneable
manual_id: reflectionclass.iscloneable
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 class is cloneable, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ReflectionClass.isEnum
purpose: Returns whether this is an enum
manual_id: reflectionclass.isenum
version: PHP 8 >= 8.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 this is an <a href="language.enumerations.html" class="link">enum</a>, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ReflectionClass.isReadOnly
purpose: Checks if class is readonly
manual_id: reflectionclass.isreadonly
version: PHP 8 >= 8.2.0
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a class is readonly, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ReflectionClass.isTrait
purpose: Returns whether this is a trait
manual_id: reflectionclass.istrait
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: ReflectionClass
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if this is a trait, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ReflectionClass.newInstance
purpose: Creates a new class instance from given arguments
manual_id: reflectionclass.newinstance
version: PHP 5, PHP 7, PHP 8
return_type: object
return_description: <p class="para"> </p>
errors:
<p class="para">
   A <span class="classname">ReflectionException</span> if the class constructor is not public.
  </p>
  <p class="para">
   A <span class="classname">ReflectionException</span> if the class does not have a constructor
   and the <code class="parameter">args</code> parameter contains one or more parameters.
  </p>


name: ReflectionClass.newInstanceArgs
purpose: Creates a new class instance from given arguments
manual_id: reflectionclass.newinstanceargs
version: PHP 5 >= 5.1.3, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns a new instance of the class, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   A <span class="classname">ReflectionException</span> if the class constructor is not public.
  </p>
  <p class="para">
   A <span class="classname">ReflectionException</span> if the class does not have a constructor
   and the <code class="parameter">args</code> parameter contains one or more parameters.
  </p>


name: ReflectionClass.newInstanceWithoutConstructor
purpose: Creates a new class instance without invoking the constructor
manual_id: reflectionclass.newinstancewithoutconstructor
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: object
return_description: <p class="para"> </p>
errors:
<p class="para">
   A <span class="classname">ReflectionException</span> if the class is an internal
   class that cannot be instantiated without invoking the constructor.
   This exception is limited only to internal classes that are
   <a href="language.oop5.final.html" class="link">final</a>.
  </p>


name: ReflectionClass.__toString
purpose: Returns the string representation of the ReflectionClass object
manual_id: reflectionclass.tostring
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A string representation of this <span class="classname">ReflectionClass</span> instance.
  </p>


name: ReflectionClassConstant.__construct
purpose: Constructs a ReflectionClassConstant
manual_id: reflectionclassconstant.construct
version: PHP 7 >= 7.1.0, PHP 8
errors:
<p class="para">
   Throws an <span class="classname">Exception</span> in case the given class constant does not exist.
  </p>


name: ReflectionClassConstant.getDocComment
purpose: Gets doc comments
manual_id: reflectionclassconstant.getdoccomment
version: PHP 7 >= 7.1.0, PHP 8
return_type: false
return_description:
<p class="para">
   The doc comment if it exists, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionClassConstant.getModifiers
purpose: Gets the class constant modifiers
manual_id: reflectionclassconstant.getmodifiers
version: PHP 7 >= 7.1.0, PHP 8
return_type: int
return_description:
<p class="para">
   A numeric representation of the modifiers.
   The actual meaning of these modifiers are described under
   <a href="class.reflectionclassconstant.html#reflectionclassconstant.constants.modifiers" class="link">predefined constants</a>.
  </p>


name: ReflectionClassConstant.isEnumCase
purpose: Checks if class constant is an Enum case
manual_id: reflectionclassconstant.isenumcase
version: PHP 8 >= 8.1.0
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the class constant is an Enum case; <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ReflectionClassConstant.isFinal
purpose: Checks if class constant is final
manual_id: reflectionclassconstant.isfinal
version: PHP 8 >= 8.1.0
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the class constant is final, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionClassConstant.isPrivate
purpose: Checks if class constant is private
manual_id: reflectionclassconstant.isprivate
version: PHP 7 >= 7.1.0, 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 class constant is private, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionClassConstant.isProtected
purpose: Checks if class constant is protected
manual_id: reflectionclassconstant.isprotected
version: PHP 7 >= 7.1.0, 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 class constant is protected, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionClassConstant.isPublic
purpose: Checks if class constant is public
manual_id: reflectionclassconstant.ispublic
version: PHP 7 >= 7.1.0, 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 class constant is public, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionClassConstant.__toString
purpose: Returns the string representation of the ReflectionClassConstant object
manual_id: reflectionclassconstant.tostring
version: PHP 7 >= 7.1.0, PHP 8
return_type: string
return_description:
<p class="para">
   A string representation of this <span class="classname">ReflectionClassConstant</span> instance.
  </p>


name: ReflectionEnum.getBackingType
purpose: Gets the backing type of an Enum, if any
manual_id: reflectionenum.getbackingtype
version: PHP 8 >= 8.1.0
return_type: null
return_description:
<p class="para">
   An instance of <span class="classname">ReflectionNamedType</span>, or <code class="literal">null</code>
   if the Enum has no backing type.
  </p>


name: ReflectionEnum.getCase
purpose: Returns a specific case of an Enum
manual_id: reflectionenum.getcase
version: PHP 8 >= 8.1.0
return_type: ReflectionEnumUnitCase
return_description:
<p class="para">
   An instance of <span class="classname">ReflectionEnumUnitCase</span>
   or <span class="classname">ReflectionEnumBackedCase</span>, as appropriate.
  </p>


name: ReflectionEnum.getCases
purpose: Returns a list of all cases on an Enum
manual_id: reflectionenum.getcases
version: PHP 8 >= 8.1.0
return_type: array
return_description:
<p class="para">
   An array of Enum reflection objects, one for each case in the Enum.  For a Unit Enum,
   they will all be instances of <span class="classname">ReflectionEnumUnitCase</span>. For a Backed
   Enum, they will all be instances of <span class="classname">ReflectionEnumBackedCase</span>.
  </p>


name: ReflectionEnum.hasCase
purpose: Checks for a case on an Enum
manual_id: reflectionenum.hascase
version: PHP 8 >= 8.1.0
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the case is defined, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not.
  </p>


name: ReflectionEnum.isBacked
purpose: Determines if an Enum is a Backed Enum
manual_id: reflectionenum.isbacked
version: PHP 8 >= 8.1.0
return_type: int
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the Enum has a backing scalar, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not.
  </p>


name: ReflectionEnumUnitCase.getEnum
purpose: Gets the reflection of the enum of this case
manual_id: reflectionenumunitcase.getenum
version: PHP 8 >= 8.1.0
return_type: ReflectionEnum
return_description:
<p class="para">
   A <span class="classname">ReflectionEnum</span> instance describing the Enum
   this case belongs to.
  </p>


name: ReflectionZendExtension.__construct
purpose: Constructs a ReflectionZendExtension object
manual_id: reflectionzendextension.construct
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: ReflectionZendExtension
errors:
<p class="para">
   Throws <span class="classname">ReflectionException</span> if the extension to reflect does not exist.
  </p>


name: ReflectionExtension.getClasses
purpose: Gets classes
manual_id: reflectionextension.getclasses
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An array of <span class="classname">ReflectionClass</span> objects, one
   for each class within the extension. If no classes are defined,
   an empty array is returned.
  </p>


name: ReflectionExtension.getClassNames
purpose: Gets class names
manual_id: reflectionextension.getclassnames
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span> of class names, as defined in the extension.
   If no classes are defined, an empty array is returned.
  </p>


name: ReflectionExtension.getDependencies
purpose: Gets dependencies
manual_id: reflectionextension.getdependencies
version: PHP 5 >= 5.1.3, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An associative <span class="type">array</span> with dependencies as keys and
   either <code class="literal">Required</code>, <code class="literal">Optional</code> 
   or <code class="literal">Conflicts</code> as the values.
  </p>


name: ReflectionExtension.getFunctions
purpose: Gets extension functions
manual_id: reflectionextension.getfunctions
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An associative array of <span class="classname">ReflectionFunction</span> objects, 
   for each function defined in the extension with the keys being the function
   names. If no function are defined, an empty array is returned.
  </p>


name: ReflectionExtension.getINIEntries
purpose: Gets extension ini entries
manual_id: reflectionextension.getinientries
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An associative <span class="type">array</span> with the ini entries as keys,
   with their defined values as values.
  </p>


name: ReflectionExtension.getVersion
purpose: Gets extension version
manual_id: reflectionextension.getversion
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The version of the extension, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the extension has no version.
  </p>


name: ReflectionExtension.isPersistent
purpose: Returns whether this extension is persistent
manual_id: reflectionextension.ispersistent
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> for extensions loaded by <a href="ini.core.html#ini.extension" class="link"><code class="literal">extension</code></a>, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   otherwise.
  </p>


name: ReflectionExtension.isTemporary
purpose: Returns whether this extension is temporary
manual_id: reflectionextension.istemporary
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> for extensions loaded by <span class="function">dl</span>,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ReflectionExtension.__toString
purpose: To string
manual_id: reflectionextension.tostring
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the exported extension as a string, in the same way as the 
    <span class="methodname">ReflectionExtension::export</span>.
  </p>


name: ReflectionFunction.__construct
purpose: Constructs a ReflectionFunction object
manual_id: reflectionfunction.construct
version: PHP 5, PHP 7, PHP 8
errors:
<p class="para">
   A <span class="classname">ReflectionException</span> if the <code class="parameter">function</code>
   parameter does not contain a valid function.
  </p>


name: ReflectionFunction.isAnonymous
purpose: Checks if a function is anonymous
manual_id: reflectionfunction.isanonymous
version: PHP 8 >= 8.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 function is anonymous, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ReflectionFunction.isDisabled
purpose: Checks if function is disabled
manual_id: reflectionfunction.isdisabled
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 it&#039;s disable, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionFunctionAbstract.getClosureScopeClass
purpose: Returns the scope class associated with the closure
manual_id: reflectionfunctionabstract.getclosurescopeclass
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the class, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the function is not a closure or if there was no enclosing class.
  </p>


name: ReflectionFunctionAbstract.getClosureThis
purpose: Returns this pointer bound to closure
manual_id: reflectionfunctionabstract.getclosurethis
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <var class="varname">$this</var> pointer.
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> in case of an error.
  </p>


name: ReflectionFunctionAbstract.getClosureUsedVariables
purpose: Returns an array of the used variables in the Closure
manual_id: reflectionfunctionabstract.getclosureusedvariables
version: PHP 8 >= 8.1.0
return_type: array
return_description:
<p class="para">
   Returns an <span class="type">array</span> of the used variables in the <span class="classname">Closure</span>.
  </p>


name: ReflectionFunctionAbstract.getEndLine
purpose: Gets end line number
manual_id: reflectionfunctionabstract.getendline
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The ending line number of the user defined function, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if unknown.
  </p>


name: ReflectionFunctionAbstract.getExtension
purpose: Gets extension info
manual_id: reflectionfunctionabstract.getextension
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The extension information, as a <span class="classname">ReflectionExtension</span> object,
   or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> for user-defined functions.
  </p>


name: ReflectionFunctionAbstract.getExtensionName
purpose: Gets extension name
manual_id: reflectionfunctionabstract.getextensionname
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The name of the extension which defined the function,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> for user-defined functions.
  </p>


name: ReflectionFunctionAbstract.getFileName
purpose: Gets file name
manual_id: reflectionfunctionabstract.getfilename
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the filename of the file in which the function has been defined.
   If the class is defined in the PHP core or in a PHP extension, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   is returned.
  </p>


name: ReflectionFunctionAbstract.getParameters
purpose: Gets parameters
manual_id: reflectionfunctionabstract.getparameters
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: ReflectionParameter
return_description:
<p class="para">
   The parameters, as a <span class="classname">ReflectionParameter</span> object.
  </p>


name: ReflectionFunctionAbstract.getReturnType
purpose: Gets the specified return type of a function
manual_id: reflectionfunctionabstract.getreturntype
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns a <span class="classname">ReflectionType</span> object if a return type is
   specified, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> otherwise.
  </p>


name: ReflectionFunctionAbstract.getStartLine
purpose: Gets starting line number
manual_id: reflectionfunctionabstract.getstartline
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The starting line number, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if unknown.
  </p>


name: ReflectionFunctionAbstract.getTentativeReturnType
purpose: Returns the tentative return type associated with the function
manual_id: reflectionfunctionabstract.gettentativereturntype
version: PHP 8 >= 8.1.0
return_type: null
return_description:
<p class="para">
   Returns a <span class="classname">ReflectionType</span> object if a tentative return type is
   specified, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> otherwise.
  </p>


name: ReflectionFunctionAbstract.hasReturnType
purpose: Checks if the function has a specified return type
manual_id: reflectionfunctionabstract.hasreturntype
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 function is a specified return type, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ReflectionFunctionAbstract.hasTentativeReturnType
purpose: Returns whether the function has a tentative return type
manual_id: reflectionfunctionabstract.hastentativereturntype
version: PHP 8 >= 8.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 the function has a tentative return type, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ReflectionFunctionAbstract.inNamespace
purpose: Checks if function in namespace
manual_id: reflectionfunctionabstract.innamespace
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 it&#039;s in a namespace, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionFunctionAbstract.isClosure
purpose: Checks if closure
manual_id: reflectionfunctionabstract.isclosure
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 function is a <span class="classname">Closure</span>, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ReflectionFunctionAbstract.isDeprecated
purpose: Checks if deprecated
manual_id: reflectionfunctionabstract.isdeprecated
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 it&#039;s deprecated, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionFunctionAbstract.isGenerator
purpose: Returns whether this function is a generator
manual_id: reflectionfunctionabstract.isgenerator
version: PHP 5 >= 5.5.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 function is generator, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it is not or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
   on failure.
  </p>


name: ReflectionFunctionAbstract.isInternal
purpose: Checks if is internal
manual_id: reflectionfunctionabstract.isinternal
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 it&#039;s internal, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionFunctionAbstract.isStatic
purpose: Checks if the function is static
manual_id: reflectiofunctionabstract.isstatic
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 function is static, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionFunctionAbstract.isUserDefined
purpose: Checks if user defined
manual_id: reflectionfunctionabstract.isuserdefined
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 it&#039;s user-defined, otherwise false;
  </p>


name: ReflectionFunctionAbstract.isVariadic
purpose: Checks if the function is variadic
manual_id: reflectionfunctionabstract.isvariadic
version: PHP 5 >= 5.6.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 function is variadic, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ReflectionFunctionAbstract.returnsReference
purpose: Checks if returns reference
manual_id: reflectionfunctionabstract.returnsreference
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 it returns a reference, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionMethod.__construct
purpose: Constructs a ReflectionMethod
manual_id: reflectionmethod.construct
version: PHP 5, PHP 7, PHP 8
errors:
<p class="para">
   A <span class="classname">ReflectionException</span> is thrown if the given method does not exist.
  </p>


name: ReflectionMethod.createFromMethodName
purpose: Creates a new ReflectionMethod
manual_id: reflectionmethod.createfrommethodname
version: PHP 8 >= 8.3.0
return_type: static
return_description:
<p class="para">
   Returns a new <span class="classname">ReflectionMethod</span> on success.
  </p>

errors:
<p class="para">
   A <span class="classname">ReflectionException</span> is thrown if the given method does not exist.
  </p>


name: ReflectionMethod.getClosure
purpose: Returns a dynamically created closure for the method
manual_id: reflectionmethod.getclosure
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: Closure
return_description: <p class="para"> Returns the newly created <span class="classname">Closure</span>. </p>
errors:
<p class="para">
   Throws a <span class="classname">ValueError</span> if <code class="parameter">object</code> is <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> but the method is non-static.
  </p>
  <p class="para">
   Throws a <span class="classname">ReflectionException</span> if <code class="parameter">object</code> is not an instance of the class this method was declared in.
  </p>


name: ReflectionMethod.getDeclaringClass
purpose: Gets declaring class for the reflected method
manual_id: reflectionmethod.getdeclaringclass
version: PHP 5, PHP 7, PHP 8
return_type: ReflectionClass
return_description:
<p class="para">
   A <span class="classname">ReflectionClass</span> object of the class that the
   reflected method is part of.
  </p>


name: ReflectionMethod.getModifiers
purpose: Gets the method modifiers
manual_id: reflectionmethod.getmodifiers
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   A numeric representation of the modifiers.
   The actual meaning of these modifiers are described under
   <a href="class.reflectionmethod.html#reflectionmethod.constants.modifiers" class="link">predefined constants</a>.
  </p>


name: ReflectionMethod.getPrototype
purpose: Gets the method prototype (if there is one)
manual_id: reflectionmethod.getprototype
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: ReflectionMethod
return_description:
<p class="para">
   A <span class="classname">ReflectionMethod</span> instance of the method prototype.
  </p>

errors:
<p class="para">
   A <span class="classname">ReflectionException</span> exception is thrown if
   the method does not have a prototype.
  </p>


name: ReflectionMethod.hasPrototype
purpose: Returns whether a method has a prototype
manual_id: reflectionmethod.hasprototype
version: PHP 8 >= 8.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 method has a prototype, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ReflectionMethod.invoke
purpose: Invoke
manual_id: reflectionmethod.invoke
version: PHP 5, PHP 7, PHP 8
return_type: mixed
return_description: <p class="para"> Returns the method result. </p>
errors:
<p class="para">
   A <span class="classname">ReflectionException</span> if the <code class="parameter">object</code>
   parameter does not contain an instance of the class that this method was declared in.
  </p>
  <p class="para">
   A <span class="classname">ReflectionException</span> if the method invocation failed.
  </p>


name: ReflectionMethod.isAbstract
purpose: Checks if method is abstract
manual_id: reflectionmethod.isabstract
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 method is abstract, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionMethod.isConstructor
purpose: Checks if method is a constructor
manual_id: reflectionmethod.isconstructor
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 method is a constructor, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionMethod.isDestructor
purpose: Checks if method is a destructor
manual_id: reflectionmethod.isdestructor
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 method is a destructor, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionMethod.isFinal
purpose: Checks if method is final
manual_id: reflectionmethod.isfinal
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 method is final, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionMethod.isPrivate
purpose: Checks if method is private
manual_id: reflectionmethod.isprivate
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 method is private, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionMethod.isProtected
purpose: Checks if method is protected
manual_id: reflectionmethod.isprotected
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 method is protected, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionMethod.isPublic
purpose: Checks if method is public
manual_id: reflectionmethod.ispublic
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 method is public, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionMethod.__toString
purpose: Returns the string representation of the Reflection method object
manual_id: reflectionmethod.tostring
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A string representation of this <span class="classname">ReflectionMethod</span> instance.
  </p>


name: ReflectionNamedType.isBuiltin
purpose: Checks if it is a built-in type
manual_id: reflectionnamedtype.isbuiltin
version: 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 it&#039;s a built-in type, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionParameter.allowsNull
purpose: Checks if null is allowed
manual_id: reflectionparameter.allowsnull
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 <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> is allowed, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionParameter.canBePassedByValue
purpose: Returns whether this parameter can be passed by value
manual_id: reflectionparameter.canbepassedbyvalue
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 parameter can be passed by value, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> in case of an error.
  </p>


name: ReflectionParameter.getClass
purpose: Get a ReflectionClass object for the parameter being reflected or null
manual_id: reflectionparameter.getclass
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   A <span class="classname">ReflectionClass</span> object, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if no type is declared,
   or the declared type is not a class or interface.
  </p>


name: ReflectionParameter.getDeclaringClass
purpose: Gets declaring class
manual_id: reflectionparameter.getdeclaringclass
version: PHP 5 >= 5.1.3, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   A <span class="classname">ReflectionClass</span> object or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if called on function.
  </p>


name: ReflectionParameter.getDefaultValueConstantName
purpose: Returns the default value's constant name if default value is constant or null
manual_id: reflectionparameter.getdefaultvalueconstantname
version: PHP 5 >= 5.4.6, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns string on success or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: ReflectionParameter.getType
purpose: Gets a parameter's type
manual_id: reflectionparameter.gettype
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns a <span class="classname">ReflectionType</span> object if a parameter type is
   specified, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> otherwise.
  </p>


name: ReflectionParameter.hasType
purpose: Checks if parameter has a type
manual_id: reflectionparameter.hastype
version: 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 type is specified, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ReflectionParameter.isArray
purpose: Checks if parameter expects an array
manual_id: reflectionparameter.isarray
version: PHP 5 >= 5.1.2, 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 an <span class="type">array</span> is expected, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ReflectionParameter.isCallable
purpose: Returns whether parameter MUST be callable
manual_id: reflectionparameter.iscallable
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 parameter is <span class="type">callable</span>, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it is
   not or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: ReflectionParameter.isDefaultValueAvailable
purpose: Checks if a default value is available
manual_id: reflectionparameter.isdefaultvalueavailable
version: PHP 5 >= 5.0.3, 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 default value is available, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionParameter.isDefaultValueConstant
purpose: Returns whether the default value of this parameter is a constant
manual_id: reflectionparameter.isdefaultvalueconstant
version: PHP 5 >= 5.4.6, 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 default value is constant, and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ReflectionParameter.isOptional
purpose: Checks if optional
manual_id: reflectionparameter.isoptional
version: PHP 5 >= 5.0.3, 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 parameter is optional, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionParameter.isPassedByReference
purpose: Checks if passed by reference
manual_id: reflectionparameter.ispassedbyreference
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 parameter is passed in by reference, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: ReflectionParameter.isVariadic
purpose: Checks if the parameter is variadic
manual_id: reflectionparameter.isvariadic
version: PHP 5 >= 5.6.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 parameter is variadic, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ReflectionProperty.__construct
purpose: Construct a ReflectionProperty object
manual_id: reflectionproperty.construct
version: PHP 5, PHP 7, PHP 8
errors:
<p class="para">
   Trying to get or set private or protected class property&#039;s values
   will result in an exception being thrown.
  </p>


name: ReflectionProperty.getDefaultValue
purpose: Returns the default value declared for a property
manual_id: reflectionproperty.getdefaultvalue
version: PHP 8
return_type: mixed
return_description:
<p class="para">
   The default value if the property has any default value (including <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>).
   If there is no default value, then <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> is returned. It is not possible to differentiate
   between a <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> default value and an unitialized typed property.
   Use  <span class="methodname">ReflectionProperty::hasDefaultValue</span> to detect the difference.
  </p>


name: ReflectionProperty.getModifiers
purpose: Gets the property modifiers
manual_id: reflectionproperty.getmodifiers
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   A numeric representation of the modifiers.
   The actual meaning of these modifiers are described under
   <a href="class.reflectionproperty.html#reflectionproperty.constants.modifiers" class="link">predefined constants</a>.
  </p>


name: ReflectionProperty.getType
purpose: Gets a property's type
manual_id: reflectionproperty.gettype
version: PHP 7 >= 7.4.0, PHP 8
return_type: null
return_description:
<p class="para">
   Returns a <span class="classname">ReflectionType</span> if the property has a type,
   and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> otherwise.
  </p>


name: ReflectionProperty.hasDefaultValue
purpose: Checks if property has a default value declared
manual_id: reflectionproperty.hasdefaultvalue
version: PHP 8
return_type: bool
return_description:
<p class="para">
   If the property has any default value (including <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>) <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> is returned;
   if the property is typed without a default value declared or is a dynamic property, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: ReflectionProperty.isDefault
purpose: Checks if property is a default property
manual_id: reflectionproperty.isdefault
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 property was declared at compile-time, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if
   it was created at run-time.
  </p>


name: ReflectionProperty.isInitialized
purpose: Checks whether a property is initialized
manual_id: reflectionproperty.isinitialized
version: PHP 7 >= 7.4.0, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> for typed properties prior to initialization,
   and for properties that have been explicitly <span class="function">unset</span>.
   For all other properties <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> will be returned.
  </p>

errors:
<p class="para">
   Throws a <span class="classname">ReflectionException</span> if the property is inaccessible.
   You can make a protected or private property accessible using
    <span class="methodname">ReflectionProperty::setAccessible</span>.
  </p>


name: ReflectionProperty.isPrivate
purpose: Checks if property is private
manual_id: reflectionproperty.isprivate
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 property is private, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ReflectionProperty.isPromoted
purpose: Checks if property is promoted
manual_id: reflectionproperty.ispromoted
version: 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 property is promoted, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ReflectionProperty.isProtected
purpose: Checks if property is protected
manual_id: reflectionproperty.isprotected
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 property is protected, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ReflectionProperty.isPublic
purpose: Checks if property is public
manual_id: reflectionproperty.ispublic
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 property is public, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ReflectionProperty.isReadOnly
purpose: Checks if property is readonly
manual_id: reflectionproperty.isreadonly
version: PHP 8 >= 8.1.0
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the property is readonly, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ReflectionProperty.isStatic
purpose: Checks if property is static
manual_id: reflectionproperty.isstatic
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 property is static, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ReflectionGenerator.getExecutingFile
purpose: Gets the file name of the currently executing generator
manual_id: reflectiongenerator.getexecutingfile
version: PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the full path and file name of the currently executing generator.
  </p>


name: ReflectionGenerator.getExecutingGenerator
purpose: Gets the executing Generator object
manual_id: reflectiongenerator.getexecutinggenerator
version: PHP 7, PHP 8
return_type: Generator
return_description:
<p class="para">
   Returns the currently executing <span class="classname">Generator</span> object.
  </p>


name: ReflectionGenerator.getExecutingLine
purpose: Gets the currently executing line of the generator
manual_id: reflectiongenerator.getexecutingline
version: PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the line number of the currently executing statement in the generator.
  </p>


name: ReflectionGenerator.getFunction
purpose: Gets the function name of the generator
manual_id: reflectiongenerator.getfunction
version: PHP 7, PHP 8
return_type: ReflectionFunctionAbstract
return_description:
<p class="para">
   Returns a <span class="classname">ReflectionFunctionAbstract</span> class. This will
   be <span class="classname">ReflectionFunction</span> for functions, or
   <span class="classname">ReflectionMethod</span> for methods.
  </p>


name: ReflectionGenerator.getThis
purpose: Gets the $this value of the generator
manual_id: reflectiongenerator.getthis
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the <code class="literal">$this</code> value, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the generator was
   not created in a class context.
  </p>


name: ReflectionReference.fromArrayElement
purpose: Create a ReflectionReference from an array element
manual_id: reflectionreference.fromarrayelement
version: PHP 7 >= 7.4.0, PHP 8
return_type: null
return_description:
<p class="para">
   Returns a <span class="classname">ReflectionReference </span> instance if
   <code class="literal">$array[$key]</code> is a reference, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> otherwise.
  </p>

errors:
<p class="para">
   If <code class="parameter">array</code> is not an <span class="type">array</span>, or <code class="parameter">key</code>
   is not an <span class="type">int</span> or <span class="type">string</span>, a <span class="classname">TypeError</span> is thrown. 
   If <code class="literal">$array[$key]</code> does not exist,
   a <span class="classname">ReflectionException</span> is thrown.
  </p>


name: ReflectionAttribute.isRepeated
purpose: Returns whether the attribute of this name has been repeated on a code element
manual_id: reflectionattribute.isrepeated
version: PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> when attribute is used repeatedly, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: boolval
purpose: Get the boolean value of a variable
manual_id: function.boolval
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   The <span class="type">bool</span> value of <code class="parameter">value</code>.
  </p>


name: empty
purpose: Determine whether a variable is empty
manual_id: function.empty
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 <code class="parameter">var</code> does not exist or has a value that is empty or equal to zero,
   aka falsey, see <a href="language.types.boolean.html#language.types.boolean.casting" class="link">conversion to boolean</a>.
   Otherwise returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: floatval
purpose: Get float value of a variable
manual_id: function.floatval
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: float
return_description:
<p class="para">
   The float value of the given variable. Empty arrays return 0, non-empty
   arrays return 1.
  </p>
  <p class="para">
   Strings will most likely return 0 although this depends on the 
   leftmost characters of the string. The common rules of 
   <a href="language.types.float.html#language.types.float.casting" class="link">float casting</a> 
   apply.
  </p>


name: get_debug_type
purpose: Gets the type name of a variable in a way that is suitable for debugging
manual_id: function.get-debug-type
version: PHP 8
return_type: string
return_description:
<p class="para">
     Possible values for the returned string are:

     <table class="doctable informaltable">
      
       <thead>
        <tr>
         <th>Type + State</th>
         <th>Return Value</th>
         <th>Notes</th>
        </tr>

       </thead>

       <tbody class="tbody">
        <tr>
         <td>null</td>
         <td>
          <code class="literal">&quot;null&quot;</code>
         </td>
         <td>-</td>
        </tr>

        <tr>
         <td>Booleans (true or false)</td>
         <td>
          <code class="literal">&quot;bool&quot;</code>
         </td>
         <td>-</td>
        </tr>

        <tr>
         <td>Integers</td>
         <td>
          <code class="literal">&quot;int&quot;</code>
         </td>
         <td>-</td>
        </tr>

        <tr>
         <td>Floats</td>
         <td>
          <code class="literal">&quot;float&quot;</code>
         </td>
         <td>-</td>
        </tr>

        <tr>
         <td>Strings</td>
         <td>
          <code class="literal">&quot;string&quot;</code>
         </td>
         <td>-</td>
        </tr>

        <tr>
         <td>Arrays</td>
         <td>
          <code class="literal">&quot;array&quot;</code>
         </td>
         <td>-</td>
        </tr>

        <tr>
         <td>Resources</td>
         <td>
          <code class="literal">&quot;resource (resourcename)&quot;</code>
         </td>
         <td>-</td>
        </tr>

        <tr>
         <td>Resources (Closed)</td>
         <td>
          <code class="literal">&quot;resource (closed)&quot;</code>
         </td>
         <td>Example: A file stream after being closed with fclose.</td>
        </tr>

        <tr>
         <td>Objects from Named Classes</td>
         <td>
          The full name of the class including its namespace e.g. <code class="literal">Foo\Bar</code>
         </td>
         <td>-</td>
        </tr>

        <tr>
         <td>Objects from Anonymous Classes</td>
         <td>
          <code class="literal">&quot;class@anonymous&quot;</code>
         </td>
         <td>
          Anonymous classes are those created through the $x = new class { ... } syntax
         </td>
        </tr>

       </tbody>
      
     </table>

  </p>


name: get_resource_id
purpose: Returns an integer identifier for the given resource
manual_id: function.get-resource-id
version: PHP 8
return_type: int
return_description:
<p class="para">
   The <span class="type">int</span> identifier for the given <code class="parameter">resource</code>.
  </p>
  <p class="para">
   This function is essentially an <span class="type">int</span> cast of
   <code class="parameter">resource</code> to make it easier to retrieve the resource ID.
  </p>


name: get_resource_type
purpose: Returns the resource type
manual_id: function.get-resource-type
version: PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   If the given <code class="parameter">resource</code> is a resource, this function
   will return a string representing its type. If the type is not identified
   by this function, the return value will be the string 
   <code class="literal">Unknown</code>.
  </p>
  <p class="para">
   This function will return <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> and generate an error if 
   <code class="parameter">resource</code> is not a <span class="type">resource</span>.
  </p>


name: gettype
purpose: Get the type of a variable
manual_id: function.gettype
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Possible values for the returned string are:
   <ul class="simplelist">
    <li>
      <code class="literal">&quot;boolean&quot;</code>
     </li>
    <li>
     <code class="literal">&quot;integer&quot;</code>
    </li>
    <li>
     <code class="literal">&quot;double&quot;</code> (for historical reasons <code class="literal">&quot;double&quot;</code> is
     returned in case of a <span class="type">float</span>, and not simply
     <code class="literal">&quot;float&quot;</code>)
    </li>
    <li>
     <code class="literal">&quot;string&quot;</code>
    </li>
    <li>
     <code class="literal">&quot;array&quot;</code>
    </li>
    <li>
     <code class="literal">&quot;object&quot;</code>
    </li>
    <li>
     <code class="literal">&quot;resource&quot;</code>
    </li>
    <li>
     <code class="literal">&quot;resource (closed)&quot;</code> as of PHP 7.2.0
    </li>
    <li>
     <code class="literal">&quot;NULL&quot;</code>
    </li>
    <li>
     <code class="literal">&quot;unknown type&quot;</code>
    </li>
   </ul>
  </p>


name: intval
purpose: Get the integer value of a variable
manual_id: function.intval
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The integer value of <code class="parameter">value</code> on success, or 0 on
   failure. Empty arrays return 0, non-empty arrays return 1.
  </p>
  <p class="para">
   The maximum value depends on the system. 32 bit systems have a 
   maximum signed integer range of -2147483648 to 2147483647. So for example 
   on such a system, <code class="literal">intval(&#039;1000000000000&#039;)</code> will return 
   2147483647. The maximum signed integer value for 64 bit systems is 
   9223372036854775807.
  </p>
  <p class="para">
   Strings will most likely return 0 although this depends on the 
   leftmost characters of the string. The common rules of 
   <a href="language.types.integer.html#language.types.integer.casting" class="link">integer casting</a> 
   apply.
  </p>


name: is_array
purpose: Finds whether a variable is an array
manual_id: function.is-array
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 <code class="parameter">value</code> is an <span class="type">array</span>,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: is_bool
purpose: Finds out whether a variable is a boolean
manual_id: function.is-bool
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 <code class="parameter">value</code> is a <span class="type">bool</span>,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: is_callable
purpose: Verify that a value can be called as a function from the current scope.
manual_id: function.is-callable
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: callable
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> is callable, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> 
   otherwise.
  </p>


name: is_countable
purpose: Verify that the contents of a variable is a countable value
manual_id: function.is-countable
version: PHP 7 >= 7.3.0, 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 <code class="parameter">value</code> is countable, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> 
   otherwise.
  </p>


name: is_float
purpose: Finds whether the type of a variable is float
manual_id: function.is-float
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 <code class="parameter">value</code> is a <span class="type">float</span>,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: is_int
purpose: Find whether the type of a variable is integer
manual_id: function.is-int
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 <code class="parameter">value</code> is an <span class="type">int</span>,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: is_iterable
purpose: Verify that the contents of a variable is an iterable value
manual_id: function.is-iterable
version: PHP 7 >= 7.1.0, 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 <code class="parameter">value</code> is iterable, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> 
   otherwise.
  </p>


name: is_null
purpose: Finds whether a variable is null
manual_id: function.is-null
version: PHP 4 >= 4.0.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 <code class="parameter">value</code> is <span class="type">null</span>, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   otherwise.
  </p>


name: is_numeric
purpose: Finds whether a variable is a number or a numeric string
manual_id: function.is-numeric
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 <code class="parameter">value</code> is a number or a
   <a href="language.types.numeric-strings.html" class="link">numeric string</a>,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: is_object
purpose: Finds whether a variable is an object
manual_id: function.is-object
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 <code class="parameter">value</code> is an <span class="type">object</span>,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: is_resource
purpose: Finds whether a variable is a resource
manual_id: function.is-resource
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: resource
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> is a <span class="type">resource</span>,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: is_scalar
purpose: Finds whether a variable is a scalar
manual_id: function.is-scalar
version: PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8
return_type: resource
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> is a scalar, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   otherwise.
  </p>


name: is_string
purpose: Find whether the type of a variable is string
manual_id: function.is-string
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 <code class="parameter">value</code> is of type <span class="type">string</span>,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: isset
purpose: Determine if a variable is declared and is different than null
manual_id: function.isset
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 <code class="parameter">var</code> exists and has
   any value other than <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>. <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: print_r
purpose: Prints human-readable information about a variable
manual_id: function.print-r
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   If given a <span class="type">string</span>, <span class="type">int</span> or <span class="type">float</span>,
   the value itself will be printed.  If given an <span class="type">array</span>, values
   will be presented in a format that shows keys and elements.  Similar
   notation is used for <span class="type">object</span>s.
  </p>
  <p class="para">
   When the <code class="parameter">return</code> parameter is <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, this function
   will return a <span class="type">string</span>. Otherwise, the return value is <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.
  </p>


name: serialize
purpose: Generates a storable representation of a value
manual_id: function.serialize
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns a string containing a byte-stream representation of 
   <code class="parameter">value</code> that can be stored anywhere.
  </p>
  <p class="para">
   Note that this is a binary string which may include null bytes, and needs
   to be stored and handled as such. For example,
   <span class="function">serialize</span> output should generally be stored in a BLOB
   field in a database, rather than a CHAR or TEXT field.
  </p>


name: strval
purpose: Get string value of a variable
manual_id: function.strval
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The <span class="type">string</span> value of <code class="parameter">value</code>.
  </p>


name: unserialize
purpose: Creates a PHP value from a stored representation
manual_id: function.unserialize
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   The converted value is returned, and can be a <span class="type">bool</span>,
   <span class="type">int</span>, <span class="type">float</span>, <span class="type">string</span>,
   <span class="type">array</span> or <span class="type">object</span>.
  </p>
  <p class="para">
   In case the passed string is not unserializeable, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned and
   <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is issued.
  </p>

errors:
<p class="para">
   Objects may throw <span class="classname">Throwable</span>s in their unserialization handlers.
  </p>


name: var_export
purpose: Outputs or returns a parsable string representation of a variable
manual_id: function.var-export
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the variable representation when the <code class="parameter">return</code> 
   parameter is used and evaluates to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>. Otherwise, this function will
   return <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>


name: oauth_urlencode
purpose: Encode a URI to RFC 3986
manual_id: function.oauth-urlencode
version: PECL OAuth >=0.99.2
return_type: string
return_description:
<p class="para">
   Returns an <a href="http://www.faqs.org/rfcs/rfc3986" class="link external">&raquo;&nbsp;RFC 3986</a> encoded string.
  </p>


name: OAuth.disableDebug
purpose: Turn off verbose debugging
manual_id: oauth.disabledebug
version: PECL OAuth >= 0.99.3
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
  </p>


name: OAuth.generateSignature
purpose: Generate a signature
manual_id: oauth.generatesignature
return_type: false
return_description:
<p class="para">
   A string containing the generated signature or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: OAuth.getAccessToken
purpose: Fetch an access token
manual_id: oauth.getaccesstoken
version: PECL OAuth >= 0.99.1
return_type: array
return_description:
<p class="para">
   Returns an array containing the parsed OAuth response on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: OAuth.getCAPath
purpose: Gets CA information
manual_id: oauth.getcapath
version: PECL OAuth >= 0.99.8
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span> of Certificate Authority information, specifically as
   <code class="literal">ca_path</code> and <code class="literal">ca_info</code> keys within the returned
   associative array.
  </p>


name: OAuth.getLastResponseHeaders
purpose: Get headers for last response
manual_id: oauth.getlastresponseheaders
return_type: false
return_description:
<p class="para">
   A string containing the last response&#039;s headers or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: OAuth.getLastResponseInfo
purpose: Get HTTP information about the last response
manual_id: oauth.getlastresponseinfo
version: PECL OAuth >= 0.99.1
return_type: array
return_description:
<p class="para">
   Returns an array containing the response information for the last
   request. Constants from <span class="function">curl_getinfo</span> may be
   used.
  </p>


name: OAuth.getRequestHeader
purpose: Generate OAuth header string signature
manual_id: oauth.getrequestheader
return_type: false
return_description:
<p class="para">
   A string containing the generated request header or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: OAuth.setAuthType
purpose: Set authorization type
manual_id: oauth.setauthtype
version: PECL OAuth >= 0.99.1
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a parameter is correctly set, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   (e.g., if an invalid <code class="parameter">auth_type</code> is passed in.)
  </p>


name: OAuth.setCAPath
purpose: Set CA path and info
manual_id: oauth.setcapath
version: PECL OAuth >= 0.99.8
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> if either <code class="parameter">ca_path</code>
   or <code class="parameter">ca_info</code> are considered invalid.
  </p>


name: OAuth.setNonce
purpose: Set the nonce for subsequent requests
manual_id: oauth.setnonce
version: PECL OAuth >= 0.99.1
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> if the
   <code class="parameter">nonce</code> is considered invalid.
  </p>


name: OAuth.setRequestEngine
purpose: The setRequestEngine purpose
manual_id: oauth.setrequestengine
version: PECL OAuth >= 1.0.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Emits an <span class="classname">OAuthException</span> exception if an invalid
   request engine is chosen.
  </p>


name: OAuth.setRSACertificate
purpose: Set the RSA certificate
manual_id: oauth.setrsacertificate
version: PECL OAuth >= 1.0.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 (e.g., the RSA certificate
   cannot be parsed.)
  </p>


name: OAuth.setTimestamp
purpose: Set the timestamp
manual_id: oauth.settimestamp
version: PECL OAuth >= 1.0.0
return_type: mixed
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, unless the <code class="parameter">timestamp</code> is invalid, in which
   case <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: OAuthProvider.callconsumerHandler
purpose: Calls the consumerNonceHandler callback
manual_id: oauthprovider.callconsumerhandler
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Emits an <strong><code><a href="errorfunc.constants.html#constant.e-error">E_ERROR</a></code></strong> level
error if the callback function cannot be called, or was not specified.
  </p>


name: OAuthProvider.checkOAuthRequest
purpose: Check an oauth request
manual_id: oauthprovider.checkoauthrequest
version: PECL OAuth >= 1.0.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Emits an <strong><code><a href="errorfunc.constants.html#constant.e-error">E_ERROR</a></code></strong> level error if
   the HTTP method cannot be detected.
  </p>


name: OAuthProvider.__construct
purpose: Constructs a new OAuthProvider object
manual_id: oauthprovider.construct
version: PECL OAuth >= 1.0.0
return_type: object
return_description:
<p class="para">
   An <span class="classname">OAuthProvider</span> <span class="type">object</span>.
  </p>


name: OAuthProvider.generateToken
purpose: Generate a random token
manual_id: oauthprovider.generatetoken
version: PECL OAuth >= 1.0.0
return_type: string
return_description: <p class="para"> The generated token, as a <span class="type">string</span> of bytes. </p>
errors:
<p class="para">
   If the <code class="parameter">strong</code> parameter is <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, then an
   <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error will be emitted when the
   fallback <span class="function">rand</span> implementation is used to fill
   the remaining random bytes (e.g., when not enough random data was found,
   initially).
  </p>


name: is_soap_fault
purpose: Checks if a SOAP call has failed
manual_id: function.is-soap-fault
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   This will return <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on error, and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SoapClient.__call
purpose: Calls a SOAP function (deprecated)
manual_id: soapclient.call
version: PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   SOAP functions may return one, or multiple values. If only one value is
   returned by the SOAP function, the return value will be a scalar.
   If multiple values are returned, an associative array of named output
   parameters is returned instead.
  </p>
  <p class="para">
   On error, if the <span class="classname">SoapClient</span> object was constructed
   with the <code class="literal">exceptions</code> option set to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>,
   a <span class="classname">SoapFault</span> object will be returned.
  </p>


name: SoapClient.__construct
purpose: SoapClient constructor
manual_id: soapclient.construct
version: PHP 5, PHP 7, PHP 8
errors:
<p class="para">
    <span class="methodname">SoapClient::__construct</span> will generate an
   <strong><code><a href="errorfunc.constants.html#constant.e-error">E_ERROR</a></code></strong> error if the <code class="literal">location</code> and
   <code class="literal">uri</code> options aren&#039;t provided in non-WSDL mode.
  </p>
  <p class="para">
   A <span class="classname">SoapFault</span> exception will be thrown if the
   <code class="parameter">wsdl</code> URI cannot be loaded.
  </p>


name: SoapClient.__getFunctions
purpose: Returns list of available SOAP functions
manual_id: soapclient.getfunctions
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The <span class="type">array</span> of SOAP function prototypes, detailing the return type,
   the function name and parameter types.
  </p>


name: SoapClient.__getTypes
purpose: Returns a list of SOAP types
manual_id: soapclient.gettypes
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The <span class="type">array</span> of SOAP types, detailing all structures and types.
  </p>


name: Yar_Client.setOpt
purpose: Set calling contexts
manual_id: yar-client.setopt
version: PECL yar >= 1.0.0
return_type: false
return_description:
<p class="para">
   Returns <var class="varname">$this</var> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: xmlrpc_decode
purpose: Decodes XML into native PHP types
manual_id: function.xmlrpc-decode
version: PHP 4 >= 4.1.0, PHP 5, PHP 7
return_type: mixed
return_description:
<p class="para">
   Returns either an array, or an integer, or a string, or a boolean according
   to the response returned by the XMLRPC method.
  </p>


name: xmlrpc_is_fault
purpose: Determines if an array value represents an XMLRPC fault
manual_id: function.xmlrpc-is-fault
version: PHP 4 >= 4.3.0, PHP 5, 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 argument means fault, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise. Fault
   description is available in <code class="literal">$arg[&quot;faultString&quot;]</code>, fault
   code is in <code class="literal">$arg[&quot;faultCode&quot;]</code>.
  </p>


name: xmlrpc_set_type
purpose: Sets xmlrpc type, base64 or datetime, for a PHP string value
manual_id: function.xmlrpc-set-type
version: PHP 4 >= 4.1.0, PHP 5, PHP 7
return_type: bool
errors: <p class="para"> Issues E_WARNING with type unsupported by XMLRPC. </p>
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 successful, <code class="parameter">value</code> is converted to an object.
  </p>


name: COMPersistHelper.GetCurFileName
purpose: Get current filename
manual_id: compersisthelper.getcurfilename
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description: <p class="para"> Returns the current name of the file associated with the object. </p>
errors:
<p class="para">
   A <span class="classname">com_exception</span> is thrown if the associated object does not
   implement the <acronym class="acronym">COM</acronym> interface <span class="interfacename">IPersistFile</span>,
   or when calling the  <span class="methodname">IPersistFile::GetCurFile</span> method failed.
  </p>


name: COMPersistHelper.GetMaxStreamSize
purpose: Get maximum stream size
manual_id: compersisthelper.getmaxstreamsize
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description: <p class="para"> Returns the size of the stream (in bytes) needed to save the object. </p>
errors:
<p class="para">
   A <span class="classname">com_exception</span> is thrown if the associated object does neither
   implement the <acronym class="acronym">COM</acronym> interface <span class="interfacename">IPersistStream</span>
   nor <span class="interfacename">IPersistStreamInit</span>, or when calling the
    <span class="methodname">IPersistStream::GetSizeMax</span> method failed.
  </p>


name: COMPersistHelper.InitNew
purpose: Initialize object to default state
manual_id: compersisthelper.initnew
version: PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   A <span class="classname">com_exception</span> is thrown if the associated object does not
   implement the <acronym class="acronym">COM</acronym> interface <span class="interfacename">IPersistStreamInit</span>,
   or when calling its  <span class="methodname">IPersistStreamInit::Init</span> method failed.
  </p>


name: COMPersistHelper.LoadFromFile
purpose: Load object from file
manual_id: compersisthelper.loadfromfile
version: PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   A <span class="classname">com_exception</span> is thrown if the associated object does not
   implement the <acronym class="acronym">COM</acronym> interface <span class="interfacename">IPersistFile</span>,
   or when calling the  <span class="methodname">IPersistFile::Load</span> method failed.
  </p>


name: COMPersistHelper.LoadFromStream
purpose: Load object from stream
manual_id: compersisthelper.loadfromstream
version: PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   A <span class="classname">com_exception</span> is thrown if the associated object does not
   implement the <acronym class="acronym">COM</acronym> interface <span class="interfacename">IPersistStream</span>,
   or when calling the  <span class="methodname">IPersistStream::Load</span> method failed.
  </p>


name: COMPersistHelper.SaveToFile
purpose: Save object to file
manual_id: compersisthelper.savetofile
version: PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   A <span class="classname">com_exception</span> is thrown if the associated object does not
   implement the <acronym class="acronym">COM</acronym> interface <span class="interfacename">IPersistFile</span>,
   or when calling the  <span class="methodname">IPersistFile::Save</span> method failed.
  </p>


name: COMPersistHelper.SaveToStream
purpose: Save object to stream
manual_id: compersisthelper.savetostream
version: PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   A <span class="classname">com_exception</span> is thrown if the associated object does neither
   implement the <acronym class="acronym">COM</acronym> interface <span class="interfacename">IPersistStream</span>
   nor <span class="interfacename">IPersistStreamInit</span>, or when calling the
    <span class="methodname">IPersistStream::Save</span> method failed.
  </p>


name: com_create_guid
purpose: Generate a globally unique identifier (GUID)
manual_id: function.com-create-guid
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the GUID as a string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: com_get_active_object
purpose: Returns a handle to an already running instance of a COM object
manual_id: function.com-get-active-object
version: PHP 5, PHP 7, PHP 8
return_type: variant
return_description:
<p class="para">
   If the requested object is running, it will be returned to your script
   just like any other COM object.
  </p>

errors:
<p class="para">
   There are a variety of reasons why this function might fail, the most
   common being that the object is not already running.  In that situation,
   the exception error code will be <strong><code><a href="com.constants.html#constant.mk-e-unavailable">MK_E_UNAVAILABLE</a></code></strong>;
   you can use the <code class="literal">getCode</code> method of the exception object
   to check the exception code.
  </p>


name: com_message_pump
purpose: Process COM messages, sleeping for up to timeoutms milliseconds
manual_id: function.com-message-pump
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   If a message or messages arrives before the timeout, they will be
   dispatched, and the function will return <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>. If the timeout occurs and
   no messages were processed, the return value will be <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: variant_and
purpose: Performs a bitwise AND operation between two variants
manual_id: function.variant-and
version: PHP 5, PHP 7, PHP 8
return_type: variant
errors: <p class="para"> Throws a <span class="classname">com_exception</span> on failure. </p>
return_description:
<p class="para">
   <table class="doctable table">
    <caption><strong>Variant AND Rules</strong></caption>
    
     <thead>
      <tr>
       <th>If <code class="parameter">left</code> is</th>
       <th>If <code class="parameter">right</code> is</th>
       <th>then the result is</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td></tr>

     </tbody>
    
   </table>

  </p>


name: variant_cmp
purpose: Compares two variants
manual_id: function.variant-cmp
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns one of the following:
   <table class="doctable table">
    <caption><strong>Variant Comparision Results</strong></caption>
    
     <thead>
      <tr>
       <th>value</th>
       <th>meaning</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><strong><code><a href="com.constants.html#constant.varcmp-lt">VARCMP_LT</a></code></strong></td>
       <td><code class="parameter">left</code> is less than
        <code class="parameter">right</code>
       </td>
      </tr>

      <tr>
       <td><strong><code><a href="com.constants.html#constant.varcmp-eq">VARCMP_EQ</a></code></strong></td>
       <td><code class="parameter">left</code> is equal to
        <code class="parameter">right</code>
       </td>
      </tr>

      <tr>
       <td><strong><code><a href="com.constants.html#constant.varcmp-gt">VARCMP_GT</a></code></strong></td>
       <td><code class="parameter">left</code> is greater than
        <code class="parameter">right</code>
       </td>
      </tr>

      <tr>
       <td><strong><code><a href="com.constants.html#constant.varcmp-null">VARCMP_NULL</a></code></strong></td>
       <td>Either <code class="parameter">left</code>,
        <code class="parameter">right</code> or both are <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: variant_date_from_timestamp
purpose: Returns a variant date representation of a Unix timestamp
manual_id: function.variant-date-from-timestamp
version: PHP 5, PHP 7, PHP 8
return_type: variant
return_description:
<p class="para">
   Returns a <strong><code><a href="com.constants.html#constant.vt-date">VT_DATE</a></code></strong> variant.
  </p>


name: variant_date_to_timestamp
purpose: Converts a variant date/time value to Unix timestamp
manual_id: function.variant-date-to-timestamp
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns a unix timestamp, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: variant_div
purpose: Returns the result from dividing two variants
manual_id: function.variant-div
version: PHP 5, PHP 7, PHP 8
return_type: variant
errors: <p class="para"> Throws a <span class="classname">com_exception</span> on failure. </p>
return_description:
<p class="para">
   <table class="doctable table">
    <caption><strong>Variant Division Rules</strong></caption>
    
     <thead>
      <tr>
       <th>If</th>
       <th>Then</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>Both expressions are of the string, date, character, boolean type</td>
       <td>Double is returned</td>
      </tr>

      <tr>
       <td>One expression is a string type and the other a
       character</td>
       <td>Division and a double is returned</td>
      </tr>

      <tr>
       <td>One expression is numeric and the other is a string</td>
       <td>Division and a double is returned.</td>
      </tr>

      <tr>
       <td>Both expressions are numeric</td>
       <td>Division and a double is returned</td>
      </tr>

      <tr>
       <td>Either expression is NULL</td>
       <td>NULL is returned</td>
      </tr>

      <tr>
       <td><code class="parameter">right</code> is empty and
       <code class="parameter">left</code> is anything but empty</td>
       <td>A <span class="classname">com_exception</span> with code <strong><code><a href="com.constants.html#constant.disp-e-divbyzero">DISP_E_DIVBYZERO</a></code></strong>
       is thrown</td>
      </tr>

      <tr>
       <td><code class="parameter">left</code> is empty and
       <code class="parameter">right</code> is anything but empty.</td>
       <td>0 as type double is returned</td>
      </tr>

      <tr>
       <td>Both expressions are empty</td>
       <td>A <span class="classname">com_exception</span> with code <strong><code><a href="com.constants.html#constant.disp-e-overflow">DISP_E_OVERFLOW</a></code></strong>
       is thrown</td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: variant_eqv
purpose: Performs a bitwise equivalence on two variants
manual_id: function.variant-eqv
version: PHP 5, PHP 7, PHP 8
return_type: variant
errors: <p class="para"> Throws a <span class="classname">com_exception</span> on failure. </p>
return_description:
<p class="para">
   If each bit in <code class="parameter">left</code> is equal to the corresponding
   bit in <code class="parameter">right</code> then <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> is returned, otherwise
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: variant_fix
purpose: Returns the integer portion of a variant
manual_id: function.variant-fix
version: PHP 5, PHP 7, PHP 8
return_type: variant
errors: <p class="para"> Throws a <span class="classname">com_exception</span> on failure. </p>
return_description:
<p class="para">
   If <code class="parameter">value</code> is negative, then the first negative
   integer greater than or equal to the variant is returned, otherwise
   returns the integer portion of the value of
   <code class="parameter">value</code>.
  </p>


name: variant_get_type
purpose: Returns the type of a variant object
manual_id: function.variant-get-type
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   This function returns an integer value that indicates the type of
   <code class="parameter">variant</code>, which can be an instance of
   <a href="class.com.html" class="xref">com</a>, <a href="class.dotnet.html" class="xref">dotnet</a> or
   <a href="class.variant.html" class="xref">variant</a> classes.  The return value can be compared
   to one of the <strong><code>VT_XXX</code></strong> constants.
  </p>
  <p class="para">
   The return value for COM and DOTNET objects will usually be
   <strong><code><a href="com.constants.html#constant.vt-dispatch">VT_DISPATCH</a></code></strong>; the only reason this function works for
   those classes is because COM and DOTNET are descendants of VARIANT.
  </p>


name: variant_idiv
purpose: Converts variants to integers and then returns the result from dividing them
manual_id: function.variant-idiv
version: PHP 5, PHP 7, PHP 8
return_type: variant
errors: <p class="para"> Throws a <span class="classname">com_exception</span> on failure. </p>
return_description:
<p class="para">
   <table class="doctable table">
    <caption><strong>Variant Integer Division Rules</strong></caption>
    
     <thead>
      <tr>
       <th>If</th>
       <th>Then</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>Both expressions are of the string, date, character, boolean type</td>
       <td>Division and integer is returned</td>
      </tr>

      <tr>
       <td>One expression is a string type and the other a
       character</td>
       <td>Division</td>
      </tr>

      <tr>
       <td>One expression is numeric and the other is a string</td>
       <td>Division</td>
      </tr>

      <tr>
       <td>Both expressions are numeric</td>
       <td>Division</td>
      </tr>

      <tr>
       <td>Either expression is NULL</td>
       <td>NULL is returned</td>
      </tr>

      <tr>
       <td>Both expressions are empty</td>
       <td>A <span class="classname">com_exception</span> with code <strong><code><a href="com.constants.html#constant.disp-e-divbyzero">DISP_E_DIVBYZERO</a></code></strong>
       is thrown</td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: variant_imp
purpose: Performs a bitwise implication on two variants
manual_id: function.variant-imp
version: PHP 5, PHP 7, PHP 8
return_type: variant
errors: <p class="para"> Throws a <span class="classname">com_exception</span> on failure. </p>
return_description:
<p class="para">
   <table class="doctable table">
    <caption><strong>Variant Implication Table</strong></caption>
    
    <thead>
     <tr>
      <th>If <code class="parameter">left</code> is</th>
      <th>If <code class="parameter">right</code> is</th>
      <th>then the result is</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td></tr>

     <tr><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td></tr>

     <tr><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td></tr>

     <tr><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td></tr>

     <tr><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td></tr>

     <tr><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td></tr>

     <tr><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td></tr>

     <tr><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td></tr>

     <tr><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td></tr>

    </tbody>
   
  </table>

  </p>


name: variant_mul
purpose: Multiplies the values of the two variants
manual_id: function.variant-mul
version: PHP 5, PHP 7, PHP 8
return_type: variant
errors: <p class="para"> Throws a <span class="classname">com_exception</span> on failure. </p>
return_description:
<p class="para">
   <table class="doctable table">
    <caption><strong>Variant Multiplication Rules</strong></caption>
    
     <thead>
      <tr>
       <th>If</th>
       <th>Then</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>Both expressions are of the string, date, character, boolean type</td>
       <td>Multiplication</td>
      </tr>

      <tr>
       <td>One expression is a string type and the other a
       character</td>
       <td>Multiplication</td>
      </tr>

      <tr>
       <td>One expression is numeric and the other is a string</td>
       <td>Multiplication</td>
      </tr>

      <tr>
       <td>Both expressions are numeric</td>
       <td>Multiplication</td>
      </tr>

      <tr>
       <td>Either expression is NULL</td>
       <td>NULL is returned</td>
      </tr>

      <tr>
       <td>Both expressions are empty</td>
       <td>Empty string is returned</td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: variant_not
purpose: Performs bitwise not negation on a variant
manual_id: function.variant-not
version: PHP 5, PHP 7, PHP 8
return_type: variant
errors: <p class="para"> Throws a <span class="classname">com_exception</span> on failure. </p>
return_description:
<p class="para">
   Returns the bitwise not negation. If <code class="parameter">value</code> is
   <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, the result will also be <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>


name: variant_or
purpose: Performs a logical disjunction on two variants
manual_id: function.variant-or
version: PHP 5, PHP 7, PHP 8
return_type: variant
errors: <p class="para"> Throws a <span class="classname">com_exception</span> on failure. </p>
return_description:
<p class="para">
   <table class="doctable table">
    <caption><strong>Variant OR Rules</strong></caption>
    
     <thead>
      <tr>
       <th>If <code class="parameter">left</code> is</th>
       <th>If <code class="parameter">right</code> is</th>
       <th>then the result is</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td></tr>

     </tbody>
    
   </table>

  </p>


name: variant_pow
purpose: Returns the result of performing the power function with two variants
manual_id: function.variant-pow
version: PHP 5, PHP 7, PHP 8
return_type: variant
errors: <p class="para"> Throws a <span class="classname">com_exception</span> on failure. </p>
return_description:
<p class="para">
   Returns the result of <code class="parameter">left</code> to the power of
   <code class="parameter">right</code>.
  </p>


name: variant_round
purpose: Rounds a variant to the specified number of decimal places
manual_id: function.variant-round
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the rounded value, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: variant_sub
purpose: Subtracts the value of the right variant from the left variant value
manual_id: function.variant-sub
version: PHP 5, PHP 7, PHP 8
return_type: variant
errors: <p class="para"> Throws a <span class="classname">com_exception</span> on failure. </p>
return_description:
<p class="para">
   <table class="doctable table">
    <caption><strong>Variant Subtraction Rules</strong></caption>
    
     <thead>
      <tr>
       <th>If</th>
       <th>Then</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>Both expressions are of the string type</td>
       <td>Subtraction</td>
      </tr>

      <tr>
       <td>One expression is a string type and the other a
       character</td>
       <td>Subtraction</td>
      </tr>

      <tr>
       <td>One expression is numeric and the other is a string</td>
       <td>Subtraction.</td>
      </tr>

      <tr>
       <td>Both expressions are numeric</td>
       <td>Subtraction</td>
      </tr>

      <tr>
       <td>Either expression is NULL</td>
       <td>NULL is returned</td>
      </tr>

      <tr>
       <td>Both expressions are empty</td>
       <td>Empty string is returned</td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: variant_xor
purpose: Performs a logical exclusion on two variants
manual_id: function.variant-xor
version: PHP 5, PHP 7, PHP 8
return_type: variant
errors: <p class="para"> Throws a <span class="classname">com_exception</span> on failure. </p>
return_description:
<p class="para">
   <table class="doctable table">
    <caption><strong>Variant XOR Rules</strong></caption>
    
     <thead>
      <tr>
       <th>If <code class="parameter">left</code> is</th>
       <th>If <code class="parameter">right</code> is</th>
       <th>then the result is</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td></tr>

      <tr><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td><td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td></tr>

     </tbody>
    
   </table>

  </p>


name: win32_continue_service
purpose: Resumes a paused service
manual_id: function.win32-continue-service
version: PECL win32service >=0.1.0
return_type: void
return_description:
<p class="para">
   No value is returned.
  </p>
  <p class="para">
    Prior to version 1.0.0, returned <strong><code><a href="win32service.constants.html#constant.win32-no-error">WIN32_NO_ERROR</a></code></strong> on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there is a problem with the parameters or a <a href="win32service.constants.html#win32service.constants.errors" class="link">Win32 Error Code</a> on failure.
  </p>

errors:
<p class="para">
   A <span class="classname">ValueError</span> is thrown if the
   value of <code class="parameter">servicename</code> parameter is empty.
  </p>
   <p class="para">
    A <span class="classname">Win32ServiceException</span> is thrown on error.
   </p>


name: win32_create_service
purpose: Creates a new service entry in the SCM database
manual_id: function.win32-create-service
version: PECL win32service >=0.1.0
return_type: void
return_description:
<p class="para">
   No value is returned.
  </p>
  <p class="para">
   Prior to version 1.0.0, returned <strong><code><a href="win32service.constants.html#constant.win32-no-error">WIN32_NO_ERROR</a></code></strong> on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there is a problem with the parameters or a <a href="win32service.constants.html#win32service.constants.errors" class="link">Win32 Error Code</a> on failure.
  </p>

errors:
<p class="para">
   A <span class="classname">ValueError</span> is thrown if the
   value of <code class="parameter">service</code> parameter is empty.
  </p>
  <p class="para">
   A <span class="classname">ValueError</span> is thrown if the
   value of <code class="parameter">path</code> parameter is missing or empty.
  </p>
  <p class="para">
   A <span class="classname">ValueError</span> is thrown if the
   value of <code class="parameter">svc_type</code> parameter is wrong.
  </p>
  <p class="para">
   A <span class="classname">ValueError</span> is thrown if the
   value of <code class="parameter">start_type</code> parameter is wrong.
  </p>
  <p class="para">
   A <span class="classname">ValueError</span> is thrown if the
   value of <code class="parameter">error_control</code> parameter is wrong.
  </p>
  <p class="para">
   A <span class="classname">ValueError</span> is thrown if the
   value of <code class="parameter">base_priority</code> parameter  is wrong.
  </p>
  <p class="para">
   A <span class="classname">ValueError</span> is thrown if the
   value of <code class="parameter">recovery_delay</code> parameter is not between 
   0 and PHP_INT_MAX.
  </p>
  <p class="para">
   A <span class="classname">ValueError</span> is thrown if the
   value of <code class="parameter">recovery_action_1</code> parameter is wrong.
  </p>
  <p class="para">
   A <span class="classname">ValueError</span> is thrown if the
   value of <code class="parameter">recovery_action_2</code> parameter is wrong.
  </p>
  <p class="para">
   A <span class="classname">ValueError</span> is thrown if the
   value of <code class="parameter">recovery_action_3</code> parameter is wrong.
  </p>
  <p class="para">
   A <span class="classname">ValueError</span> is thrown if the
   value of <code class="parameter">recovery_reset_period</code> parameter is not 
   between 0 and PHP_INT_MAX.
  </p>
  <p class="para">
   A <span class="classname">Win32ServiceException</span> is thrown on error.
  </p>


name: win32_delete_service
purpose: Deletes a service entry from the SCM database
manual_id: function.win32-delete-service
version: PECL win32service >=0.1.0
return_type: void
return_description:
<p class="para">
   No value is returned.
  </p>
  <p class="para">
    Prior to version 1.0.0, returned <strong><code><a href="win32service.constants.html#constant.win32-no-error">WIN32_NO_ERROR</a></code></strong> on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there is a problem with the parameters or a <a href="win32service.constants.html#win32service.constants.errors" class="link">Win32 Error Code</a> on failure.
  </p>

errors:
<p class="para">
    A <span class="classname">ValueError</span> is thrown if the
    value of <code class="parameter">servicename</code> parameter is empty.
  </p>

   <p class="para">
    A <span class="classname">Win32ServiceException</span> is thrown on error.
   </p>


name: win32_get_last_control_message
purpose: Returns the last control message that was sent to this service
manual_id: function.win32-get-last-control-message
version: PECL win32service >=0.1.0
return_type: int
return_description:
<p class="para">
   Returns a control constant which will be one of the
   <a href="win32service.constants.html#win32service.constants.servicecontrol" class="link">Win32Service Service Control Message Constants</a>:
   <strong><code><a href="win32service.constants.html#constant.win32-service-control-continue">WIN32_SERVICE_CONTROL_CONTINUE</a></code></strong>,
   <strong><code><a href="win32service.constants.html#constant.win32-service-control-deviceevent">WIN32_SERVICE_CONTROL_DEVICEEVENT</a></code></strong>,
   <strong><code><a href="win32service.constants.html#constant.win32-service-control-hardwareprofilechange">WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE</a></code></strong>,
   <strong><code><a href="win32service.constants.html#constant.win32-service-control-interrogate">WIN32_SERVICE_CONTROL_INTERROGATE</a></code></strong>,
   <strong><code><a href="win32service.constants.html#constant.win32-service-control-netbindadd">WIN32_SERVICE_CONTROL_NETBINDADD</a></code></strong>,
   <strong><code><a href="win32service.constants.html#constant.win32-service-control-netbinddisable">WIN32_SERVICE_CONTROL_NETBINDDISABLE</a></code></strong>,
   <strong><code><a href="win32service.constants.html#constant.win32-service-control-netbindenable">WIN32_SERVICE_CONTROL_NETBINDENABLE</a></code></strong>,
   <strong><code><a href="win32service.constants.html#constant.win32-service-control-netbindremove">WIN32_SERVICE_CONTROL_NETBINDREMOVE</a></code></strong>,
   <strong><code><a href="win32service.constants.html#constant.win32-service-control-paramchange">WIN32_SERVICE_CONTROL_PARAMCHANGE</a></code></strong>,
   <strong><code><a href="win32service.constants.html#constant.win32-service-control-pause">WIN32_SERVICE_CONTROL_PAUSE</a></code></strong>,
   <strong><code><a href="win32service.constants.html#constant.win32-service-control-powerevent">WIN32_SERVICE_CONTROL_POWEREVENT</a></code></strong>,
   <strong><code><a href="win32service.constants.html#constant.win32-service-control-preshutdown">WIN32_SERVICE_CONTROL_PRESHUTDOWN</a></code></strong>,
   <strong><code><a href="win32service.constants.html#constant.win32-service-control-sessionchange">WIN32_SERVICE_CONTROL_SESSIONCHANGE</a></code></strong>,
   <strong><code><a href="win32service.constants.html#constant.win32-service-control-shutdown">WIN32_SERVICE_CONTROL_SHUTDOWN</a></code></strong>,
   <strong><code><a href="win32service.constants.html#constant.win32-service-control-stop">WIN32_SERVICE_CONTROL_STOP</a></code></strong>.
  </p>
  <p class="para">
   If the value is between 128 and 255, the control code is custom.
  </p>

errors:
<p class="para">
   Prior to version 1.0.0, if the SAPI is not <code class="literal">&quot;cli&quot;</code>, this function emits an 
<strong><code><a href="errorfunc.constants.html#constant.e-error">E_ERROR</a></code></strong> level error.
  </p>
   <p class="para">
    As of version 1.0.0, will throw a 
    <span class="classname">Win32ServiceException</span> if SAPI is not 
    <code class="literal">&quot;cli&quot;</code>
   </p>


name: win32_query_service_status
purpose: Queries the status of a service
manual_id: function.win32-query-service-status
version: PECL win32service >=0.1.0
return_type: array
return_description:
<p class="para">
   Returns an array consisting of the following information on success
  </p>
  <p class="para">
    Prior version 1.0.0, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there is a problem with the parameters or a <a href="win32service.constants.html#win32service.constants.errors" class="link">Win32 Error Code</a> on failure.
  </p>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">ServiceType</code></dt>
     <dd>
      <p class="para">
       The dwServiceType. See <a href="win32service.constants.html#win32service.constants.servicetype" class="link">Win32Service Service Type Bitmasks</a>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">CurrentState</code></dt>
     <dd>
      <p class="para">
       The dwCurrentState. See <a href="win32service.constants.html#win32service.constants.servicestatus" class="link">Win32Service Service Status Constants</a>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">ControlsAccepted</code></dt>
     <dd>
      <p class="para">
       Which service controls are accepted by the service. See <a href="win32service.constants.html#win32service.constants.controlsaccepted" class="link">Win32Service Service Control Message Accepted Bitmasks</a>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">Win32ExitCode</code></dt>
     <dd>
      <p class="para">
       If the service exited, the return code from the process. This value is equal to 
       <strong><code><a href="win32service.constants.html#constant.win32-error-service-specific-error">WIN32_ERROR_SERVICE_SPECIFIC_ERROR</a></code></strong> 
       if the exit mode is not gracefuly. See 
       <a href="win32service.constants.html#win32service.constants.errors" class="link">Win32Service error codes</a> and 
       <span class="function">win32_set_service_exit_mode</span>
      </p>
     </dd>
    
    
     <dt><code class="parameter">ServiceSpecificExitCode</code></dt>
     <dd>
      <p class="para">
       If the service exited with an error condition, the service specific
       code that is logged in the event log is visible here. This value is equal 
       to the value defined by <span class="function">win32_set_service_exit_code</span>
      </p>
     </dd>
    
    
     <dt><code class="parameter">CheckPoint</code></dt>
     <dd>
      <p class="para">
       If the service is shutting down, holds the current check point number.
       This is used by the SCM as a kind of heart-beat to detect a wedged service
       process.  The value of the check point is best interpreted in
       conjunction with the WaitHint value.
      </p>
     </dd>
    
    
     <dt><code class="parameter">WaitHint</code></dt>
     <dd>
      <p class="para">
       If the service is shutting down it will set WaitHint to a checkpoint
       value that will indicate 100% completion.  This can be used to
       implement a progress indicator.
      </p>
     </dd>
    
    
     <dt><code class="parameter">ProcessId</code></dt>
     <dd>
      <p class="para">
       The Windows process identifier. If 0, the process is not running.
      </p>
     </dd>
    
    
     <dt><code class="parameter">ServiceFlags</code></dt>
     <dd>
      <p class="para">
       The dwServiceFlags. See <a href="win32service.constants.html#win32service.constants.serviceflag" class="link">Win32Service Service Flag Constants</a>.
      </p>
     </dd>
    
   </dl>
  </p>

errors:
<p class="para">
    A <span class="classname">ValueError</span> is thrown if the
    value of <code class="parameter">servicename</code> parameter is empty.
  </p>


name: win32_send_custom_control
purpose: Send a custom control to the service
manual_id: function.win32-send-custom-control
version: PECL win32service >=0.4.0
return_type: void
errors:
<p class="para">
   Prior to version 1.0.0, if the control value is not between 128 and 255, this function emits an
   <strong><code><a href="errorfunc.constants.html#constant.e-error">E_ERROR</a></code></strong> level error.
  </p>
  <p class="para">
    A <span class="classname">ValueError</span> is thrown if the
    value of <code class="parameter">servicename</code> parameter is empty.
  </p>
  <p class="para">
    A <span class="classname">ValueError</span> is thrown if the
    value of <code class="parameter">control</code> parameter is not between 128 and 255.
  </p>
   <p class="para">
    A <span class="classname">Win32ServiceException</span> is thrown on error.
   </p>


name: win32_set_service_exit_code
purpose: Define or return the exit code for the current running service
manual_id: function.win32-set-service-exit-code
version: PECL win32service >=0.4.0
return_type: int
return_description: <p class="para"> Return the current or old exit code. </p>
errors:
<p class="para">
   Prior to version 1.0.0, if the SAPI is not <code class="literal">&quot;cli&quot;</code>, this function emits an
   <strong><code><a href="errorfunc.constants.html#constant.e-error">E_ERROR</a></code></strong> level error.
  </p>
   <p class="para">
    As of version 1.0.0, will throw a 
    <span class="classname">Win32ServiceException</span> if SAPI is not 
    <code class="literal">&quot;cli&quot;</code>
   </p>


name: win32_set_service_exit_mode
purpose: Define or return the exit mode for the current running service
manual_id: function.win32-set-service-exit-mode
version: PECL win32service >=0.4.0
return_type: bool
return_description: <p class="para"> Return the current or old exit mode. </p>
errors:
<p class="para">
   Prior to version 1.0.0, if the SAPI is not <code class="literal">&quot;cli&quot;</code>, this function emits an
   <strong><code><a href="errorfunc.constants.html#constant.e-error">E_ERROR</a></code></strong> level error.
  </p>

   <p class="para">
    As of version 1.0.0, will throw a 
    <span class="classname">Win32ServiceException</span> if SAPI is not 
    <code class="literal">&quot;cli&quot;</code>
   </p>


name: win32_start_service_ctrl_dispatcher
purpose: Registers the script with the SCM, so that it can act as the service with the given name
manual_id: function.win32-start-service-ctrl-dispatcher
version: PECL win32service >=0.1.0
return_type: void
errors:
<p class="para">
   Prior to version 1.0.0, if the SAPI is not <code class="literal">&quot;cli&quot;</code>, this function emits an 
   <strong><code><a href="errorfunc.constants.html#constant.e-error">E_ERROR</a></code></strong> level error.
  </p>
   <p class="para">
    As of version 1.0.0, will throw a 
    <span class="classname">Win32ServiceException</span> if SAPI is not 
    <code class="literal">&quot;cli&quot;</code>
   </p>


name: DOMCharacterData.after
purpose: Adds nodes after the character data
manual_id: domcharacterdata.after
version: PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<dl>
   
 <dt><strong><code><a href="dom.constants.html#constant.dom-hierarchy-request-err">DOM_HIERARCHY_REQUEST_ERR</a></code></strong></dt>
  <dd>
  <p class="para">
    Raised if the parent is of a type that does not allow children of the
    type of one of the passed <code class="parameter">nodes</code>, or if the node to
    put in is one of this node&#039;s ancestors or this node itself.
  </p>
 </dd>

   
 <dt><strong><code><a href="dom.constants.html#constant.dom-wrong-document-err">DOM_WRONG_DOCUMENT_ERR</a></code></strong></dt>
  <dd>
  <p class="para">
    Raised if one of the passed <code class="parameter">nodes</code> was created from a different
    document than the one that created this node.
  </p>
 </dd>

  </dl>


name: DOMCharacterData.deleteData
purpose: Remove a range of characters from the node
manual_id: domcharacterdata.deletedata
version: PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-index-size-err">DOM_INDEX_SIZE_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">offset</code> is negative or greater than the
       number of 16-bit units in data, or if <code class="parameter">count</code> is
       negative.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMCharacterData.insertData
purpose: Insert a string at the specified 16-bit unit offset
manual_id: domcharacterdata.insertdata
version: PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-index-size-err">DOM_INDEX_SIZE_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">offset</code> is negative or greater than the
       number of 16-bit units in data.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMCharacterData.substringData
purpose: Extracts a range of data from the node
manual_id: domcharacterdata.substringdata
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The specified substring. If the sum of <code class="parameter">offset</code> 
   and <code class="parameter">count</code> exceeds the length, then all 16-bit units 
   to the end of the data are returned.
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-index-size-err">DOM_INDEX_SIZE_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">offset</code> is negative or greater than the
       number of 16-bit units in data, or if <code class="parameter">count</code> is 
       negative.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMDocument.adoptNode
purpose: Transfer a node from another document
manual_id: domdocument.adoptnode
version: PHP >= 8.3
return_type: false
return_description:
<p class="para">
   The node that was transfered, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>

errors:
<dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-not-supported-err">DOM_NOT_SUPPORTED_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if the node type is not supported for document transfers.
      </p>
     </dd>
    
   </dl>


name: DOMDocument.append
purpose: Appends nodes after the last child node
manual_id: domdocument.append
version: PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<dl>
   
 <dt><strong><code><a href="dom.constants.html#constant.dom-hierarchy-request-err">DOM_HIERARCHY_REQUEST_ERR</a></code></strong></dt>
  <dd>
  <p class="para">
    Raised if this node is of a type that does not allow children of the
    type of one of the passed <code class="parameter">nodes</code>, or if the node to
    put in is one of this node&#039;s ancestors or this node itself.
  </p>
 </dd>

   
 <dt><strong><code><a href="dom.constants.html#constant.dom-wrong-document-err">DOM_WRONG_DOCUMENT_ERR</a></code></strong></dt>
  <dd>
  <p class="para">
    Raised if one of the passed <code class="parameter">nodes</code> was created from a different
    document than the one that created this node.
  </p>
 </dd>

  </dl>


name: DOMDocument.createAttribute
purpose: Create new attribute
manual_id: domdocument.createattribute
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The new <span class="classname">DOMAttr</span> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-invalid-character-err">DOM_INVALID_CHARACTER_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">localName</code> contains an invalid character.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMDocument.createAttributeNS
purpose: Create new attribute node with an associated namespace
manual_id: domdocument.createattributens
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The new <span class="classname">DOMAttr</span> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-invalid-character-err">DOM_INVALID_CHARACTER_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">qualifiedName</code> contains an invalid character.
      </p>
     </dd>
    
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-namespace-err">DOM_NAMESPACE_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">qualifiedName</code> is a malformed qualified
       name, or if <code class="parameter">qualifiedName</code> has a prefix and 
       <code class="parameter">namespace</code> is <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMDocument.createCDATASection
purpose: Create new cdata node
manual_id: domdocument.createcdatasection
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The new <span class="classname">DOMCDATASection</span> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>


name: DOMDocument.createElement
purpose: Create new element node
manual_id: domdocument.createelement
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a new instance of class <span class="classname">DOMElement</span> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   if an error occurred.
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-invalid-character-err">DOM_INVALID_CHARACTER_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">localName</code> contains an invalid character.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMDocument.createElementNS
purpose: Create new element node with an associated namespace
manual_id: domdocument.createelementns
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The new <span class="classname">DOMElement</span> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-invalid-character-err">DOM_INVALID_CHARACTER_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">qualifiedName</code> contains an invalid character.
      </p>
     </dd>
    
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-namespace-err">DOM_NAMESPACE_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">qualifiedName</code> is a malformed qualified
       name.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMDocument.createEntityReference
purpose: Create new entity reference node
manual_id: domdocument.createentityreference
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The new <span class="classname">DOMEntityReference</span> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error
   occurred.
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-invalid-character-err">DOM_INVALID_CHARACTER_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">name</code> contains an invalid character.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMDocument.createProcessingInstruction
purpose: Creates new PI node
manual_id: domdocument.createprocessinginstruction
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The new <span class="classname">DOMProcessingInstruction</span> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-invalid-character-err">DOM_INVALID_CHARACTER_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">target</code> contains an invalid character.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMDocument.getElementById
purpose: Searches for an element with a certain id
manual_id: domdocument.getelementbyid
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the <span class="classname">DOMElement</span> or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the element is
   not found. 
  </p>


name: DOMDocument.getElementsByTagName
purpose: Searches for all elements with given local tag name
manual_id: domdocument.getelementsbytagname
version: PHP 5, PHP 7, PHP 8
return_type: DOMNodeList
return_description:
<p class="para">
   A new <span class="classname">DOMNodeList</span> object containing all the matched 
   elements.
  </p>


name: DOMDocument.importNode
purpose: Import node into current document
manual_id: domdocument.importnode
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The copied node or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, if it cannot be copied.
  </p>

errors:
<p class="para">
   <span class="classname">DOMException</span> is thrown if node cannot be imported.
  </p>


name: DOMDocument.load
purpose: Load XML from a file
manual_id: domdocument.load
version: PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   If an empty string is passed as the <code class="parameter">filename</code>
   or an empty file is named, a warning will be generated. This warning
   is not generated by libxml and cannot be handled using libxml&#039;s error
   handling functions.
  </p>


name: DOMDocument.loadHTML
purpose: Load HTML from a string
manual_id: domdocument.loadhtml
version: PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   If an empty string is passed as the <code class="parameter">source</code>,
   a warning will be generated. This warning is not generated by libxml
   and cannot be handled using libxml&#039;s error handling functions.
  </p>
  <p class="para">While malformed HTML should load successfully, this function may generate <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> errors when it encounters bad markup. <a href="function.libxml-use-internal-errors.html" class="link">libxml&#039;s error handling functions</a> may be used to handle these errors.</p>


name: DOMDocument.loadHTMLFile
purpose: Load HTML from a file
manual_id: domdocument.loadhtmlfile
version: PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   If an empty string is passed as the <code class="parameter">filename</code>
   or an empty file is named, a warning will be generated. This warning
   is not generated by libxml and cannot be handled using <a href="function.libxml-use-internal-errors.html" class="link">libxml&#039;s error handling
   functions</a>.
  </p>
  <p class="para">While malformed HTML should load successfully, this function may generate <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> errors when it encounters bad markup. <a href="function.libxml-use-internal-errors.html" class="link">libxml&#039;s error handling functions</a> may be used to handle these errors.</p>


name: DOMDocument.loadXML
purpose: Load XML from a string
manual_id: domdocument.loadxml
version: PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   If an empty string is passed as the <code class="parameter">source</code>,
   a warning will be generated. This warning is not generated by libxml
   and cannot be handled using libxml&#039;s error handling functions.
  </p>


name: DOMDocument.save
purpose: Dumps the internal XML tree back into a file
manual_id: domdocument.save
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the number of bytes written or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>


name: DOMDocument.saveHTML
purpose: Dumps the internal document into a string using HTML formatting
manual_id: domdocument.savehtml
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the HTML, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>


name: DOMDocument.saveXML
purpose: Dumps the internal XML tree back into a string
manual_id: domdocument.savexml
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the XML, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-wrong-document-err">DOM_WRONG_DOCUMENT_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">node</code> is from another document.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMDocument.validate
purpose: Validates the document based on its DTD
manual_id: domdocument.validate
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.
   If the document has no DTD attached, this method will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: DOMDocument.xinclude
purpose: Substitutes XIncludes in a DOMDocument Object
manual_id: domdocument.xinclude
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the number of XIncludes in the document, -1 if some processing failed,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there were no substitutions.
  </p>


name: DOMElement.getAttribute
purpose: Returns value of attribute
manual_id: domelement.getattribute
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The value of the attribute, or an empty string if no attribute with the
   given <code class="parameter">qualifiedName</code> is found.
  </p>


name: DOMElement.getAttributeNode
purpose: Returns attribute node
manual_id: domelement.getattributenode
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The attribute node. Note that for XML namespace declarations
   (<code class="literal">xmlns</code> and <code class="literal">xmlns:*</code> attributes) an 
   instance of <span class="classname">DOMNameSpaceNode</span> is returned instead of a
   <span class="classname">DOMAttr</span>.
  </p>


name: DOMElement.getAttributeNodeNS
purpose: Returns attribute node
manual_id: domelement.getattributenodens
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The attribute node. Note that for XML namespace declarations
   (<code class="literal">xmlns</code> and <code class="literal">xmlns:*</code> attributes) an 
   instance of <span class="classname">DOMNameSpaceNode</span> is returned instead of a
   <span class="classname">DOMAttr</span> object.
  </p>


name: DOMElement.getAttributeNS
purpose: Returns value of attribute
manual_id: domelement.getattributens
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The value of the attribute, or an empty string if no attribute with the
   given <code class="parameter">localName</code> and <code class="parameter">namespace</code> 
   is found.
  </p>


name: DOMElement.getElementsByTagName
purpose: Gets elements by tagname
manual_id: domelement.getelementsbytagname
version: PHP 5, PHP 7, PHP 8
return_type: DOMNodeList
return_description:
<p class="para">
   This function returns a new instance of the class
   <span class="classname">DOMNodeList</span> of all matched elements.
  </p>


name: DOMElement.getElementsByTagNameNS
purpose: Get elements by namespaceURI and localName
manual_id: domelement.getelementsbytagnamens
version: PHP 5, PHP 7, PHP 8
return_type: DOMNodeList
return_description:
<p class="para">
   This function returns a new instance of the class
   <span class="classname">DOMNodeList</span> of all matched elements in the order in
   which they are encountered in a preorder traversal of this element tree.
  </p>


name: DOMElement.insertAdjacentElement
purpose: Insert adjacent element
manual_id: domelement.insertadjacentelement
version: PHP 8 >= 8.3.0
return_type: null
return_description:
<p class="para">
   Return <span class="classname">DOMElement</span> or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: DOMElement.removeAttribute
purpose: Removes attribute
manual_id: domelement.removeattribute
version: PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-no-modification-allowed-err">DOM_NO_MODIFICATION_ALLOWED_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if the node is readonly.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMElement.removeAttributeNode
purpose: Removes attribute
manual_id: domelement.removeattributenode
version: PHP 5, PHP 7, PHP 8
return_type: false
errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-no-modification-allowed-err">DOM_NO_MODIFICATION_ALLOWED_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if the node is readonly.
      </p>
     </dd>
    
    
     <dt><strong><code>DOM_NOT_FOUND_ERROR</code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">attr</code> is not an attribute of the element.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMElement.setAttribute
purpose: Adds new or modifies existing attribute
manual_id: domelement.setattribute
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   The created or modified <span class="classname">DOMAttr</span> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-no-modification-allowed-err">DOM_NO_MODIFICATION_ALLOWED_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if the node is readonly.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMElement.setAttributeNode
purpose: Adds new attribute node to element
manual_id: domelement.setattributenode
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the old attribute if it has been replaced or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if there was no old attribute.
   If a <strong><code><a href="dom.constants.html#constant.dom-wrong-document-err">DOM_WRONG_DOCUMENT_ERR</a></code></strong> error is raised, and <var class="varname">strictErrorChecking</var> is <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-wrong-document-err">DOM_WRONG_DOCUMENT_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">attr</code> belongs to a different document than the element.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMElement.setAttributeNS
purpose: Adds new attribute
manual_id: domelement.setattributens
version: PHP 5, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-no-modification-allowed-err">DOM_NO_MODIFICATION_ALLOWED_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if the node is readonly.
      </p>
     </dd>
    
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-namespace-err">DOM_NAMESPACE_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">qualifiedName</code> is a malformed qualified
       name, or if <code class="parameter">qualifiedName</code> has a prefix and 
       <code class="parameter">namespace</code> is <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMElement.setIdAttribute
purpose: Declares the attribute specified by name to be of type ID
manual_id: domelement.setidattribute
version: PHP 5, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-no-modification-allowed-err">DOM_NO_MODIFICATION_ALLOWED_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if the node is readonly.
      </p>
     </dd>
    
    
     <dt><strong><code>DOM_NOT_FOUND</code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">qualifiedName</code> is not an attribute of this element.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMElement.setIdAttributeNode
purpose: Declares the attribute specified by node to be of type ID
manual_id: domelement.setidattributenode
version: PHP 5, PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-no-modification-allowed-err">DOM_NO_MODIFICATION_ALLOWED_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if the node is readonly.
      </p>
     </dd>
    
    
     <dt><strong><code>DOM_NOT_FOUND</code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">name</code> is not an attribute of this element.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMElement.toggleAttribute
purpose: Toggle attribute
manual_id: domelement.toggleattribute
version: PHP 8 >= 8.3.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 attribute is present after finishing the call, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: DOMImplementation.createDocument
purpose: Creates a DOMDocument object of the specified type with its document element
manual_id: domimplementation.createdocument
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   A new <span class="classname">DOMDocument</span> object or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error. If
   <code class="parameter">namespace</code>, <code class="parameter">qualifiedName</code>,
   and <code class="parameter">doctype</code> are null, the returned
   <span class="classname">DOMDocument</span> is empty with no document element
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-wrong-document-err">DOM_WRONG_DOCUMENT_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">doctype</code> has already been used with a
       different document or was created from a different implementation.
      </p>
     </dd>
    
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-namespace-err">DOM_NAMESPACE_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if there is an error with the namespace, as determined by
       <code class="parameter">namespace</code> and <code class="parameter">qualifiedName</code>.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMImplementation.createDocumentType
purpose: Creates an empty DOMDocumentType object
manual_id: domimplementation.createdocumenttype
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   A new <span class="classname">DOMDocumentType</span> node with its 
   <code class="literal">ownerDocument</code> set to <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-namespace-err">DOM_NAMESPACE_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if there is an error with the namespace, as determined by 
       <code class="parameter">qualifiedName</code>.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMNamedNodeMap.count
purpose: Get number of nodes in the map
manual_id: domnamednodemap.count
version: PHP 7 >= 7.2.0, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the number of nodes in the map, which is identical to the
   <a href="class.domnamednodemap.html#domnamednodemap.props.length" class="link">length</a> property.
  </p>


name: DOMNamedNodeMap.getIterator
purpose: Retrieve an external iterator
manual_id: domnamednodemap.getiterator
version: PHP 8
return_type: Iterator
errors: <p class="para"> Throws an <span class="classname">Exception</span> on failure. </p>
return_description:
<p class="para">
   An instance of an object implementing <span class="classname">Iterator</span> or
   <span class="classname">Traversable</span>
  </p>


name: DOMNamedNodeMap.getNamedItem
purpose: Retrieves a node specified by name
manual_id: domnamednodemap.getnameditem
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   A node (of any type) with the specified <code class="literal">nodeName</code>, or 
   <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if no node is found.
  </p>


name: DOMNamedNodeMap.getNamedItemNS
purpose: Retrieves a node specified by local name and namespace URI
manual_id: domnamednodemap.getnameditemns
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   A node (of any type) with the specified local name and namespace URI, or 
   <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if no node is found.
  </p>


name: DOMNamedNodeMap.item
purpose: Retrieves a node specified by index
manual_id: domnamednodemap.item
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The node at the <code class="parameter">index</code>th position in the map, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
   if that is not a valid index (greater than or equal to the number of nodes 
   in this map).
  </p>


name: DOMNode.appendChild
purpose: Adds new child at the end of the children
manual_id: domnode.appendchild
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The node added or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-no-modification-allowed-err">DOM_NO_MODIFICATION_ALLOWED_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if this node is readonly or if the previous parent of the node
       being inserted is readonly.
      </p>
     </dd>
    
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-hierarchy-request-err">DOM_HIERARCHY_REQUEST_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if this node is of a type that does not allow children of the 
       type of the <code class="parameter">node</code> node, or if the node to 
       append is one of this node&#039;s ancestors or this node itself.
      </p>
     </dd>
    
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-wrong-document-err">DOM_WRONG_DOCUMENT_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">node</code> was created from a different 
       document than the one that created this node.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMNode.C14N
purpose: Canonicalize nodes to a string
manual_id: domnode.c14n
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns canonicalized nodes as a string or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: DOMNode.C14NFile
purpose: Canonicalize nodes to a file
manual_id: domnode.c14nfile
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Number of bytes written or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: DOMNode.contains
purpose: Checks if node contains other node
manual_id: domnode.contains
version: PHP 8 >= 8.3.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if node contains <code class="parameter">other</code> node, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: DOMNode.getLineNo
purpose: Get line number for a node
manual_id: domnode.getlineno
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the line number where the node was defined at parse time.
   If the node was created manually, the return value will be <code class="literal">0</code>.
  </p>


name: DOMNode.getNodePath
purpose: Get an XPath for a node
manual_id: domnode.getnodepath
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns a <span class="type">string</span> containing the XPath, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> in case of an error.
  </p>


name: DOMNode.insertBefore
purpose: Adds a new child before a reference node
manual_id: domnode.insertbefore
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The inserted node or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-no-modification-allowed-err">DOM_NO_MODIFICATION_ALLOWED_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if this node is readonly or if the previous parent of the node
       being inserted is readonly.
      </p>
     </dd>
    
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-hierarchy-request-err">DOM_HIERARCHY_REQUEST_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if this node is of a type that does not allow children of the
       type of the <code class="parameter">node</code> node, or if the node to
       append is one of this node&#039;s ancestors or this node itself.
      </p>
     </dd>
    
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-wrong-document-err">DOM_WRONG_DOCUMENT_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">node</code> was created from a different
       document than the one that created this node.
      </p>
     </dd>
    
    
     <dt><strong><code>DOM_NOT_FOUND</code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">child</code> is not a child of this node.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMNode.isDefaultNamespace
purpose: Checks if the specified namespaceURI is the default namespace or not
manual_id: domnode.isdefaultnamespace
version: 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 <code class="parameter">namespace</code> is the default
   namespace, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: DOMNode.isEqualNode
purpose: Checks that both nodes are equal
manual_id: domnode.isequalnode
version: PHP 8 >= 8.3.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if both nodes are equal, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: DOMNode.lookupNamespaceURI
purpose: Gets the namespace URI of the node based on the prefix
manual_id: domnode.lookupnamespaceuri
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the associated namespace URI or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if none is found.
  </p>


name: DOMNode.lookupPrefix
purpose: Gets the namespace prefix of the node based on the namespace URI
manual_id: domnode.lookupprefix
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The prefix of the namespace or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on error.
  </p>


name: DOMNode.removeChild
purpose: Removes child from list of children
manual_id: domnode.removechild
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   If the child could be removed the function returns the old child or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-no-modification-allowed-err">DOM_NO_MODIFICATION_ALLOWED_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if this node is readonly.
      </p>
     </dd>
    
    
     <dt><strong><code>DOM_NOT_FOUND</code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">child</code> is not a child of this node.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMNode.replaceChild
purpose: Replaces a child
manual_id: domnode.replacechild
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The old node or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occur.
  </p>

errors:
<p class="para">
   <dl>
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-no-modification-allowed-err">DOM_NO_MODIFICATION_ALLOWED_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if this node is readonly or if the previous parent of the node
       being inserted is readonly.
      </p>
     </dd>
    
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-hierarchy-request-err">DOM_HIERARCHY_REQUEST_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if this node is of a type that does not allow children of the 
       type of the <code class="parameter">node</code> node, or if the node to 
       put in is one of this node&#039;s ancestors or this node itself.
      </p>
     </dd>
    
    
     <dt><strong><code><a href="dom.constants.html#constant.dom-wrong-document-err">DOM_WRONG_DOCUMENT_ERR</a></code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">node</code> was created from a different 
       document than the one that created this node.
      </p>
     </dd>
    
    
     <dt><strong><code>DOM_NOT_FOUND</code></strong></dt>
     <dd>
      <p class="para">
       Raised if <code class="parameter">child</code> is not a child of this node.
      </p>
     </dd>
    
   </dl>
  </p>


name: DOMNodeList.count
purpose: Get number of nodes in the list
manual_id: domnodelist.count
version: PHP 7 >= 7.2.0, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the number of nodes in the list, which is identical to the
   <a href="class.domnodelist.html#domnodelist.props.length" class="link">length</a> property.
  </p>


name: DOMNodeList.item
purpose: Retrieves a node specified by index
manual_id: domnodelist.item
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The node at the <code class="parameter">index</code>th position in the 
   <span class="classname">DOMNodeList</span>, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if that is not a valid
   index.
  </p>


name: DOMText.isWhitespaceInElementContent
purpose: Indicates whether this text node contains whitespace
manual_id: domtext.iswhitespaceinelementcontent
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 node contains zero or more whitespace characters and
   nothing else. Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: DOMText.splitText
purpose: Breaks this node into two nodes at the specified offset
manual_id: domtext.splittext
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The new node of the same type, which contains all the content at and after the 
   <code class="parameter">offset</code>.
  </p>


name: DOMXPath.evaluate
purpose: Evaluates the given XPath expression and returns a typed result if possible
manual_id: domxpath.evaluate
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns a typed result if possible or a <span class="classname">DOMNodeList</span> 
   containing all nodes matching the given XPath <code class="parameter">expression</code>. 
  </p>
  <p class="para">
   If the <code class="parameter">expression</code> is malformed or the
   <code class="parameter">contextNode</code> is invalid,
    <span class="methodname">DOMXPath::evaluate</span> returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: DOMXPath.query
purpose: Evaluates the given XPath expression
manual_id: domxpath.query
version: PHP 5, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns a <span class="classname">DOMNodeList</span> containing all nodes matching
   the given XPath <code class="parameter">expression</code>. Any expression which
   does not return nodes will return an empty
   <span class="classname">DOMNodeList</span>.
  </p>
  <p class="para">
   If the <code class="parameter">expression</code> is malformed or the
   <code class="parameter">contextNode</code> is invalid,
    <span class="methodname">DOMXPath::query</span> returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: libxml_get_errors
purpose: Retrieve array of errors
manual_id: function.libxml-get-errors
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array with <span class="type">LibXMLError</span> objects if there are any
   errors in the buffer, or an empty array otherwise.
  </p>


name: libxml_get_external_entity_loader
purpose: Get the current external entity loader
manual_id: function.libxml-get-external-entity-loader
version: PHP 8 >= 8.2.0
return_type: null
return_description:
<p class="para">
   The external entity loader previously installed by
   <span class="function">libxml_set_external_entity_loader</span>. If that function was
   never called, or if it was called with <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> will be returned.
  </p>


name: libxml_get_last_error
purpose: Retrieve last error from libxml
manual_id: function.libxml-get-last-error
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a <span class="type">LibXMLError</span> object if there is any error in the
   buffer, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: libxml_use_internal_errors
purpose: Disable libxml errors and allow user to fetch error information as needed
manual_id: function.libxml-use-internal-errors
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   This function returns the previous value of
   <code class="parameter">use_errors</code>.
  </p>


name: SimpleXMLElement.addChild
purpose: Adds a child element to the XML node
manual_id: simplexmlelement.addchild
version: PHP 5 >= 5.1.3, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The <code class="literal">addChild</code> method returns a <span class="type">SimpleXMLElement</span>
   object representing the child added to the XML node on success; <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: SimpleXMLElement.asXML
purpose: Return a well-formed XML string based on SimpleXML element
manual_id: simplexmlelement.asxml
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   If the <code class="parameter">filename</code> isn&#039;t specified, this function
   returns a <span class="type">string</span> on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error. If the
   parameter is specified, it returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the file was written
   successfully and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SimpleXMLElement.attributes
purpose: Identifies an element's attributes
manual_id: simplexmlelement.attributes
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns a <span class="classname">SimpleXMLElement</span> object that can be
   iterated over to loop through the attributes on the tag.
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if called on a <span class="classname">SimpleXMLElement</span>
   object that already represents an attribute and not a tag.
  </p>


name: SimpleXMLElement.children
purpose: Finds children of given node
manual_id: simplexmlelement.children
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns a <span class="classname">SimpleXMLElement</span> element, whether the node 
   has children or not, unless the node represents an attribute, in which case
   <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> is returned.
  </p>


name: SimpleXMLElement.__construct
purpose: Creates a new SimpleXMLElement object
manual_id: simplexmlelement.construct
version: PHP 5, PHP 7, PHP 8
errors:
<p class="para">
   Produces an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> error message for each error
   found in the XML data and additionally throws an <span class="classname">Exception</span> if the XML data
   could not be parsed.
  </p>
  <div class="tip"><strong class="tip">Tip</strong>
   <p class="para">
    Use <span class="function">libxml_use_internal_errors</span> to suppress all XML
    errors, and <span class="function">libxml_get_errors</span> to iterate over them
    afterwards.
   </p>
  </div>


name: SimpleXMLElement.current
purpose: Returns the current element
manual_id: simplexmlelement.current
return_type: SimpleXMLElement
errors: <p class="para"> Throws an <span class="classname">Error</span> on failure. </p>
return_description:
<p class="para">
   Returns the current element as a <span class="classname">SimpleXMLElement</span> object.
  </p>


name: SimpleXMLElement.getDocNamespaces
purpose: Returns namespaces declared in document
manual_id: simplexmlelement.getdocnamespaces
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The <code class="literal">getDocNamespaces</code> method returns an <span class="type">array</span> 
   of namespace names with their associated URIs.
  </p>


name: SimpleXMLElement.getName
purpose: Gets the name of the XML element
manual_id: simplexmlelement.getname
version: PHP 5 >= 5.1.3, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The <code class="literal">getName</code> method returns as a <span class="type">string</span> the 
   name of the XML tag referenced by the SimpleXMLElement object.
  </p>


name: SimpleXMLElement.getNamespaces
purpose: Returns namespaces used in document
manual_id: simplexmlelement.getnamespaces
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   The <code class="literal">getNamespaces</code> method returns an <span class="type">array</span> of 
   namespace names with their associated URIs.
  </p>


name: SimpleXMLElement.getChildren
purpose: Returns the sub-elements of the current element
manual_id: simplexmlelement.getchildren
return_type: null
return_description:
<p class="para">
   Returns a <span class="classname">SimpleXMLElement</span> object containing
   the sub-elements of the current element.
  </p>


name: SimpleXMLElement.hasChildren
purpose: Checks whether the current element has sub elements
manual_id: simplexmlelement.haschildren
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 has sub-elements, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: SimpleXMLElement.key
purpose: Return current key
manual_id: simplexmlelement.key
return_type: string
errors: <p class="para"> Throws an <span class="classname">Error</span> on failure. </p>
return_description:
<p class="para">
   Returns the XML tag name of the element referenced by the current <span class="classname">SimpleXMLElement</span> object.
  </p>


name: SimpleXMLElement.xpath
purpose: Runs XPath query on XML data
manual_id: simplexmlelement.xpath
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="type">array</span> of SimpleXMLElement objects on success; or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> in
   case of an error.
  </p>


name: simplexml_import_dom
purpose: Get a SimpleXMLElement object from a DOM node
manual_id: function.simplexml-import-dom
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns a <span class="type">SimpleXMLElement</span> or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: simplexml_load_file
purpose: Interprets an XML file into an object
manual_id: function.simplexml-load-file
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="type">object</span> of class <span class="type">SimpleXMLElement</span> with
   properties containing the data held within the XML document, 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>

errors:
<p class="para">
   Produces an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> error message for each error
   found in the XML data.
  </p>
  <div class="tip"><strong class="tip">Tip</strong>
   <p class="para">
    Use <span class="function">libxml_use_internal_errors</span> to suppress all XML
    errors, and <span class="function">libxml_get_errors</span> to iterate over them
    afterwards.
   </p>
  </div>


name: simplexml_load_string
purpose: Interprets a string of XML into an object
manual_id: function.simplexml-load-string
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="type">object</span> of class <span class="type">SimpleXMLElement</span> with
   properties containing the data held within the xml document, 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>

errors:
<p class="para">
   Produces an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> error message for each error
   found in the XML data.
  </p>
  <div class="tip"><strong class="tip">Tip</strong>
   <p class="para">
    Use <span class="function">libxml_use_internal_errors</span> to suppress all XML
    errors, and <span class="function">libxml_get_errors</span> to iterate over them
    afterwards.
   </p>
  </div>


name: wddx_deserialize
purpose: Unserializes a WDDX packet
manual_id: function.wddx-deserialize
version: PHP 4, PHP 5, PHP 7
return_type: mixed
return_description:
<p class="para">
   Returns the deserialized value which can be a string, a number or an
   array. Note that structures are deserialized into associative arrays.
  </p>


name: wddx_packet_start
purpose: Starts a new WDDX packet with structure inside it
manual_id: function.wddx-packet-start
version: PHP 4, PHP 5, PHP 7
return_type: resource
return_description:
<p class="para">
   Returns a packet ID for use in later functions, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: wddx_serialize_value
purpose: Serialize a single value into a WDDX packet
manual_id: function.wddx-serialize-value
version: PHP 4, PHP 5, PHP 7
return_type: string
return_description:
<p class="para">
   Returns the WDDX packet, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: xml_error_string
purpose: Get XML parser error string
manual_id: function.xml-error-string
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns a string with a textual description of the error
   <code class="parameter">error_code</code>, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if no description was found.
  </p>


name: xml_get_current_byte_index
purpose: Get current byte index for an XML parser
manual_id: function.xml-get-current-byte-index
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns which byte index
   the parser is currently at in its data buffer (starting at 0).
  </p>


name: xml_get_current_column_number
purpose: Get current column number for an XML parser
manual_id: function.xml-get-current-column-number
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns which column on
   the current line (as given by
   <span class="function">xml_get_current_line_number</span>) the parser is
   currently at.
  </p>


name: xml_get_error_code
purpose: Get XML parser error code
manual_id: function.xml-get-error-code
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns one of the error
   codes listed in the <a href="xml.error-codes.html" class="link">error codes
   section</a>.
  </p>


name: xml_parse_into_struct
purpose: Parse XML data into an array structure
manual_id: function.xml-parse-into-struct
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   <span class="function">xml_parse_into_struct</span> returns 0 for failure and 1 for
   success. This is not the same as <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> and <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, be careful with
   operators such as ===.
  </p>


name: xml_parse
purpose: Start parsing an XML document
manual_id: function.xml-parse
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns 1 on success or 0 on failure.
  </p>
  <p class="para">
   For unsuccessful parses, error information can be retrieved with
   <span class="function">xml_get_error_code</span>,
   <span class="function">xml_error_string</span>,
   <span class="function">xml_get_current_line_number</span>,
   <span class="function">xml_get_current_column_number</span> and
   <span class="function">xml_get_current_byte_index</span>.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    Some errors (such as entity errors) are reported at the end of the data, thus only if
    <code class="parameter">is_final</code> is set and <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.
   </p>
  </p></blockquote>


name: xml_parser_get_option
purpose: Get options from an XML parser
manual_id: function.xml-parser-get-option
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description: <p class="para"> Returns the option&#039;s value. </p>
errors:
<p class="para">
   Throws a <span class="classname">ValueError</span> when an invalid value is passed
   to <code class="parameter">option</code>.
  </p>
  <p class="para">
   Prior to PHP 8.0.0, passing an invalid value to
   <code class="parameter">option</code> generated a <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong>
   as well as making the function return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: xml_parser_set_option
purpose: Set options in an XML parser
manual_id: function.xml-parser-set-option
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   Throws a <span class="classname">ValueError</span> when an invalid value is passed
   to <code class="parameter">option</code>.
  </p>
  <p class="para">
   Prior to PHP 8.0.0, the function returned false when passing an invalid
   value to
   <code class="parameter">option</code> generated a <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong>
   as well as making the function return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: XMLReader.expand
purpose: Returns a copy of the current node as a DOM object
manual_id: xmlreader.expand
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The resulting <span class="classname">DOMNode</span> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: XMLReader.getAttribute
purpose: Get the value of a named attribute
manual_id: xmlreader.getattribute
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The value of the attribute, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if no attribute with the given
   <code class="parameter">name</code> is found or not positioned on an element node.
  </p>


name: XMLReader.getAttributeNo
purpose: Get the value of an attribute by index
manual_id: xmlreader.getattributeno
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The value of the attribute, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if no attribute exists at
   <code class="parameter">index</code> or is not positioned on the element.
  </p>


name: XMLReader.getAttributeNs
purpose: Get the value of an attribute by localname and URI
manual_id: xmlreader.getattributens
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The value of the attribute, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if no attribute with the given
   <code class="parameter">name</code> and <code class="parameter">namespace</code> is
   found or not positioned of element.
  </p>


name: XMLReader.isValid
purpose: Indicates if the parsed document is valid
manual_id: xmlreader.isvalid
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> when the document is valid or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: XMLReader.lookupNamespace
purpose: Lookup namespace for a prefix
manual_id: xmlreader.lookupnamespace
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The value of the namespace, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if no namespace exists.
  </p>


name: XMLReader.moveToElement
purpose: Position cursor on the parent Element of current Attribute
manual_id: xmlreader.movetoelement
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 successful and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it fails or not positioned on 
   Attribute when this method is called.
  </p>


name: XMLReader.open
purpose: Set the URI containing the XML to parse
manual_id: xmlreader.open
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: XMLReader
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 called statically, returns an
   <span class="classname">XMLReader</span> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   This method may be called statically, but prior to PHP 8.0.0, will issue an
   <strong><code><a href="errorfunc.constants.html#constant.e-deprecated">E_DEPRECATED</a></code></strong> error in this case.
  </p>


name: XMLReader.readInnerXml
purpose: Retrieve XML from current node
manual_id: xmlreader.readinnerxml
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the contents of the current node as a string. Empty string on failure.
  </p>


name: XMLReader.readOuterXml
purpose: Retrieve XML from current node, including itself
manual_id: xmlreader.readouterxml
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the contents of current node, including itself, as a string. Empty string on failure.
  </p>


name: XMLReader.readString
purpose: Reads the contents of the current node as a string
manual_id: xmlreader.readstring
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the content of the current node as a string. Empty string on
   failure.
  </p>


name: XMLReader.setSchema
purpose: Validate document against XSD
manual_id: xmlreader.setschema
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   Issues <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> if libxml was built without schema
   support, the schema contains errors or if
   <span class="function">XMLReader::read</span> has already been called.
  </p>


name: XMLWriter.flush
purpose: Flush current buffer
manual_id: xmlwriter.flush
version: PHP 5 >= 5.1.2, PHP 7, PHP 8, PECL xmlwriter >= 1.0.0
return_type: int
return_description:
<p class="para">
   If you opened the writer in memory, this function returns the generated XML buffer,
   Else, if using URI, this function will write the buffer and return the number of 
   written bytes.
  </p>


name: XMLWriter.openMemory
purpose: Create new xmlwriter using memory for string output
manual_id: xmlwriter.openmemory
version: PHP 5 >= 5.1.2, PHP 7, PHP 8, PECL xmlwriter >= 0.1.0
return_type: false
return_description:
<p class="para">
   Object-oriented style: 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">
   Procedural style: Returns a new <span class="classname">XMLWriter</span> for later use with the
   xmlwriter functions on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: XMLWriter.openUri
purpose: Create new xmlwriter using source uri for output
manual_id: xmlwriter.openuri
version: PHP 5 >= 5.1.2, PHP 7, PHP 8, PECL xmlwriter >= 0.1.0
return_type: false
return_description:
<p class="para">
   Object-oriented style: 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">
   Procedural style: Returns a new <span class="classname">XMLWriter</span> instance for later use with the
   xmlwriter functions on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: XSLTProcessor.getParameter
purpose: Get value of a parameter
manual_id: xsltprocessor.getparameter
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The value of the parameter (as a string), or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it&#039;s not set.
  </p>


name: XSLTProcessor.getSecurityPrefs
purpose: Get security preferences
manual_id: xsltprocessor.getsecurityprefs
version: PHP >= 5.4.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   A bitmask consisting of <strong><code><a href="xsl.constants.html#constant.xsl-secpref-read-file">XSL_SECPREF_READ_FILE</a></code></strong>,
   <strong><code><a href="xsl.constants.html#constant.xsl-secpref-write-file">XSL_SECPREF_WRITE_FILE</a></code></strong>,
   <strong><code><a href="xsl.constants.html#constant.xsl-secpref-create-directory">XSL_SECPREF_CREATE_DIRECTORY</a></code></strong>,
   <strong><code><a href="xsl.constants.html#constant.xsl-secpref-read-network">XSL_SECPREF_READ_NETWORK</a></code></strong>,
   <strong><code><a href="xsl.constants.html#constant.xsl-secpref-write-network">XSL_SECPREF_WRITE_NETWORK</a></code></strong>.
  </p>


name: XSLTProcessor.transformToDoc
purpose: Transform to a document
manual_id: xsltprocessor.transformtodoc
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The resulting document or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: XSLTProcessor.transformToXml
purpose: Transform to XML
manual_id: xsltprocessor.transformtoxml
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The result of the transformation as a string or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: UI\Draw\Stroke.getCap
purpose: Get Line Cap
manual_id: ui-draw-stroke.getcap
version: UI 0.9.9
return_type: int
return_description:
<p class="para">
   UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square
  </p>


name: UI\Draw\Stroke.getJoin
purpose: Get Line Join
manual_id: ui-draw-stroke.getjoin
version: UI 0.9.9
return_type: int
return_description:
<p class="para">
   UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel
  </p>


name: UI\Draw\Text\Font\fontFamilies
purpose: Retrieve Font Families
manual_id: function.ui-draw-text-font-fontfamilies
version: UI 0.9.9
return_type: array
return_description:
<p class="para">
   Returns an <span class="type">array</span> of valid font families for the current system.
  </p>


