# php_manual

id: RecursiveCallbackFilterIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  Return the inner iterator's children contained in a RecursiveCallbackFilterIterator
  
  Fetches the filtered children of the inner iterator.
  
  RecursiveCallbackFilterIterator::hasChildren should be used to determine if there are children to
  be fetched.

<comment>Return:</comment>
  <info>RecursiveCallbackFilterIterator</info>  Returns a <class>RecursiveCallbackFilterIterator</class> containing the
                                   children.

<comment>See Also:</comment>
   * RecursiveCallbackFilterIterator Examples
   * RecursiveCallbackFilterIterator::__construct
   * RecursiveCallbackFilteriterator::hasChildren


id: RecursiveCallbackFilterIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  Check whether the inner iterator's current element has children
  
  Returns <info>true</info> if the current element has children, <info>false</info> otherwise.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the current element has children, <info>false</info> otherwise.

<comment>See Also:</comment>
   * RecursiveCallbackFilterIterator Examples
   * RecursiveCallbackFilterIterator::__construct
   * RecursiveCallbackFilteriterator::getChildren


id: RecursiveDirectoryIterator
type: class
doc:
<comment>Description:</comment>
  The <class>RecursiveDirectoryIterator</class> provides an interface for iterating recursively over filesystem
  directories.


id: RecursiveDirectoryIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a RecursiveDirectoryIterator
  
  Constructs a RecursiveDirectoryIterator for the provided <strong>$directory</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  The path of the directory to be iterated over.
  <info>int</info>     <strong>$flags</strong>      Flags may be provided which will affect the behavior of some methods. A list
                      of the flags can found under FilesystemIterator predefined constants. They can
                      also be set later with FilesystemIterator::setFlags.

<comment>See Also:</comment>
   * FilesystemIterator::__construct
   * RecursiveIteratorIterator::__construct
   * FilesystemIterator predefined constants


id: RecursiveDirectoryIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  Returns an iterator for the current entry if it is a directory
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>RecursiveDirectoryIterator</info>  The filename, file information, or $this depending on the set flags.
                              See the FilesystemIterator constants.


id: RecursiveDirectoryIterator::getSubPath
type: function
doc:
<comment>Description:</comment>
  Get sub path
  
  Returns the sub path relative to the directory given in the constructor.

<comment>Return:</comment>
  <info>string</info>  The sub path.

<comment>See Also:</comment>
   * RecursiveDirectoryIterator::getSubPathName
   * RecursiveDirectoryIterator::key


id: RecursiveDirectoryIterator::getSubPathname
type: function
doc:
<comment>Description:</comment>
  Get sub path and name
  
  Gets the sub path and filename.

<comment>Return:</comment>
  <info>string</info>  The sub path (sub directory) and filename.

<comment>See Also:</comment>
   * RecursiveDirectoryIterator::getSubPath
   * RecursiveDirectoryIterator::key


id: RecursiveDirectoryIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  Returns whether current entry is a directory and not '.' or '..'
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info>bool</info>  <strong>$allowLinks</strong>  

<comment>Return:</comment>
  <info>bool</info>  Returns whether the current entry is a directory, but not '.' or '..'


id: RecursiveDirectoryIterator::key
type: function
doc:
<comment>Description:</comment>
  Return path and filename of current dir entry
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>string</info>  The path and filename of the current dir entry.


id: RecursiveDirectoryIterator::next
type: function
doc:
<comment>Description:</comment>
  Move to next entry
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveDirectoryIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind dir back to the start
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveFilterIterator
type: class
doc:
<comment>Description:</comment>
  This abstract iterator filters out unwanted values for a <class>RecursiveIterator</class>. This class should be
  extended to implement custom filters.  The RecursiveFilterIterator::accept must be implemented in
  the subclass.


id: RecursiveFilterIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Create a RecursiveFilterIterator from a RecursiveIterator
  
  Create a <class>RecursiveFilterIterator</class> from a <class>RecursiveIterator</class>.

<comment>Param:</comment>
  <info>RecursiveIterator</info>  <strong>$iterator</strong>  The <class>RecursiveIterator</class> to be filtered.

<comment>See Also:</comment>
   * RecursiveFilterIterator::getChildren
   * RecursiveFilterIterator::hasChildren
   * FilterIterator::accept


id: RecursiveFilterIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  Return the inner iterator's children contained in a RecursiveFilterIterator
  
  Return the inner iterator's children contained in a <class>RecursiveFilterIterator</class>.

<comment>Return:</comment>
  <info>RecursiveFilterIterator|null</info>  Returns a <class>RecursiveFilterIterator</class> containing the inner iterator's
                                children.

<comment>See Also:</comment>
   * RecursiveFilterIterator::hasChildren
   * RecursiveIterator::getChildren


id: RecursiveFilterIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  Check whether the inner iterator's current element has children
  
  Check whether the inner iterator's current element has children.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the inner iterator has children, otherwise <info>false</info>

<comment>See Also:</comment>
   * RecursiveFilterIterator::getChildren
   * RecursiveIterator::hasChildren


id: RecursiveIterator
type: class
doc:
<comment>Description:</comment>
  Classes implementing <class>RecursiveIterator</class> can be used to iterate over iterators recursively.


id: RecursiveIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  Returns an iterator for the current entry
  
  Returns an iterator for the current iterator entry.

<comment>Return:</comment>
  <info>RecursiveIterator|null</info>  Returns an iterator for the current entry if it exists, or <info>null</info> otherwise.

<comment>See Also:</comment>
   * <strong>RecursiveIterator::hasChildren()</strong>


id: RecursiveIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  Returns if an iterator can be created for the current entry
  
  Returns if an iterator can be created for the current entry. RecursiveIterator::getChildren.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the current entry can be iterated over, otherwise returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>RecursiveIterator::getChildren()</strong>


id: RecursiveIteratorIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a RecursiveIteratorIterator
  
  Creates a <class>RecursiveIteratorIterator</class> from a <class>RecursiveIterator</class>.

<comment>Param:</comment>
  <info>Traversable</info>  <strong>$iterator</strong>  The iterator being constructed from. Either a <class>RecursiveIterator</class> or
                          <class>IteratorAggregate</class>.
  <info>int</info>          <strong>$mode</strong>      Optional mode. Possible values are <info>RecursiveIteratorIterator::LEAVES_ONLY</info>
                          - The default. Lists only leaves in iteration.
                          <info>RecursiveIteratorIterator::SELF_FIRST</info> - Lists leaves and parents in
                          iteration with parents coming first.
                          <info>RecursiveIteratorIterator::CHILD_FIRST</info> - Lists leaves and parents in
                          iteration with leaves coming first.
  <info>int</info>          <strong>$flags</strong>     Optional flag. Possible values are
                          <info>RecursiveIteratorIterator::CATCH_GET_CHILD</info> which will then ignore
                          exceptions thrown in calls to RecursiveIteratorIterator::getChildren.


id: RecursiveIteratorIterator::beginChildren
type: function
doc:
<comment>Description:</comment>
  Begin children
  
  Is called after calling RecursiveIteratorIterator::getChildren, and its associated
  RecursiveIteratorIterator::rewind.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveIteratorIterator::beginIteration
type: function
doc:
<comment>Description:</comment>
  Begin Iteration
  
  Called when iteration begins (after the first RecursiveIteratorIterator::rewind call.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveIteratorIterator::callGetChildren
type: function
doc:
<comment>Description:</comment>
  Get children
  
  Get children of the current element.

<comment>Return:</comment>
  <info>RecursiveIterator|null</info>  A RecursiveIterator on success, or <info>null</info> on failure.


id: RecursiveIteratorIterator::callHasChildren
type: function
doc:
<comment>Description:</comment>
  Has children
  
  Called for each element to test whether it has children.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>bool</info>  Returns whether the element has children.


id: RecursiveIteratorIterator::current
type: function
doc:
<comment>Description:</comment>
  Access the current element value
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>mixed</info>  The current elements value.


id: RecursiveIteratorIterator::endChildren
type: function
doc:
<comment>Description:</comment>
  End children
  
  Called when end recursing one level.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveIteratorIterator::endIteration
type: function
doc:
<comment>Description:</comment>
  End Iteration
  
  Called when the iteration ends (when RecursiveIteratorIterator::valid first returns <info>false</info>.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveIteratorIterator::getDepth
type: function
doc:
<comment>Description:</comment>
  Get the current depth of the recursive iteration
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>int</info>  The current depth of the recursive iteration.


id: RecursiveIteratorIterator::getInnerIterator
type: function
doc:
<comment>Description:</comment>
  Get inner iterator
  
  Gets the current active sub iterator.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>RecursiveIterator</info>  The current active sub iterator.


id: RecursiveIteratorIterator::getMaxDepth
type: function
doc:
<comment>Description:</comment>
  Get max depth
  
  Gets the maximum allowable depth.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>int|false</info>  The maximum accepted depth, or <info>false</info> if any depth is allowed.

<comment>See Also:</comment>
   * RecursiveIteratorIterator::setMaxDepth


id: RecursiveIteratorIterator::getSubIterator
type: function
doc:
<comment>Description:</comment>
  The current active sub iterator
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$level</strong>  

<comment>Return:</comment>
  <info>RecursiveIterator|null</info>  The current active sub iterator on success; <info>null</info> on failure.


id: RecursiveIteratorIterator::key
type: function
doc:
<comment>Description:</comment>
  Access the current key
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>mixed</info>  The current key.


id: RecursiveIteratorIterator::next
type: function
doc:
<comment>Description:</comment>
  Move forward to the next element
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveIteratorIterator::nextElement
type: function
doc:
<comment>Description:</comment>
  Next element
  
  Called when the next element is available.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveIteratorIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the iterator to the first element of the top level inner iterator
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveIteratorIterator::setMaxDepth
type: function
doc:
<comment>Description:</comment>
  Set max depth
  
  Set the maximum allowed depth.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxDepth</strong>  The maximum allowed depth. <return>-1</return> is used for any depth.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveIteratorIterator::valid
type: function
doc:
<comment>Description:</comment>
  Check whether the current position is valid
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the current position is valid, otherwise <info>false</info>


id: RecursiveRegexIterator
type: class
doc:
<comment>Description:</comment>
  This recursive iterator can filter another recursive iterator via a regular expression.


id: RecursiveRegexIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new RecursiveRegexIterator
  
  Creates a new regular expression iterator.

<comment>Param:</comment>
  <info>RecursiveIterator</info>  <strong>$iterator</strong>   The recursive iterator to apply this regex filter to.
  <info>string</info>             <strong>$pattern</strong>    The regular expression to match.
  <info>int</info>                <strong>$mode</strong>       Operation mode, see RegexIterator::setMode for a list of modes.
  <info>int</info>                <strong>$flags</strong>      Special flags, see RegexIterator::setFlags for a list of available
                                 flags.
  <info>int</info>                <strong>$pregFlags</strong>  The regular expression flags. These flags depend on the operation
                                 mode parameter:
                                 
                                 <class>RegexIterator</class> preg_flagsoperation modeavailable
                                 flagsRecursiveRegexIterator::ALL_MATCHES See <strong>preg_match_all()</strong>.
                                 RecursiveRegexIterator::GET_MATCH See <strong>preg_match()</strong>.
                                 RecursiveRegexIterator::MATCH See <strong>preg_match()</strong>.
                                 RecursiveRegexIterator::REPLACE none. RecursiveRegexIterator::SPLIT
                                 See <strong>preg_split()</strong>.

<comment>See Also:</comment>
   * <strong>preg_match()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_split()</strong>


id: RecursiveRegexIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  Returns an iterator for the current entry
  
  Returns an iterator for the current iterator entry.

<comment>Return:</comment>
  <info>RecursiveRegexIterator</info>  An iterator for the current entry, if it can be iterated over by the inner
                          iterator.

<comment>See Also:</comment>
   * <strong>RecursiveRegexIterator::hasChildren()</strong>


id: RecursiveRegexIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  Returns whether an iterator can be obtained for the current entry
  
  Returns whether an iterator can be obtained for the current entry. This iterator can be obtained
  via RecursiveRegexIterator::getChildren.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if an iterator can be obtained for the current entry, otherwise returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>RecursiveRegexIterator::getChildren()</strong>


id: RecursiveTreeIterator
type: class
doc:
<comment>Description:</comment>
  Allows iterating over a <class>RecursiveIterator</class> to generate an ASCII graphic tree.


id: RecursiveTreeIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a RecursiveTreeIterator
  
  Constructs a new <class>RecursiveTreeIterator</class> from the supplied recursive iterator.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info>RecursiveIterator|IteratorAggregate</info>  <strong>$iterator</strong>          The <class>RecursiveIterator</class> or <class>IteratorAggregate</class>
                                                          to iterate over.
  <info>int</info>                                  <strong>$flags</strong>             Flags may be provided which will affect
                                                          the behavior of some methods.  A list of
                                                          the flags can found under
                                                          RecursiveTreeIterator predefined
                                                          constants.
  <info></info>                                     <strong>$caching_it_flags</strong>  Flags to affect the behavior of the
                                                          <class>RecursiveCachingIterator</class> used internally.
  <info>int</info>                                  <strong>$mode</strong>              Flags to affect the behavior of the
                                                          <class>RecursiveIteratorIterator</class> used internally.


id: RecursiveTreeIterator::beginChildren
type: function
doc:
<comment>Description:</comment>
  Begin children
  
  Called when recursing one level down.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveTreeIterator::beginIteration
type: function
doc:
<comment>Description:</comment>
  Begin iteration
  
  Called when iteration begins (after the first RecursiveTreeIterator::rewind call).
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>RecursiveIterator</info>  A <class>RecursiveIterator</class>.


id: RecursiveTreeIterator::callGetChildren
type: function
doc:
<comment>Description:</comment>
  Get children
  
  Gets children of the current element.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>RecursiveIterator</info>  A <class>RecursiveIterator</class>.


id: RecursiveTreeIterator::callHasChildren
type: function
doc:
<comment>Description:</comment>
  Has children
  
  Called for each element to test whether it has children.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if there are children, otherwise <info>false</info>


id: RecursiveTreeIterator::current
type: function
doc:
<comment>Description:</comment>
  Get current element
  
  Gets the current element prefixed and postfixed.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>mixed</info>  Returns the current element prefixed and postfixed.


id: RecursiveTreeIterator::endIteration
type: function
doc:
<comment>Description:</comment>
  End iteration
  
  Called when the iteration ends (when RecursiveTreeIterator::valid first returns <info>false</info>)
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveTreeIterator::getEntry
type: function
doc:
<comment>Description:</comment>
  Get current entry
  
  Gets the part of the tree built for the current element.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>string</info>  Returns the part of the tree built for the current element.


id: RecursiveTreeIterator::getPostfix
type: function
doc:
<comment>Description:</comment>
  Get the postfix
  
  Gets the string to place after the current element.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>string</info>  Returns the string to place after the current element.


id: RecursiveTreeIterator::getPrefix
type: function
doc:
<comment>Description:</comment>
  Get the prefix
  
  Gets the string to place in front of current element
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>string</info>  Returns the string to place in front of current element


id: RecursiveTreeIterator::key
type: function
doc:
<comment>Description:</comment>
  Get the key of the current element
  
  Gets the current key prefixed and postfixed.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>mixed</info>  Returns the current key prefixed and postfixed.


id: RecursiveTreeIterator::next
type: function
doc:
<comment>Description:</comment>
  Move to next element
  
  Moves forward to the next element.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveTreeIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind iterator
  
  Rewinds the iterator to the first element of the top level inner iterator.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveTreeIterator::setPostfix
type: function
doc:
<comment>Description:</comment>
  Set postfix
  
  Sets postfix as used in RecursiveTreeIterator::getPostfix.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info>string</info>  <strong>$postfix</strong>  

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveTreeIterator::setPrefixPart
type: function
doc:
<comment>Description:</comment>
  Set a part of the prefix
  
  Sets a part of the prefix used in the graphic tree.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info>int</info>     <strong>$part</strong>   One of the RecursiveTreeIterator::PREFIX_* constants.
  <info>string</info>  <strong>$value</strong>  The value to assign to the part of the prefix specified in <strong>$part</strong>.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: RecursiveTreeIterator::valid
type: function
doc:
<comment>Description:</comment>
  Check validity
  
  Check whether the current position is valid.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the current position is valid, otherwise <info>false</info>


id: Reflection::export
type: function
doc:
<comment>Description:</comment>
  Exports
  
  Exports a reflection.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info>Reflector</info>  <strong>$reflector</strong>  The reflection to export.
  <info>bool</info>       <strong>$return</strong>     Setting to <info>true</info> will return the export,
                         as opposed to emitting it. Setting to <info>false</info> (the default) will do the
                         opposite.

<comment>Return:</comment>
  <info>string</info>  If the <strong>$return</strong> parameter
          is set to <info>true</info>, then the export is returned as a <info>string</info>,
          otherwise <info>null</info> is returned.

<comment>See Also:</comment>
   * Reflection::getModifierNames


id: Reflection::getModifierNames
type: function
doc:
<comment>Description:</comment>
  Gets modifier names
  
  Gets modifier names.

<comment>Param:</comment>
  <info>int</info>  <strong>$modifiers</strong>  Bitfield of the modifiers to get.

<comment>Return:</comment>
  <info>array</info>  An array of modifier names.

<comment>See Also:</comment>
   * ReflectionClass::getModifiers
   * ReflectionClassConstant::getModifiers
   * ReflectionMethod::getModifiers
   * ReflectionProperty::getModifiers


id: ReflectionAttribute
type: class
doc:
<comment>Description:</comment>
  The <class>ReflectionAttribute</class> class provides information about an Attribute.


id: ReflectionAttribute::getArguments
type: function
doc:
<comment>Description:</comment>
  Gets arguments passed to attribute
  
  Gets arguments passed to attribute.

<comment>Return:</comment>
  <info>array</info>  The arguments passed to attribute.


id: ReflectionAttribute::getName
type: function
doc:
<comment>Description:</comment>
  Gets attribute name
  
  Gets the attributes name.

<comment>Return:</comment>
  <info>string</info>  The name of the attribute.


id: ReflectionAttribute::getTarget
type: function
doc:
<comment>Description:</comment>
  Returns the target of the attribute as bitmask
  
  Gets target of the attribute as bitmask.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>int</info>   Gets target of the attribute as bitmask.


id: ReflectionAttribute::isRepeated
type: function
doc:
<comment>Description:</comment>
  Returns whether the attribute of this name has been repeated on a code element
  
  Returns whether the attribute of this name has been repeated on a code element.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> when attribute is used repeatedly, otherwise <info>false</info>.


id: ReflectionAttribute::newInstance
type: function
doc:
<comment>Description:</comment>
  Instantiates the attribute class represented by this ReflectionAttribute class and arguments
  
  Instantiates the attribute class represented by this ReflectionAttribute class and arguments.

<comment>Return:</comment>
  <info>object</info>  New instance of the attribute.


id: ReflectionClass
type: class
doc:
<comment>Description:</comment>
  The <class>ReflectionClass</class> class reports information about a class.


id: ReflectionClass::IS_IMPLICIT_ABSTRACT
type: constant
doc:
<comment>Description:</comment>
  Indicates the class is  abstract because it has some abstract methods.


id: ReflectionClass::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a ReflectionClass
  
  Constructs a new <class>ReflectionClass</class> object.

<comment>Param:</comment>
  <info>object|string</info>  <strong>$objectOrClass</strong>  Either a <info>string</info> containing the name of the class to reflect, or an
                                 <info>object</info>.

<comment>See Also:</comment>
   * ReflectionObject::__construct
   * Constructors


id: ReflectionClass::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of the ReflectionClass object
  
  Returns the string representation of the ReflectionClass object.

<comment>Return:</comment>
  <info>string</info>  A string representation of this <class>ReflectionClass</class> instance.

<comment>See Also:</comment>
   * ReflectionClass::export
   * __toString()


id: ReflectionClass::export
type: function
doc:
<comment>Description:</comment>
  Exports a class
  
  Exports a reflected class.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$argument</strong>  The reflection to export.
  <info>bool</info>   <strong>$return</strong>    Setting to <info>true</info> will return the export,
                    as opposed to emitting it. Setting to <info>false</info> (the default) will do the opposite.

<comment>Return:</comment>
  <info>string</info>  If the <strong>$return</strong> parameter
          is set to <info>true</info>, then the export is returned as a <info>string</info>,
          otherwise <info>null</info> is returned.

<comment>See Also:</comment>
   * ReflectionClass::getName
   * ReflectionClass::__toString


id: ReflectionClass::getAttributes
type: function
doc:
<comment>Description:</comment>
  Gets Attributes
  
  Returns all attributes declared on this class as an array of <info>ReflectionAttribute</info>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>   Filter the results to include only <class>ReflectionAttribute</class> instances for
                       attributes matching this class name.
  <info>int</info>          <strong>$flags</strong>  Flags for determining how to filter the results, if <strong>$name</strong> is provided.
                       
                       Default is <return>0</return> which will only return results for attributes that are of the
                       class <strong>$name</strong>.
                       
                       The only other option available, is to use
                       <info>ReflectionAttribute::IS_INSTANCEOF</info>, which will instead use <return>instanceof</return> for
                       filtering.

<comment>Return:</comment>
  <info>array</info>  Array of attributes, as a <class>ReflectionAttribute</class> object.

<comment>See Also:</comment>
   * ReflectionClassConstant::getAttributes
   * ReflectionFunctionAbstract::getAttributes
   * ReflectionParameter::getAttributes
   * ReflectionProperty::getAttributes


id: ReflectionClass::getConstant
type: function
doc:
<comment>Description:</comment>
  Gets defined constant
  
  Gets the defined constant.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the class constant to get.

<comment>Return:</comment>
  <info>mixed</info>  Value of the constant with the name <strong>$name</strong>. Returns <info>false</info> if the constant was not found in
         the class.

<comment>See Also:</comment>
   * ReflectionClass::getConstants


id: ReflectionClass::getConstants
type: function
doc:
<comment>Description:</comment>
  Gets constants
  
  Gets all defined constants from a class, regardless of their visibility.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$filter</strong>  The optional filter, for filtering desired constant visibilities. It's
                     configured using the ReflectionClassConstant constants, and defaults to all
                     constant visibilities.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of constants, where the keys hold the name and the values the value of the
         constants.

<comment>See Also:</comment>
   * ReflectionClass::getConstant


id: ReflectionClass::getConstructor
type: function
doc:
<comment>Description:</comment>
  Gets the constructor of the class
  
  Gets the constructor of the reflected class.

<comment>Return:</comment>
  <info>ReflectionMethod|null</info>  A <class>ReflectionMethod</class> object reflecting the class' constructor, or <info>null</info> if the
                         class has no constructor.

<comment>See Also:</comment>
   * ReflectionClass::getName


id: ReflectionClass::getDefaultProperties
type: function
doc:
<comment>Description:</comment>
  Gets default properties
  
  Gets default properties from a class (including inherited properties).
  
  This method only works for static properties when used on internal classes. The default value of a
  static class property can not be tracked when using this method on user defined classes.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of default properties, with the key being the name of the property and the value
         being the default value of the property or <info>null</info> if the property doesn't have a default
         value. The function does not distinguish between static and non static properties and does
         not take visibility modifiers into account.

<comment>See Also:</comment>
   * ReflectionClass::getProperties
   * ReflectionClass::getStaticProperties
   * ReflectionClass::getProperty


id: ReflectionClass::getDocComment
type: function
doc:
<comment>Description:</comment>
  Gets doc comments
  
  Gets doc comments from a class. Doc comments start with <return>/**</return>, followed by whitespace. If there are
  multiple doc comments above the class definition, the one closest to the class will be taken.

<comment>Return:</comment>
  <info>string|false</info>  The doc comment if it exists, otherwise <info>false</info>.

<comment>See Also:</comment>
   * ReflectionClass::getName


id: ReflectionClass::getEndLine
type: function
doc:
<comment>Description:</comment>
  Gets end line
  
  Gets end line number from a user-defined class definition.

<comment>Return:</comment>
  <info>int|false</info>  The ending line number of the user defined class, or <info>false</info> if unknown.

<comment>See Also:</comment>
   * ReflectionClass::getStartLine


id: ReflectionClass::getExtension
type: function
doc:
<comment>Description:</comment>
  Gets a ReflectionExtension object for the extension which defined the class
  
  Gets a <class>ReflectionExtension</class> object for the extension which defined the class.

<comment>Return:</comment>
  <info>ReflectionExtension|null</info>  A <class>ReflectionExtension</class> object representing the extension which defined
                            the class, or <info>null</info> for user-defined classes.

<comment>See Also:</comment>
   * ReflectionClass::getExtensionName


id: ReflectionClass::getExtensionName
type: function
doc:
<comment>Description:</comment>
  Gets the name of the extension which defined the class
  
  Gets the name of the extension which defined the class.

<comment>Return:</comment>
  <info>string|false</info>  The name of the extension which defined the class, or <info>false</info> for user-defined
                classes.

<comment>See Also:</comment>
   * ReflectionClass::getExtension


id: ReflectionClass::getFileName
type: function
doc:
<comment>Description:</comment>
  Gets the filename of the file in which the class has been defined
  
  Gets the filename of the file in which the class has been defined.

<comment>Return:</comment>
  <info>string|false</info>  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, <info>false</info> is returned.

<comment>See Also:</comment>
   * ReflectionClass::getExtensionName


id: ReflectionClass::getInterfaceNames
type: function
doc:
<comment>Description:</comment>
  Gets the interface names
  
  Get the interface names.

<comment>Return:</comment>
  <info>array</info>  A numerical array with interface names as the values.

<comment>See Also:</comment>
   * ReflectionClass::getInterfaces


id: ReflectionClass::getInterfaces
type: function
doc:
<comment>Description:</comment>
  Gets the interfaces
  
  Gets the interfaces.

<comment>Return:</comment>
  <info>array</info>  An associative <info>array</info> of interfaces, with keys as interface names and the array values as
         <class>ReflectionClass</class> objects.

<comment>See Also:</comment>
   * ReflectionClass::getInterfaceNames


id: ReflectionClass::getMethod
type: function
doc:
<comment>Description:</comment>
  Gets a ReflectionMethod for a class method
  
  Gets a <class>ReflectionMethod</class> for a class method.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The method name to reflect.

<comment>Return:</comment>
  <info>ReflectionMethod</info>  A <class>ReflectionMethod</class>.

<comment>See Also:</comment>
   * ReflectionClass::getMethods


id: ReflectionClass::getMethods
type: function
doc:
<comment>Description:</comment>
  Gets an array of methods
  
  Gets an array of methods for the class.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$filter</strong>  Filter the results to include only methods with certain attributes. Defaults to
                     no filtering.
                     
                     Any bitwise disjunction of <info>ReflectionMethod::IS_STATIC</info>,
                     <info>ReflectionMethod::IS_PUBLIC</info>, <info>ReflectionMethod::IS_PROTECTED</info>,
                     <info>ReflectionMethod::IS_PRIVATE</info>, <info>ReflectionMethod::IS_ABSTRACT</info>,
                     <info>ReflectionMethod::IS_FINAL</info>, so that all methods with any of the given
                     attributes will be returned.
                     
                     Note that other bitwise operations, for instance <return>~</return> will not work as expected.
                     In other words, it is not possible to retrieve all non-static methods, for
                     example.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of <class>ReflectionMethod</class> objects reflecting each method.

<comment>See Also:</comment>
   * ReflectionClass::getMethod
   * <strong>get_class_methods()</strong>


id: ReflectionClass::getModifiers
type: function
doc:
<comment>Description:</comment>
  Gets the class modifiers
  
  Returns a bitfield of the access modifiers for this class.

<comment>Return:</comment>
  <info>int</info>  Returns bitmask of  modifier constants.

<comment>See Also:</comment>
   * ReflectionClass::getProperties
   * Reflection::getModifierNames


id: ReflectionClass::getName
type: function
doc:
<comment>Description:</comment>
  Gets class name
  
  Gets the class name.

<comment>Return:</comment>
  <info>string</info>  The class name.

<comment>See Also:</comment>
   * ReflectionClass::getNamespaceName


id: ReflectionClass::getNamespaceName
type: function
doc:
<comment>Description:</comment>
  Gets namespace name
  
  Gets the namespace name.

<comment>Return:</comment>
  <info>string</info>  The namespace name.

<comment>See Also:</comment>
   * ReflectionClass::getParentClass
   * namespaces


id: ReflectionClass::getParentClass
type: function
doc:
<comment>Description:</comment>
  Gets parent class
  
  Get the parent class.

<comment>Return:</comment>
  <info>ReflectionClass|false</info>  A <class>ReflectionClass</class> or <info>false</info> if there's no parent.

<comment>See Also:</comment>
   * ReflectionClass::__construct


id: ReflectionClass::getProperties
type: function
doc:
<comment>Description:</comment>
  Gets properties
  
  Retrieves reflected properties.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$filter</strong>  The optional filter, for filtering desired property types. It's configured
                     using the ReflectionProperty constants, and defaults to all property types.

<comment>Return:</comment>
  <info>array</info>  An array of <class>ReflectionProperty</class> objects.

<comment>See Also:</comment>
   * ReflectionClass::getProperty
   * <class>ReflectionProperty</class>
   * ReflectionProperty modifier constants


id: ReflectionClass::getProperty
type: function
doc:
<comment>Description:</comment>
  Gets a ReflectionProperty for a class's property
  
  Gets a <class>ReflectionProperty</class> for a class's property.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The property name.

<comment>Return:</comment>
  <info>ReflectionProperty</info>  A <class>ReflectionProperty</class>.

<comment>See Also:</comment>
   * ReflectionClass::getProperties


id: ReflectionClass::getReflectionConstant
type: function
doc:
<comment>Description:</comment>
  Gets a ReflectionClassConstant for a class's constant
  
  Gets a <class>ReflectionClassConstant</class> for a class's property.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The class constant name.

<comment>Return:</comment>
  <info>ReflectionClassConstant|false</info>  A <class>ReflectionClassConstant</class>,  or <info>false</info> on failure.

<comment>See Also:</comment>
   * ReflectionClass::getReflectionConstants
   * <class>ReflectionClassConstant</class>


id: ReflectionClass::getReflectionConstants
type: function
doc:
<comment>Description:</comment>
  Gets class constants
  
  Retrieves reflected constants.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$filter</strong>  The optional filter, for filtering desired constant visibilities. It's
                     configured using the ReflectionClassConstant constants, and defaults to all
                     constant visibilities.

<comment>Return:</comment>
  <info>array</info>  An array of <class>ReflectionClassConstant</class> objects.

<comment>See Also:</comment>
   * ReflectionClass::getReflectionConstant
   * <class>ReflectionClassConstant</class>


id: ReflectionClass::getShortName
type: function
doc:
<comment>Description:</comment>
  Gets short name
  
  Gets the short name of the class, the part without the namespace.

<comment>Return:</comment>
  <info>string</info>  The class short name.

<comment>See Also:</comment>
   * ReflectionClass::getName


id: ReflectionClass::getStartLine
type: function
doc:
<comment>Description:</comment>
  Gets starting line number
  
  Get the starting line number.

<comment>Return:</comment>
  <info>int|false</info>  The starting line number, as an <info>int</info>, or <info>false</info> if unknown.

<comment>See Also:</comment>
   * ReflectionClass::getEndLine


id: ReflectionClass::getStaticProperties
type: function
doc:
<comment>Description:</comment>
  Gets static properties
  
  Get the static properties.

<comment>Return:</comment>
  <info>array</info>  The static properties, as an <info>array</info>.

<comment>See Also:</comment>
   * ReflectionClass::getStaticPropertyValue
   * ReflectionClass::setStaticPropertyValue


id: ReflectionClass::getStaticPropertyValue
type: function
doc:
<comment>Description:</comment>
  Gets static property value
  
  Gets the value of a static property on this class.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>       The name of the static property for which to return a value.
  <info>mixed</info>   <strong>$def_value</strong>  A default value to return in case the class does not declare a static property
                      with the given <strong>$name</strong>. If the property does not exist and this argument is
                      omitted, a <class>ReflectionException</class> is thrown.

<comment>Return:</comment>
  <info>mixed</info>  The value of the static property.

<comment>See Also:</comment>
   * ReflectionClass::getStaticProperties
   * ReflectionClass::setStaticPropertyValue


id: ReflectionClass::getTraitAliases
type: function
doc:
<comment>Description:</comment>
  Returns an array of trait aliases
  
  Get the array of trait method aliases defined in the current class.

<comment>Return:</comment>
  <info>array</info>  Returns an array with new method names in keys and original names (in the format
         <return>"TraitName::original"</return>) in values.


id: ReflectionClass::getTraitNames
type: function
doc:
<comment>Description:</comment>
  Returns an array of names of traits used by this class
  
  Get the names of the traits used by this class.

<comment>Return:</comment>
  <info>array</info>  Returns an array with trait names in values.


id: ReflectionClass::getTraits
type: function
doc:
<comment>Description:</comment>
  Returns an array of traits used by this class
  
  Get the array of traits used by this class.

<comment>Return:</comment>
  <info>array</info>  Returns an array with trait names in keys and instances of trait's <class>ReflectionClass</class> in
         values. Returns <info>null</info> in case of an error.


id: ReflectionClass::hasConstant
type: function
doc:
<comment>Description:</comment>
  Checks if constant is defined
  
  Checks whether the class has a specific constant defined or not.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the constant being checked for.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the constant is defined, otherwise <info>false</info>.

<comment>See Also:</comment>
   * ReflectionClass::hasMethod
   * ReflectionClass::hasProperty


id: ReflectionClass::hasMethod
type: function
doc:
<comment>Description:</comment>
  Checks if method is defined
  
  Checks whether a specific method is defined in a class.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the method being checked for.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if it has the method, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionClass::hasConstant
   * ReflectionClass::hasProperty


id: ReflectionClass::hasProperty
type: function
doc:
<comment>Description:</comment>
  Checks if property is defined
  
  Checks whether the specified property is defined.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the property being checked for.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if it has the property, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionClass::hasConstant
   * ReflectionClass::hasMethod


id: ReflectionClass::implementsInterface
type: function
doc:
<comment>Description:</comment>
  Implements interface
  
  Checks whether it implements an interface.

<comment>Param:</comment>
  <info>ReflectionClass|string</info>  <strong>$interface</strong>  The interface name.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * ReflectionClass::isInterface
   * ReflectionClass::isSubclassOf
   * <strong>interface_exists()</strong>
   * Object Interfaces


id: ReflectionClass::inNamespace
type: function
doc:
<comment>Description:</comment>
  Checks if in namespace
  
  Checks if this class is defined in a namespace.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * ReflectionClass::getNamespaceName
   * PHP Namespaces


id: ReflectionClass::isAbstract
type: function
doc:
<comment>Description:</comment>
  Checks if class is abstract
  
  Checks if the class is abstract.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * ReflectionClass::isInterface
   * Class Abstraction


id: ReflectionClass::isAnonymous
type: function
doc:
<comment>Description:</comment>
  Checks if class is anonymous
  
  Checks if a class is an anonymous class.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * ReflectionClass::isFinal


id: ReflectionClass::isCloneable
type: function
doc:
<comment>Description:</comment>
  Returns whether this class is cloneable
  
  Returns whether this class is cloneable.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the class is cloneable, <info>false</info> otherwise.


id: ReflectionClass::isEnum
type: function
doc:
<comment>Description:</comment>
  Returns whether this is an enum
  
  Checks if a class is an enum.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if this is an enum, <info>false</info> otherwise.


id: ReflectionClass::isFinal
type: function
doc:
<comment>Description:</comment>
  Checks if class is final
  
  Checks if a class is final.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * ReflectionClass::isAbstract
   * Final Keyword


id: ReflectionClass::isInstance
type: function
doc:
<comment>Description:</comment>
  Checks class for instance
  
  Checks if an object is an instance of a class.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The object being compared to.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * ReflectionClass::isInterface
   * Type operators (instanceof)
   * Object Interfaces
   * <strong>is_a()</strong>


id: ReflectionClass::isInstantiable
type: function
doc:
<comment>Description:</comment>
  Checks if the class is instantiable
  
  Checks if the class is instantiable.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * ReflectionClass::isInstance


id: ReflectionClass::isInterface
type: function
doc:
<comment>Description:</comment>
  Checks if the class is an interface
  
  Checks whether the class is an interface.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * ReflectionClass::isInstance


id: ReflectionClass::isInternal
type: function
doc:
<comment>Description:</comment>
  Checks if class is defined internally by an extension, or the core
  
  Checks if the class is defined internally by an extension, or the core, as opposed to
  user-defined.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * ReflectionClass::isUserDefined


id: ReflectionClass::isIterable
type: function
doc:
<comment>Description:</comment>
  Check whether this class is iterable
  
  Check whether this class is iterable (i.e. can be used inside foreach).

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * ReflectionClass::__construct


id: ReflectionClass::isIterateable
type: function
doc:
<comment>Description:</comment>
  Alias of ReflectionClass::isIterable
  
  Alias of ReflectionClass::isIterable
  
  As of PHP 7.2.0, instead of the missspelled RefectionClass::isIterateable,
  ReflectionClass::isIterable should be preferred.


id: ReflectionClass::isReadOnly
type: function
doc:
<comment>Description:</comment>
  Checks if class is readonly
  
  Checks if a class is readonly.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if a class is readonly, <info>false</info> otherwise.

<comment>See Also:</comment>
   * ReflectionClass::isAbstract
   * Readonly classes


id: ReflectionClass::isSubclassOf
type: function
doc:
<comment>Description:</comment>
  Checks if a subclass
  
  Checks if the class is a subclass of a specified class or implements a specified interface.

<comment>Param:</comment>
  <info>ReflectionClass|string</info>  <strong>$class</strong>  Either the name of the class as <info>string</info> or a <info>ReflectionClass</info> object
                                  of the class to check against.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * ReflectionClass::isInterface
   * ReflectionClass::implementsInterface
   * <strong>is_subclass_of()</strong>
   * <strong>get_parent_class()</strong>


id: ReflectionClass::isTrait
type: function
doc:
<comment>Description:</comment>
  Returns whether this is a trait
  
  Check whether this <info>ReflectionClass</info> refers to a trait.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if this is a trait, <info>false</info> otherwise.


id: ReflectionClass::isUserDefined
type: function
doc:
<comment>Description:</comment>
  Checks if user defined
  
  Checks whether the class is user-defined, as opposed to internal.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * ReflectionClass::isInternal


id: ReflectionClass::newInstance
type: function
doc:
<comment>Description:</comment>
  Creates a new class instance from given arguments
  
  Creates a new instance of the class. The given arguments are passed to the class constructor.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$args</strong>  Accepts a variable number of arguments which are passed to the class constructor,
                much like <strong>call_user_func()</strong>.

<comment>Return:</comment>
  <info>object</info>  

<comment>See Also:</comment>
   * ReflectionClass::newInstanceArgs
   * ReflectionClass::newInstanceWithoutConstructor


id: ReflectionClass::newInstanceArgs
type: function
doc:
<comment>Description:</comment>
  Creates a new class instance from given arguments
  
  Creates a new instance of the class, the given arguments are passed to the class constructor.

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  The parameters to be passed to the class constructor as an <info>array</info>.

<comment>Return:</comment>
  <info>object|null</info>  Returns a new instance of the class, or <info>null</info> on failure.

<comment>See Also:</comment>
   * ReflectionClass::newInstance
   * ReflectionClass::newInstanceWithoutConstructor


id: ReflectionClass::newInstanceWithoutConstructor
type: function
doc:
<comment>Description:</comment>
  Creates a new class instance without invoking the constructor
  
  Creates a new instance of the class without invoking the constructor.

<comment>Return:</comment>
  <info>object</info>  

<comment>See Also:</comment>
   * ReflectionClass::newInstance
   * ReflectionClass::newInstanceArgs


id: ReflectionClass::setStaticPropertyValue
type: function
doc:
<comment>Description:</comment>
  Sets static property value
  
  Sets static property value.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Property name.
  <info>mixed</info>   <strong>$value</strong>  New property value.

<comment>Return:</comment>
  <info>void</info>  No value is returned.

<comment>See Also:</comment>
   * ReflectionClass::getStaticPropertyValue


id: ReflectionClassConstant
type: class
doc:
<comment>Description:</comment>
  The <class>ReflectionClassConstant</class> class reports information about a class constant.


id: ReflectionClassConstant::IS_PRIVATE
type: constant
doc:
<comment>Description:</comment>
  Indicates private constants. Prior to PHP 7.4.0, the value was <return>1024</return>.


id: ReflectionClassConstant::IS_PROTECTED
type: constant
doc:
<comment>Description:</comment>
  Indicates protected constants. Prior to PHP 7.4.0, the value was <return>512</return>.


id: ReflectionClassConstant::IS_PUBLIC
type: constant
doc:
<comment>Description:</comment>
  Indicates public constants. Prior to PHP 7.4.0, the value was <return>256</return>.


id: ReflectionClassConstant::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a ReflectionClassConstant
  
  Constructs a new <class>ReflectionClassConstant</class> object.

<comment>Param:</comment>
  <info>object|string</info>  <strong>$class</strong>     Either a <info>string</info> containing the name of the class to reflect, or an
                            <info>object</info>.
  <info>string</info>         <strong>$constant</strong>  The name of the class constant.

<comment>See Also:</comment>
   * Constructors


id: ReflectionClassConstant::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of the ReflectionClassConstant object
  
  Returns the string representation of the ReflectionClassConstant object.

<comment>Return:</comment>
  <info>string</info>  A string representation of this <class>ReflectionClassConstant</class> instance.

<comment>See Also:</comment>
   * ReflectionClassConstant::export
   * __toString()


id: ReflectionClassConstant::export
type: function
doc:
<comment>Description:</comment>
  Export
  
  Exports a reflection.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$class</strong>   The reflection to export.
  <info>string</info>  <strong>$name</strong>    The class constant name.
  <info>bool</info>    <strong>$return</strong>  Setting to <info>true</info> will return the export,
                   as opposed to emitting it. Setting to <info>false</info> (the default) will do the opposite.

<comment>Return:</comment>
  <info>string</info>  

<comment>See Also:</comment>
   * ReflectionClassConstant::__toString


id: ReflectionClassConstant::getAttributes
type: function
doc:
<comment>Description:</comment>
  Gets Attributes
  
  Returns all attributes declared on this class constant as an array of <info>ReflectionAttribute</info>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>   Filter the results to include only <class>ReflectionAttribute</class> instances for
                       attributes matching this class name.
  <info>int</info>          <strong>$flags</strong>  Flags for determining how to filter the results, if <strong>$name</strong> is provided.
                       
                       Default is <return>0</return> which will only return results for attributes that are of the
                       class <strong>$name</strong>.
                       
                       The only other option available, is to use
                       <info>ReflectionAttribute::IS_INSTANCEOF</info>, which will instead use <return>instanceof</return> for
                       filtering.

<comment>Return:</comment>
  <info>array</info>  Array of attributes, as a <class>ReflectionAttribute</class> object.

<comment>See Also:</comment>
   * ReflectionClass::getAttributes
   * ReflectionFunctionAbstract::getAttributes
   * ReflectionParameter::getAttributes
   * ReflectionProperty::getAttributes


id: ReflectionClassConstant::getDeclaringClass
type: function
doc:
<comment>Description:</comment>
  Gets declaring class
  
  Gets the declaring class.

<comment>Return:</comment>
  <info>ReflectionClass</info>  A <class>ReflectionClass</class> object.


id: ReflectionClassConstant::getDocComment
type: function
doc:
<comment>Description:</comment>
  Gets doc comments
  
  Gets doc comments from a class constant.

<comment>Return:</comment>
  <info>string|false</info>  The doc comment if it exists, otherwise <info>false</info>


id: ReflectionClassConstant::getModifiers
type: function
doc:
<comment>Description:</comment>
  Gets the class constant modifiers
  
  Returns a bitfield of the access modifiers for this class constant.

<comment>Return:</comment>
  <info>int</info>  A numeric representation of the modifiers. The actual meaning of these modifiers are
       described under predefined constants.

<comment>See Also:</comment>
   * Reflection::getModifierNames


id: ReflectionClassConstant::getName
type: function
doc:
<comment>Description:</comment>
  Get name of the constant

<comment>Return:</comment>
  <info>string</info>  Returns the constant's name.


id: ReflectionClassConstant::getValue
type: function
doc:
<comment>Description:</comment>
  Gets value
  
  Gets the class constant's value.

<comment>Return:</comment>
  <info>mixed</info>  The value of the class constant.


id: ReflectionClassConstant::isEnumCase
type: function
doc:
<comment>Description:</comment>
  Checks if class constant is an Enum case
  
  Checks if the class constant is an Enum case.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the class constant is an Enum case; <info>false</info> otherwise.

<comment>See Also:</comment>
   * <class>ReflectionEnum</class>


id: ReflectionClassConstant::isFinal
type: function
doc:
<comment>Description:</comment>
  Checks if class constant is final
  
  Checks if the class constant is final.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the class constant is final, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionClassConstant::isPublic
   * ReflectionClassConstant::isPrivate
   * ReflectionClassConstant::isProtected


id: ReflectionClassConstant::isPrivate
type: function
doc:
<comment>Description:</comment>
  Checks if class constant is private
  
  Checks if the class constant is private.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the class constant is private, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionClassConstant::isFinal
   * ReflectionClassConstant::isPublic
   * ReflectionClassConstant::isProtected


id: ReflectionClassConstant::isProtected
type: function
doc:
<comment>Description:</comment>
  Checks if class constant is protected
  
  Checks if the class constant is protected.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the class constant is protected, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionClassConstant::isFinal
   * ReflectionClassConstant::isPublic
   * ReflectionClassConstant::isPrivate


id: ReflectionClassConstant::isPublic
type: function
doc:
<comment>Description:</comment>
  Checks if class constant is public
  
  Checks if the class constant is public.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the class constant is public, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionClassConstant::isFinal
   * ReflectionClassConstant::isPrivate
   * ReflectionClassConstant::isProtected


id: ReflectionEnum
type: class
doc:
<comment>Description:</comment>
  The <class>ReflectionEnum</class> class reports information about an Enum.


id: ReflectionEnum::__construct
type: function
doc:
<comment>Description:</comment>
  Instantiates a ReflectionEnum object

<comment>Param:</comment>
  <info>object|string</info>  <strong>$objectOrClass</strong>  An enum instance or a name.


id: ReflectionEnum::getBackingType
type: function
doc:
<comment>Description:</comment>
  Gets the backing type of an Enum, if any
  
  If the enumeration is a Backed Enum, this method will return an instance of <class>ReflectionType</class> for the
  backing type of the Enum. If it is not a Backed Enum, it will return <return>null</return>.

<comment>Return:</comment>
  <info>ReflectionNamedType|null</info>  An instance of <class>ReflectionNamedType</class>, or <return>null</return> if the Enum has no backing
                            type.

<comment>See Also:</comment>
   * Enumerations
   * ReflectionEnum::isBacked


id: ReflectionEnum::getCase
type: function
doc:
<comment>Description:</comment>
  Returns a specific case of an Enum
  
  Returns the reflection object for a specific Enum case by name. If the requested case is not
  defined, a <class>ReflectionException</class> is thrown.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the case to retrieve.

<comment>Return:</comment>
  <info>ReflectionEnumUnitCase</info>  An instance of <class>ReflectionEnumUnitCase</class> or <class>ReflectionEnumBackedCase</class>, as
                          appropriate.

<comment>See Also:</comment>
   * Enumerations
   * ReflectionEnum::getCases
   * ReflectionEnum::hasCase
   * ReflectionEnum::isBacked


id: ReflectionEnum::getCases
type: function
doc:
<comment>Description:</comment>
  Returns a list of all cases on an Enum
  
  An Enum may contain zero or more cases. This method retrieves all defined cases, in lexical order
  (that is, the order they appear in the source code).

<comment>Return:</comment>
  <info>array</info>  An array of Enum reflection objects, one for each case in the Enum.  For a Unit Enum, they
         will all be instances of <class>ReflectionEnumUnitCase</class>. For a Backed Enum, they will all be
         instances of <class>ReflectionEnumBackedCase</class>.

<comment>See Also:</comment>
   * Enumerations
   * ReflectionEnum::getCase
   * ReflectionEnum::isBacked


id: ReflectionEnum::hasCase
type: function
doc:
<comment>Description:</comment>
  Checks for a case on an Enum
  
  Determines if a given case is defined on an Enum.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The case to check for.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the case is defined, <info>false</info> if not.

<comment>See Also:</comment>
   * Enumerations
   * ReflectionEnum::getCase
   * ReflectionEnum::getCases


id: ReflectionEnum::isBacked
type: function
doc:
<comment>Description:</comment>
  Determines if an Enum is a Backed Enum
  
  A Backed Enum is one that has a native backing scalar equivalent, either a <info>string</info> or an <info>int</info>.  Not
  all Enums are backed.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the Enum has a backing scalar, <info>false</info> if not.

<comment>See Also:</comment>
   * Enumerations
   * ReflectionEnum::getBackingType


id: ReflectionEnumBackedCase
type: class
doc:
<comment>Description:</comment>
  The <class>ReflectionEnumBackedCase</class> class reports information about an Enum backed case, which has a
  scalar equivalent.


id: ReflectionEnumBackedCase::__construct
type: function
doc:
<comment>Description:</comment>
  Instantiates a ReflectionEnumBackedCase object

<comment>Param:</comment>
  <info>object|string</info>  <strong>$class</strong>     An enum instance or a name.
  <info>string</info>         <strong>$constant</strong>  An enum constant name.


id: ReflectionEnumBackedCase::getBackingValue
type: function
doc:
<comment>Description:</comment>
  Gets the scalar value backing this Enum case
  
  Gets the scalar value backing this Enum case.

<comment>Return:</comment>
  <info>int|string</info>  The scalar equivalent of this enum case.

<comment>See Also:</comment>
   * Enumerations


id: ReflectionEnumUnitCase
type: class
doc:
<comment>Description:</comment>
  The <class>ReflectionEnumUnitCase</class> class reports information about an Enum unit case, which has no scalar
  equivalent.


id: ReflectionEnumUnitCase::__construct
type: function
doc:
<comment>Description:</comment>
  Instantiates a ReflectionEnumUnitCase object

<comment>Param:</comment>
  <info>object|string</info>  <strong>$class</strong>     An enum instance or a name.
  <info>string</info>         <strong>$constant</strong>  An enum constant name.


id: ReflectionEnumUnitCase::getEnum
type: function
doc:
<comment>Description:</comment>
  Gets the reflection of the enum of this case
  
  Gets the reflection of the enum of this case.

<comment>Return:</comment>
  <info>ReflectionEnum</info>  A <class>ReflectionEnum</class> instance describing the Enum this case belongs to.

<comment>See Also:</comment>
   * Enumerations


id: ReflectionEnumUnitCase::getValue
type: function
doc:
<comment>Description:</comment>
  Gets the enum case object described by this reflection object
  
  Returns the enum case object described by this reflection object.

<comment>Return:</comment>
  <info>UnitEnum</info>  The enum case object described by this reflection object.

<comment>See Also:</comment>
   * Enumerations


id: ReflectionExtension
type: class
doc:
<comment>Description:</comment>
  The <class>ReflectionExtension</class> class reports information about an extension.


id: ReflectionExtension::__clone
type: function
doc:
<comment>Description:</comment>
  Clones
  
  The clone method prevents an object from being cloned. Reflection objects  cannot be cloned.

<comment>Return:</comment>
  <info>void</info>  No value is returned, if called a fatal error will occur.

<comment>See Also:</comment>
   * ReflectionExtension::__construct
   * Object cloning


id: ReflectionExtension::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a ReflectionExtension
  
  Construct a <class>ReflectionExtension</class> <info>object</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the extension.

<comment>See Also:</comment>
   * ReflectionExtension::info
   * Constructors


id: ReflectionExtension::__toString
type: function
doc:
<comment>Description:</comment>
  To string
  
  Exports a reflected extension and returns it as a <info>string</info>. This  is the same as the
  ReflectionExtension::export with  the <strong>$return</strong> set to <info>true</info>.

<comment>Return:</comment>
  <info>string</info>  Returns the exported extension as a string, in the same way as the
          ReflectionExtension::export.

<comment>See Also:</comment>
   * ReflectionExtension::__construct
   * ReflectionExtension::export
   * __toString()


id: ReflectionExtension::export
type: function
doc:
<comment>Description:</comment>
  Export
  
  Exports a reflected extension. The output format of this function is  the same as the CLI argument
  <return>--re [extension]</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>    The reflection to export.
  <info>string</info>  <strong>$return</strong>  Setting to <info>true</info> will return the export,
                   as opposed to emitting it. Setting to <info>false</info> (the default) will do the opposite.

<comment>Return:</comment>
  <info>string</info>  If the <strong>$return</strong> parameter
          is set to <info>true</info>, then the export is returned as a <info>string</info>,
          otherwise <info>null</info> is returned.

<comment>See Also:</comment>
   * ReflectionExtension::info
   * ReflectionExtension::__toString


id: ReflectionExtension::getClassNames
type: function
doc:
<comment>Description:</comment>
  Gets class names
  
  Gets a listing of class names as defined in the extension.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of class names, as defined in the extension. If no classes are defined, an empty
         array is returned.

<comment>See Also:</comment>
   * ReflectionExtension::getClasses
   * ReflectionExtension::getName


id: ReflectionExtension::getClasses
type: function
doc:
<comment>Description:</comment>
  Gets classes
  
  Gets a list of classes from an extension.

<comment>Return:</comment>
  <info>array</info>  An array of <class>ReflectionClass</class> objects, one for each class within the extension. If no classes
         are defined, an empty array is returned.

<comment>See Also:</comment>
   * ReflectionExtension::getClassNames


id: ReflectionExtension::getConstants
type: function
doc:
<comment>Description:</comment>
  Gets constants
  
  Get defined constants from an extension.

<comment>Return:</comment>
  <info>array</info>  An associative array with constant names as keys.

<comment>See Also:</comment>
   * ReflectionExtension::getINIEntries


id: ReflectionExtension::getDependencies
type: function
doc:
<comment>Description:</comment>
  Gets dependencies
  
  Gets dependencies, by listing both required and conflicting dependencies.

<comment>Return:</comment>
  <info>array</info>  An associative <info>array</info> with dependencies as keys and either <return>Required</return>, <return>Optional</return>  or <return>Conflicts</return>
         as the values.

<comment>See Also:</comment>
   * ReflectionClass::getVersion


id: ReflectionExtension::getFunctions
type: function
doc:
<comment>Description:</comment>
  Gets extension functions
  
  Get defined functions from an extension.

<comment>Return:</comment>
  <info>array</info>  An associative array of <class>ReflectionFunction</class> 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.

<comment>See Also:</comment>
   * ReflectionExtension::getClasses
   * <strong>get_extension_funcs()</strong>


id: ReflectionExtension::getINIEntries
type: function
doc:
<comment>Description:</comment>
  Gets extension ini entries
  
  Get the ini entries for an extension.

<comment>Return:</comment>
  <info>array</info>  An associative <info>array</info> with the ini entries as keys, with their defined values as values.

<comment>See Also:</comment>
   * <strong>ini_get_all()</strong>
   * ReflectionExtension::getConstants


id: ReflectionExtension::getName
type: function
doc:
<comment>Description:</comment>
  Gets extension name
  
  Gets the extensions name.

<comment>Return:</comment>
  <info>string</info>  The extensions name.

<comment>See Also:</comment>
   * ReflectionExtension::getClassNames


id: ReflectionExtension::getVersion
type: function
doc:
<comment>Description:</comment>
  Gets extension version
  
  Gets the version of the extension.

<comment>Return:</comment>
  <info>string|null</info>  The version of the extension, or <info>null</info> if the extension has no version.

<comment>See Also:</comment>
   * ReflectionExtension::info


id: ReflectionExtension::info
type: function
doc:
<comment>Description:</comment>
  Print extension info
  
  Prints out the "<strong>phpinfo()</strong>" snippet for the given extension.

<comment>Return:</comment>
  <info>void</info>  Information about the extension.

<comment>See Also:</comment>
   * ReflectionExtension::getName
   * <strong>phpinfo()</strong>


id: ReflectionExtension::isPersistent
type: function
doc:
<comment>Description:</comment>
  Returns whether this extension is persistent
  
  Check whether the extension is persistent.
  
  An extension is persistent when it is loaded using php.ini. An extension is temporary, not
  persistent, when it is loaded with <strong>dl()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> for extensions loaded by <return>extension</return>, <info>false</info> otherwise.

<comment>See Also:</comment>
   * ReflectionExtension::isTemporary


id: ReflectionExtension::isTemporary
type: function
doc:
<comment>Description:</comment>
  Returns whether this extension is temporary
  
  Check whether the extension is temporary.
  
  An extension is temporary when it is loaded with <strong>dl()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> for extensions loaded by <strong>dl()</strong>, <info>false</info> otherwise.

<comment>See Also:</comment>
   * ReflectionExtension::isPersistent


id: ReflectionFiber::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a ReflectionFiber object
  
  Constructs a <class>ReflectionFiber</class> object.

<comment>Param:</comment>
  <info>Fiber</info>  <strong>$fiber</strong>  The <class>Fiber</class> to reflect.


id: ReflectionFiber::getCallable
type: function
doc:
<comment>Description:</comment>
  Gets the callable used to create the Fiber
  
  Returns the callable used to construct the <class>Fiber</class>. If the fiber has terminated, an <class>Error</class> is thrown.

<comment>Return:</comment>
  <info>callable</info>  The callable used to create the <class>Fiber</class>.


id: ReflectionFiber::getExecutingFile
type: function
doc:
<comment>Description:</comment>
  Get the file name of the current execution point
  
  Returns the full path and file name of the current execution point in the reflected <class>Fiber</class>. If the
  fiber has not been started or has terminated, an <class>Error</class> is thrown.

<comment>Return:</comment>
  <info>string</info>  The full path and file name of the reflected fiber.


id: ReflectionFiber::getExecutingLine
type: function
doc:
<comment>Description:</comment>
  Get the line number of the current execution point
  
  Returns the line number of the current execution point in the reflected <class>Fiber</class>. If the fiber has
  not been started or has terminated, an <class>Error</class> is thrown.

<comment>Return:</comment>
  <info>int</info>  The line number of the current execution point in the fiber.


id: ReflectionFiber::getFiber
type: function
doc:
<comment>Description:</comment>
  Get the reflected Fiber instance
  
  Returns the <class>Fiber</class> instance being reflected.

<comment>Return:</comment>
  <info>Fiber</info>  The <class>Fiber</class> instance being reflected.


id: ReflectionFiber::getTrace
type: function
doc:
<comment>Description:</comment>
  Get the backtrace of the current execution point
  
  Get the backtrace of the current execution point in the reflected <class>Fiber</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  The value of <strong>$options</strong> can be any of the following flags.
                 
                 Available optionsOptionDescription<info>DEBUG_BACKTRACE_PROVIDE_OBJECT</info> Default.
                 <info>DEBUG_BACKTRACE_IGNORE_ARGS</info> Don't include the argument information for functions in
                 the stack trace.

<comment>Return:</comment>
  <info>array</info>  The backtrace of the current execution point in the fiber.


id: ReflectionFunction
type: class
doc:
<comment>Description:</comment>
  The <class>ReflectionFunction</class> class reports information about a function.


id: ReflectionFunction::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a ReflectionFunction object
  
  Constructs a <class>ReflectionFunction</class> object.

<comment>Param:</comment>
  <info>Closure|string</info>  <strong>$function</strong>  The name of the function to reflect or a closure.

<comment>See Also:</comment>
   * ReflectionMethod::__construct
   * Constructors


id: ReflectionFunction::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of the ReflectionFunction object
  
  Get a human-readable description of the function, its parameters and return values.

<comment>Return:</comment>
  <info>string</info>  The string.

<comment>See Also:</comment>
   * ReflectionFunction::export
   * __toString()


id: ReflectionFunction::export
type: function
doc:
<comment>Description:</comment>
  Exports function
  
  Exports a Reflected function.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>    The reflection to export.
  <info>string</info>  <strong>$return</strong>  Setting to <info>true</info> will return the export,
                   as opposed to emitting it. Setting to <info>false</info> (the default) will do the opposite.

<comment>Return:</comment>
  <info>string</info>  If the <strong>$return</strong> parameter
          is set to <info>true</info>, then the export is returned as a <info>string</info>,
          otherwise <info>null</info> is returned.

<comment>See Also:</comment>
   * ReflectionFunction::invoke
   * ReflectionFunction::__toString


id: ReflectionFunction::getClosure
type: function
doc:
<comment>Description:</comment>
  Returns a dynamically created closure for the function
  
  Get a dynamically created closure for the function.

<comment>Return:</comment>
  <info>Closure</info>  Returns the newly created <class>Closure</class>.

<comment>See Also:</comment>
   * First class callable syntax


id: ReflectionFunction::invoke
type: function
doc:
<comment>Description:</comment>
  Invokes function
  
  Invokes a reflected function.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$args</strong>  The passed in argument list. It accepts a variable number of arguments which are
                passed to the function much like <strong>call_user_func()</strong> is.

<comment>Return:</comment>
  <info>mixed</info>  Returns the result of the invoked function call.

<comment>See Also:</comment>
   * ReflectionFunction::export
   * __invoke()
   * <strong>call_user_func()</strong>


id: ReflectionFunction::invokeArgs
type: function
doc:
<comment>Description:</comment>
  Invokes function args
  
  Invokes the function and pass its arguments as array.

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  The passed arguments to the function as an array, much like  <strong>call_user_func_array()</strong>
                works.

<comment>Return:</comment>
  <info>mixed</info>  Returns the result of the invoked function

<comment>See Also:</comment>
   * ReflectionFunction::invoke
   * ReflectionFunctionAbstract::getNumberOfParameters
   * __invoke()
   * <strong>call_user_func_array()</strong>


id: ReflectionFunction::isAnonymous
type: function
doc:
<comment>Description:</comment>
  Checks if a function is anonymous
  
  Checks if a function is anonymous.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the function is anonymous, otherwise <info>false</info>.

<comment>See Also:</comment>
   * Anonymous functions


id: ReflectionFunction::isDisabled
type: function
doc:
<comment>Description:</comment>
  Checks if function is disabled
  
  Checks if the function is disabled, via the  disable_functions directive.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if it's disable, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::isUserDefined
   * disable_functions directive


id: ReflectionFunctionAbstract
type: class
doc:
<comment>Description:</comment>
  A parent class to <class>ReflectionFunction</class>, read its description for details.


id: ReflectionFunctionAbstract::__clone
type: function
doc:
<comment>Description:</comment>
  Clones function
  
  Clones a function.

<comment>Return:</comment>
  <info>void</info>  No value is returned.

<comment>See Also:</comment>
   * Object cloning


id: ReflectionFunctionAbstract::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of the ReflectionFunctionAbstract object
  
  Get a human-readable description of the function, its parameters and return values.

<comment>Return:</comment>
  <info>void</info>  The string.

<comment>See Also:</comment>
   * ReflectionFunction::__toString
   * ReflectionMethod::__toString
   * __toString()


id: ReflectionFunctionAbstract::getAttributes
type: function
doc:
<comment>Description:</comment>
  Gets Attributes
  
  Returns all attributes declared on this function or method as an array of <info>ReflectionAttribute</info>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>   Filter the results to include only <class>ReflectionAttribute</class> instances for
                       attributes matching this class name.
  <info>int</info>          <strong>$flags</strong>  Flags for determining how to filter the results, if <strong>$name</strong> is provided.
                       
                       Default is <return>0</return> which will only return results for attributes that are of the
                       class <strong>$name</strong>.
                       
                       The only other option available, is to use
                       <info>ReflectionAttribute::IS_INSTANCEOF</info>, which will instead use <return>instanceof</return> for
                       filtering.

<comment>Return:</comment>
  <info>array</info>  Array of attributes, as a <class>ReflectionAttribute</class> object.

<comment>See Also:</comment>
   * ReflectionClass::getAttributes
   * ReflectionClassConstant::getAttributes
   * ReflectionParameter::getAttributes
   * ReflectionProperty::getAttributes


id: ReflectionFunctionAbstract::getClosureScopeClass
type: function
doc:
<comment>Description:</comment>
  Returns the scope class associated with the closure
  
  Get the class enclosing the closure declaration.

<comment>Return:</comment>
  <info>ReflectionClass|null</info>  Returns the class, or <info>null</info> if the function is not a closure or if there was
                        no enclosing class.


id: ReflectionFunctionAbstract::getClosureThis
type: function
doc:
<comment>Description:</comment>
  Returns this pointer bound to closure
  
  If the function is a non-static closure, get the object bound to $this inside the closure.

<comment>Return:</comment>
  <info>object|null</info>  Returns $this pointer. Returns <info>null</info> in case of an error.


id: ReflectionFunctionAbstract::getClosureUsedVariables
type: function
doc:
<comment>Description:</comment>
  Returns an array of the used variables in the Closure
  
  Returns an <info>array</info> of the used variables in the <class>Closure</class>.

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> of the used variables in the <class>Closure</class>.

<comment>See Also:</comment>
   * <strong>ReflectionFunctionAbstract::getClosureScopeClass()</strong>
   * <strong>ReflectionFunctionAbstract::getClosureThis()</strong>


id: ReflectionFunctionAbstract::getDocComment
type: function
doc:
<comment>Description:</comment>
  Gets doc comment
  
  Get a Doc comment from a function.

<comment>Return:</comment>
  <info>string|false</info>  The doc comment if it exists, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getStartLine


id: ReflectionFunctionAbstract::getEndLine
type: function
doc:
<comment>Description:</comment>
  Gets end line number
  
  Get the ending line number.

<comment>Return:</comment>
  <info>int|false</info>  The ending line number of the user defined function, or <info>false</info> if unknown.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getStartLine


id: ReflectionFunctionAbstract::getExtension
type: function
doc:
<comment>Description:</comment>
  Gets extension info
  
  Get the extension information of a function.

<comment>Return:</comment>
  <info>ReflectionExtension|null</info>  The extension information, as a <class>ReflectionExtension</class> object, or <info>null</info> for
                            user-defined functions.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getExtensionName


id: ReflectionFunctionAbstract::getExtensionName
type: function
doc:
<comment>Description:</comment>
  Gets extension name
  
  Get the extensions name.

<comment>Return:</comment>
  <info>string|false</info>  The name of the extension which defined the function, or <info>false</info> for user-defined
                functions.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getExtension


id: ReflectionFunctionAbstract::getFileName
type: function
doc:
<comment>Description:</comment>
  Gets file name
  
  Gets the file name from a user-defined function.

<comment>Return:</comment>
  <info>string|false</info>  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, <info>false</info> is returned.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getNamespaceName


id: ReflectionFunctionAbstract::getName
type: function
doc:
<comment>Description:</comment>
  Gets function name
  
  Get the name of the function.

<comment>Return:</comment>
  <info>string</info>  The name of the function.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getExtensionName
   * ReflectionFunctionAbstract::isUserDefined


id: ReflectionFunctionAbstract::getNamespaceName
type: function
doc:
<comment>Description:</comment>
  Gets namespace name
  
  Get the namespace name where the class is defined.

<comment>Return:</comment>
  <info>string</info>  The namespace name.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getFileName
   * namespaces


id: ReflectionFunctionAbstract::getNumberOfParameters
type: function
doc:
<comment>Description:</comment>
  Gets number of parameters
  
  Get the number of parameters that a function defines, both optional and required.

<comment>Return:</comment>
  <info>int</info>  The number of parameters.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getNumberOfRequiredParameters
   * <strong>func_num_args()</strong>


id: ReflectionFunctionAbstract::getNumberOfRequiredParameters
type: function
doc:
<comment>Description:</comment>
  Gets number of required parameters
  
  Get the number of required parameters that a function defines.

<comment>Return:</comment>
  <info>int</info>  The number of required parameters.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getNumberOfParameters


id: ReflectionFunctionAbstract::getParameters
type: function
doc:
<comment>Description:</comment>
  Gets parameters
  
  Get the parameters as an array of <info>ReflectionParameter</info>, in the order in which they are defined in
  the source.

<comment>Return:</comment>
  <info>array</info>  The parameters, as a <class>ReflectionParameter</class> object.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getNumberOfParameters
   * <strong>func_get_args()</strong>


id: ReflectionFunctionAbstract::getReturnType
type: function
doc:
<comment>Description:</comment>
  Gets the specified return type of a function
  
  Gets the specified return type of a reflected function.

<comment>Return:</comment>
  <info>ReflectionType|null</info>  Returns a <class>ReflectionType</class> object if a return type is specified, <info>null</info>
                       otherwise.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::hasReturnType
   * ReflectionType::__toString


id: ReflectionFunctionAbstract::getShortName
type: function
doc:
<comment>Description:</comment>
  Gets function short name
  
  Get the short name of the function (without the namespace part).

<comment>Return:</comment>
  <info>string</info>  The short name of the function.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getNamespaceName
   * namespaces


id: ReflectionFunctionAbstract::getStartLine
type: function
doc:
<comment>Description:</comment>
  Gets starting line number
  
  Gets the starting line number of the function.

<comment>Return:</comment>
  <info>int|false</info>  The starting line number, or <info>false</info> if unknown.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getEndLine


id: ReflectionFunctionAbstract::getStaticVariables
type: function
doc:
<comment>Description:</comment>
  Gets static variables
  
  Get the static variables.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of static variables.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getParameters


id: ReflectionFunctionAbstract::getTentativeReturnType
type: function
doc:
<comment>Description:</comment>
  Returns the tentative return type associated with the function
  
  Returns the tentative return type associated with the function.

<comment>Return:</comment>
  <info>ReflectionType|null</info>  Returns a <class>ReflectionType</class> object if a tentative return type is specified, <info>null</info>
                       otherwise.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getReturnType
   * ReflectionFunctionAbstract::hasTentativeReturnType
   * Return Type Compatibility with Internal Classes


id: ReflectionFunctionAbstract::hasReturnType
type: function
doc:
<comment>Description:</comment>
  Checks if the function has a specified return type
  
  Checks whether the reflected function has a return type specified.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the function is a specified return type, otherwise <info>false</info>.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getReturnType


id: ReflectionFunctionAbstract::hasTentativeReturnType
type: function
doc:
<comment>Description:</comment>
  Returns whether the function has a tentative return type
  
  Returns whether the function has a tentative return type.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the function has a tentative return type, otherwise <info>false</info>.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getTentativeReturnType
   * ReflectionFunctionAbstract::hasReturnType
   * Return Type Compatibility with Internal Classes


id: ReflectionFunctionAbstract::inNamespace
type: function
doc:
<comment>Description:</comment>
  Checks if function in namespace
  
  Checks whether a function is defined in a namespace.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if it's in a namespace, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getNamespaceName
   * namespaces


id: ReflectionFunctionAbstract::isClosure
type: function
doc:
<comment>Description:</comment>
  Checks if closure
  
  Checks whether the reflected function is a <class>Closure</class>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the function is a <class>Closure</class>, otherwise <info>false</info>.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::isGenerator


id: ReflectionFunctionAbstract::isDeprecated
type: function
doc:
<comment>Description:</comment>
  Checks if deprecated
  
  Checks whether the function is deprecated.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if it's deprecated, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getDocComment


id: ReflectionFunctionAbstract::isGenerator
type: function
doc:
<comment>Description:</comment>
  Returns whether this function is a generator

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the function is generator, <info>false</info> if it is not or <info>null</info> on failure.


id: ReflectionFunctionAbstract::isInternal
type: function
doc:
<comment>Description:</comment>
  Checks if is internal
  
  Checks whether the function is internal, as opposed to user-defined.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if it's internal, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::isUserDefined


id: ReflectionFunctionAbstract::isStatic
type: function
doc:
<comment>Description:</comment>
  Checks if the function is static
  
  Checks if the function is static.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the function is static, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionMethod::isFinal


id: ReflectionFunctionAbstract::isUserDefined
type: function
doc:
<comment>Description:</comment>
  Checks if user defined
  
  Checks whether the function is user-defined, as opposed to internal.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if it's user-defined, otherwise false;

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::isInternal


id: ReflectionFunctionAbstract::isVariadic
type: function
doc:
<comment>Description:</comment>
  Checks if the function is variadic
  
  Checks if the function is variadic.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the function is variadic, otherwise <info>false</info>.


id: ReflectionFunctionAbstract::returnsReference
type: function
doc:
<comment>Description:</comment>
  Checks if returns reference
  
  Checks whether the function returns a reference.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if it returns a reference, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::isClosure


id: ReflectionGenerator
type: class
doc:
<comment>Description:</comment>
  The <class>ReflectionGenerator</class> class reports information about a generator.


id: ReflectionGenerator::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a ReflectionGenerator object
  
  Constructs a <class>ReflectionGenerator</class> object.

<comment>Param:</comment>
  <info>Generator</info>  <strong>$generator</strong>  A generator object.

<comment>See Also:</comment>
   * ReflectionGenerator::getFunction
   * ReflectionGenerator::getExecutingLine
   * ReflectionGenerator::getExecutingFile


id: ReflectionGenerator::getExecutingFile
type: function
doc:
<comment>Description:</comment>
  Gets the file name of the currently executing generator
  
  Get the full path and file name of the currently executing generator.

<comment>Return:</comment>
  <info>string</info>  Returns the full path and file name of the currently executing generator.

<comment>See Also:</comment>
   * ReflectionGenerator::getExecutingLine
   * ReflectionGenerator::getExecutingGenerator


id: ReflectionGenerator::getExecutingGenerator
type: function
doc:
<comment>Description:</comment>
  Gets the executing Generator object
  
  Get the executing <class>Generator</class> object

<comment>Return:</comment>
  <info>Generator</info>  Returns the currently executing <class>Generator</class> object.

<comment>See Also:</comment>
   * ReflectionGenerator::getExecutingLine
   * ReflectionGenerator::getExecutingFile


id: ReflectionGenerator::getExecutingLine
type: function
doc:
<comment>Description:</comment>
  Gets the currently executing line of the generator
  
  Get the currently executing line number of the generator.

<comment>Return:</comment>
  <info>int</info>  Returns the line number of the currently executing statement in the generator.

<comment>See Also:</comment>
   * ReflectionGenerator::getExecutingGenerator
   * ReflectionGenerator::getExecutingFile


id: ReflectionGenerator::getFunction
type: function
doc:
<comment>Description:</comment>
  Gets the function name of the generator
  
  Enables the function name of the generator to be obtained by returning a class derived from
  <class>ReflectionFunctionAbstract</class>.

<comment>Return:</comment>
  <info>ReflectionFunctionAbstract</info>  Returns a <class>ReflectionFunctionAbstract</class> class. This will be
                              <class>ReflectionFunction</class> for functions, or <class>ReflectionMethod</class> for methods.

<comment>See Also:</comment>
   * ReflectionGenerator::getThis
   * ReflectionGenerator::getTrace


id: ReflectionGenerator::getThis
type: function
doc:
<comment>Description:</comment>
  Gets the $this value of the generator
  
  Get the <return>$this</return> value that the generator has access to.

<comment>Return:</comment>
  <info>object|null</info>  Returns the <return>$this</return> value, or <info>null</info> if the generator was not created in a class context.

<comment>See Also:</comment>
   * ReflectionGenerator::getFunction
   * ReflectionGenerator::getTrace


id: ReflectionGenerator::getTrace
type: function
doc:
<comment>Description:</comment>
  Gets the trace of the executing generator
  
  Get the trace of the currently executing generator.

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  The value of <strong>$options</strong> can be any of the following flags.
                 
                 Available optionsOptionDescription<info>DEBUG_BACKTRACE_PROVIDE_OBJECT</info> Default.
                 <info>DEBUG_BACKTRACE_IGNORE_ARGS</info> Don't include the argument information for functions in
                 the stack trace.

<comment>Return:</comment>
  <info>array</info>  Returns the trace of the currently executing generator.

<comment>See Also:</comment>
   * ReflectionGenerator::getFunction
   * ReflectionGenerator::getThis


id: ReflectionIntersectionType::getTypes
type: function
doc:
<comment>Description:</comment>
  Returns the types included in the intersection type
  
  Returns the reflections of types included in the intersection type.

<comment>Return:</comment>
  <info>array</info>  An array of <class>ReflectionType</class> objects.

<comment>See Also:</comment>
   * ReflectionType::allowsNull
   * ReflectionParameter::getType


id: ReflectionMethod
type: class
doc:
<comment>Description:</comment>
  The <class>ReflectionMethod</class> class reports information about a method.


id: ReflectionMethod::IS_ABSTRACT
type: constant
doc:
<comment>Description:</comment>
  Indicates that the method is abstract. Prior to PHP 7.4.0, the value was <return>2</return>.


id: ReflectionMethod::IS_FINAL
type: constant
doc:
<comment>Description:</comment>
  Indicates that the method is final. Prior to PHP 7.4.0, the value was <return>4</return>.


id: ReflectionMethod::IS_PRIVATE
type: constant
doc:
<comment>Description:</comment>
  Indicates that the method is private. Prior to PHP 7.4.0, the value was <return>1024</return>.


id: ReflectionMethod::IS_PROTECTED
type: constant
doc:
<comment>Description:</comment>
  Indicates that the method is protected. Prior to PHP 7.4.0, the value was <return>512</return>.


id: ReflectionMethod::IS_PUBLIC
type: constant
doc:
<comment>Description:</comment>
  Indicates that the method is public. Prior to PHP 7.4.0, the value was <return>256</return>.


id: ReflectionMethod::IS_STATIC
type: constant
doc:
<comment>Description:</comment>
  Indicates that the method is static. Prior to PHP 7.4.0, the value was <return>1</return>.


id: ReflectionMethod::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a ReflectionMethod
  
  Alternative signature (not supported with named arguments):
  
  Constructs a new <class>ReflectionMethod</class>.

<comment>Param:</comment>
  <info>object|string</info>  <strong>$objectOrMethod</strong>  Classname or object (instance of the class) that contains the
                                  method.
  <info>string</info>         <strong>$method</strong>          Name of the method.
  <info>string</info>         <strong>$classMethod</strong>     Class name and method name delimited by <return>::</return>.

<comment>See Also:</comment>
   * ReflectionMethod::export
   * Constructors


id: ReflectionMethod::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of the Reflection method object
  
  Returns the string representation of the Reflection method object.

<comment>Return:</comment>
  <info>string</info>  A string representation of this <class>ReflectionMethod</class> instance.

<comment>See Also:</comment>
   * ReflectionMethod::export
   * __toString()


id: ReflectionMethod::createFromMethodName
type: function
doc:
<comment>Description:</comment>
  Creates a new ReflectionMethod
  
  Creates a new <class>ReflectionMethod</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>  Class name and method name delimited by <return>::</return>.

<comment>Return:</comment>
  <info>static</info>  Returns a new <class>ReflectionMethod</class> on success.


id: ReflectionMethod::export
type: function
doc:
<comment>Description:</comment>
  Export a reflection method
  
  Exports a ReflectionMethod.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>   The class name.
  <info>string</info>  <strong>$name</strong>    The name of the method.
  <info>bool</info>    <strong>$return</strong>  Setting to <info>true</info> will return the export,
                   as opposed to emitting it. Setting to <info>false</info> (the default) will do the opposite.

<comment>Return:</comment>
  <info>string</info>  If the <strong>$return</strong> parameter
          is set to <info>true</info>, then the export is returned as a <info>string</info>,
          otherwise <info>null</info> is returned.

<comment>See Also:</comment>
   * ReflectionMethod::__construct
   * ReflectionMethod::__toString


id: ReflectionMethod::getClosure
type: function
doc:
<comment>Description:</comment>
  Returns a dynamically created closure for the method
  
  Create a closure which will call the method.

<comment>Param:</comment>
  <info>object|null</info>  <strong>$object</strong>  Forbidden for static methods, required for other methods.

<comment>Return:</comment>
  <info>Closure</info>  Returns the newly created <class>Closure</class>.

<comment>See Also:</comment>
   * First class callable syntax


id: ReflectionMethod::getDeclaringClass
type: function
doc:
<comment>Description:</comment>
  Gets declaring class for the reflected method
  
  Gets the declaring class for the reflected method.

<comment>Return:</comment>
  <info>ReflectionClass</info>  A <class>ReflectionClass</class> object of the class that the reflected method is part of.

<comment>See Also:</comment>
   * ReflectionMethod::isAbstract


id: ReflectionMethod::getModifiers
type: function
doc:
<comment>Description:</comment>
  Gets the method modifiers
  
  Returns a bitfield of the access modifiers for this method.

<comment>Return:</comment>
  <info>int</info>  A numeric representation of the modifiers. The actual meaning of these modifiers are
       described under predefined constants.

<comment>See Also:</comment>
   * Reflection::getModifierNames


id: ReflectionMethod::getPrototype
type: function
doc:
<comment>Description:</comment>
  Gets the method prototype (if there is one)
  
  Returns the methods prototype.

<comment>Return:</comment>
  <info>ReflectionMethod</info>  A <class>ReflectionMethod</class> instance of the method prototype.

<comment>See Also:</comment>
   * ReflectionMethod::getModifiers
   * ReflectionMethod::hasPrototype


id: ReflectionMethod::hasPrototype
type: function
doc:
<comment>Description:</comment>
  Returns whether a method has a prototype
  
  Returns whether a method has a prototype.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the method has a prototype, otherwise <info>false</info>.

<comment>See Also:</comment>
   * ReflectionMethod::getPrototype


id: ReflectionMethod::invoke
type: function
doc:
<comment>Description:</comment>
  Invoke
  
  Invokes a reflected method.

<comment>Param:</comment>
  <info>object|null</info>  <strong>$object</strong>  The object to invoke the method on. For static methods, pass <info>null</info> to this
                        parameter.
  <info>mixed</info>        <strong>$args</strong>    Zero or more parameters to be passed to the method. It accepts a variable
                        number of parameters which are passed to the method.

<comment>Return:</comment>
  <info>mixed</info>  Returns the method result.

<comment>See Also:</comment>
   * ReflectionMethod::invokeArgs
   * __invoke()
   * <strong>call_user_func()</strong>


id: ReflectionMethod::invokeArgs
type: function
doc:
<comment>Description:</comment>
  Invoke args
  
  Invokes the reflected method and pass its arguments as array.

<comment>Param:</comment>
  <info>object|null</info>  <strong>$object</strong>  The object to invoke the method on. In case of static methods, you can pass
                        <info>null</info> to this parameter.
  <info>array</info>        <strong>$args</strong>    The parameters to be passed to the function, as an <info>array</info>.

<comment>Return:</comment>
  <info>mixed</info>  Returns the method result.

<comment>See Also:</comment>
   * ReflectionMethod::invoke
   * __invoke()
   * <strong>call_user_func_array()</strong>


id: ReflectionMethod::isAbstract
type: function
doc:
<comment>Description:</comment>
  Checks if method is abstract
  
  Checks if the method is abstract.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the method is abstract, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionMethod::getDeclaringClass


id: ReflectionMethod::isConstructor
type: function
doc:
<comment>Description:</comment>
  Checks if method is a constructor
  
  Checks if the method is a constructor.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the method is a constructor, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionMethod::__construct
   * ReflectionMethod::isAbstract
   * ReflectionMethod::isDestructor


id: ReflectionMethod::isDestructor
type: function
doc:
<comment>Description:</comment>
  Checks if method is a destructor
  
  Checks if the method is a destructor.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the method is a destructor, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionMethod::isConstructor


id: ReflectionMethod::isFinal
type: function
doc:
<comment>Description:</comment>
  Checks if method is final
  
  Checks if the method is final.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the method is final, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionMethod::isStatic


id: ReflectionMethod::isPrivate
type: function
doc:
<comment>Description:</comment>
  Checks if method is private
  
  Checks if the method is private.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the method is private, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionMethod::isPublic


id: ReflectionMethod::isProtected
type: function
doc:
<comment>Description:</comment>
  Checks if method is protected
  
  Checks if the method is protected.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the method is protected, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionMethod::isPrivate


id: ReflectionMethod::isPublic
type: function
doc:
<comment>Description:</comment>
  Checks if method is public
  
  Checks if the method is public.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the method is public, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionMethod::isPrivate


id: ReflectionMethod::setAccessible
type: function
doc:
<comment>Description:</comment>
  Set method accessibility
  
  Enables invoking of a protected or private method via the ReflectionMethod::invoke method.
  
  As of PHP 8.1.0, calling this method has no effect; all methods are invokable by default.

<comment>Param:</comment>
  <info>bool</info>  <strong>$accessible</strong>  <info>true</info> to allow accessibility, or <info>false</info>.

<comment>Return:</comment>
  <info>void</info>  No value is returned.

<comment>See Also:</comment>
   * ReflectionMethod::isPrivate
   * ReflectionMethod::isProtected


id: ReflectionNamedType::getName
type: function
doc:
<comment>Description:</comment>
  Get the name of the type as a string

<comment>Return:</comment>
  <info>string</info>  Returns the name of the type being reflected.

<comment>See Also:</comment>
   * ReflectionType::__toString


id: ReflectionNamedType::isBuiltin
type: function
doc:
<comment>Description:</comment>
  Checks if it is a built-in type
  
  Checks if the type is a built-in type in PHP. A built-in type is any type that is not a class,
  interface, or trait.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if it's a built-in type, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionType::allowsNull
   * ReflectionType::__toString
   * ReflectionClass::isInternal
   * ReflectionParameter::getType


id: ReflectionObject
type: class
doc:
<comment>Description:</comment>
  The <class>ReflectionObject</class> class reports information about an <info>object</info>.


id: ReflectionObject::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a ReflectionObject
  
  Constructs a <class>ReflectionObject</class>.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  An object instance.

<comment>See Also:</comment>
   * ReflectionObject::export
   * Constructors


id: ReflectionObject::export
type: function
doc:
<comment>Description:</comment>
  Export
  
  Exports a reflection.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info>string</info>  <strong>$argument</strong>  The reflection to export.
  <info>bool</info>    <strong>$return</strong>    Setting to <info>true</info> will return the export,
                     as opposed to emitting it. Setting to <info>false</info> (the default) will do the opposite.

<comment>Return:</comment>
  <info>string</info>  If the <strong>$return</strong> parameter
          is set to <info>true</info>, then the export is returned as a <info>string</info>,
          otherwise <info>null</info> is returned.

<comment>See Also:</comment>
   * ReflectionObject::__construct


id: ReflectionParameter
type: class
doc:
<comment>Description:</comment>
  The <class>ReflectionParameter</class> class retrieves information about function's or method's parameters.
  
  To introspect function parameters, first create an instance of the <class>ReflectionFunction</class> or
  <class>ReflectionMethod</class> classes and then use their ReflectionFunctionAbstract::getParameters method to
  retrieve an array of parameters.


id: ReflectionParameter::__clone
type: function
doc:
<comment>Description:</comment>
  Clone
  
  Clones.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * ReflectionParameter::toString
   * Object cloning


id: ReflectionParameter::__construct
type: function
doc:
<comment>Description:</comment>
  Construct
  
  Constructs a <class>ReflectionParameter</class> instance.

<comment>Param:</comment>
  <info>string|array|object</info>  <strong>$function</strong>  The function to reflect parameters from.
  <info>int|string</info>           <strong>$param</strong>     Either an <info>int</info> specifying the position of the parameter (starting
                                  with zero), or the parameter name as <info>string</info>.

<comment>See Also:</comment>
   * ReflectionFunctionAbstract::getParameters
   * ReflectionFunction::__construct
   * ReflectionMethod::__construct
   * Constructors


id: ReflectionParameter::__toString
type: function
doc:
<comment>Description:</comment>
  To string
  
  Get a human-readable description of the parameter.

<comment>Return:</comment>
  <info>string</info>  The string.

<comment>See Also:</comment>
   * ReflectionFunction::__toString
   * ReflectionMethod::__toString
   * __toString()


id: ReflectionParameter::allowsNull
type: function
doc:
<comment>Description:</comment>
  Checks if null is allowed
  
  Checks whether the parameter allows <info>null</info>.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if <info>null</info> is allowed, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionParameter::isOptional


id: ReflectionParameter::canBePassedByValue
type: function
doc:
<comment>Description:</comment>
  Returns whether this parameter can be passed by value

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the parameter can be passed by value, <info>false</info> otherwise. Returns <info>null</info> in case
        of an error.


id: ReflectionParameter::export
type: function
doc:
<comment>Description:</comment>
  Exports
  
  Exports.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info>string</info>  <strong>$function</strong>   The function name.
  <info>string</info>  <strong>$parameter</strong>  The parameter name.
  <info>bool</info>    <strong>$return</strong>     Setting to <info>true</info> will return the export,
                      as opposed to emitting it. Setting to <info>false</info> (the default) will do the
                      opposite.

<comment>Return:</comment>
  <info>string</info>  The exported reflection.

<comment>See Also:</comment>
   * ReflectionParameter::__toString


id: ReflectionParameter::getAttributes
type: function
doc:
<comment>Description:</comment>
  Gets Attributes
  
  Returns all attributes declared on this parameter as an array of <info>ReflectionAttribute</info>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>   Filter the results to include only <class>ReflectionAttribute</class> instances for
                       attributes matching this class name.
  <info>int</info>          <strong>$flags</strong>  Flags for determining how to filter the results, if <strong>$name</strong> is provided.
                       
                       Default is <return>0</return> which will only return results for attributes that are of the
                       class <strong>$name</strong>.
                       
                       The only other option available, is to use
                       <info>ReflectionAttribute::IS_INSTANCEOF</info>, which will instead use <return>instanceof</return> for
                       filtering.

<comment>Return:</comment>
  <info>array</info>  Array of attributes, as a <class>ReflectionAttribute</class> object.

<comment>See Also:</comment>
   * ReflectionClass::getAttributes
   * ReflectionClassConstant::getAttributes
   * ReflectionFunctionAbstract::getAttributes
   * ReflectionProperty::getAttributes


id: ReflectionParameter::getClass
type: function
doc:
<comment>Description:</comment>
  Get a ReflectionClass object for the parameter being reflected or null
  
  Gets a <class>ReflectionClass</class> object for the parameter being reflected or <info>null</info>.
  
  As of PHP 8.0.0 this function is deprecated and not recommended. Instead, use
  ReflectionParameter::getType to get the <class>ReflectionType</class> of the parameter, then interrogate that
  object to determine the parameter type.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>ReflectionClass|null</info>  A <class>ReflectionClass</class> object, or <info>null</info> if no type is declared, or the declared
                        type is not a class or interface.

<comment>See Also:</comment>
   * ReflectionParameter::getDeclaringClass


id: ReflectionParameter::getDeclaringClass
type: function
doc:
<comment>Description:</comment>
  Gets declaring class
  
  Gets the declaring class.

<comment>Return:</comment>
  <info>ReflectionClass|null</info>  A <class>ReflectionClass</class> object or <info>null</info> if called on function.

<comment>See Also:</comment>
   * ReflectionParameter::getClass


id: ReflectionParameter::getDeclaringFunction
type: function
doc:
<comment>Description:</comment>
  Gets declaring function
  
  Gets the declaring function.

<comment>Return:</comment>
  <info>ReflectionFunctionAbstract</info>  A <class>ReflectionFunction</class> object.

<comment>See Also:</comment>
   * ReflectionParameter::getDeclaringClass


id: ReflectionParameter::getDefaultValue
type: function
doc:
<comment>Description:</comment>
  Gets default parameter value
  
  Gets the default value of the parameter for any user-defined or internal function or method. If
  the parameter is not optional a <class>ReflectionException</class> will be thrown.

<comment>Return:</comment>
  <info>mixed</info>  The parameters default value.

<comment>See Also:</comment>
   * ReflectionParameter::isOptional
   * ReflectionParameter::isDefaultValueAvailable
   * ReflectionParameter::getDefaultValueConstantName
   * ReflectionParameter::isPassedByReference


id: ReflectionParameter::getDefaultValueConstantName
type: function
doc:
<comment>Description:</comment>
  Returns the default value's constant name if default value is constant or null
  
  Returns the default value's constant name of the parameter of any user-defined or internal
  function or method, if default value is constant or null. If the parameter is not optional a
  <class>ReflectionException</class> will be thrown.

<comment>Return:</comment>
  <info>string|null</info>  Returns string on success or <info>null</info> on failure.

<comment>See Also:</comment>
   * ReflectionParameter::isOptional
   * ReflectionParameter::isDefaultValueConstant
   * ReflectionParameter::getDefaultValue


id: ReflectionParameter::getName
type: function
doc:
<comment>Description:</comment>
  Gets parameter name
  
  Gets the name of the parameter.

<comment>Return:</comment>
  <info>string</info>  The name of the reflected parameter.

<comment>See Also:</comment>
   * ReflectionParameter::getValue


id: ReflectionParameter::getPosition
type: function
doc:
<comment>Description:</comment>
  Gets parameter position
  
  Gets the position of the parameter.

<comment>Return:</comment>
  <info>int</info>  The position of the parameter, left to right, starting at position #0.

<comment>See Also:</comment>
   * ReflectionParameter::getName


id: ReflectionParameter::getType
type: function
doc:
<comment>Description:</comment>
  Gets a parameter's type
  
  Gets the associated type of a parameter.

<comment>Return:</comment>
  <info>ReflectionType|null</info>  Returns a <class>ReflectionType</class> object if a parameter type is specified, <info>null</info>
                       otherwise.

<comment>See Also:</comment>
   * ReflectionParameter::hasType
   * ReflectionType::__toString


id: ReflectionParameter::hasType
type: function
doc:
<comment>Description:</comment>
  Checks if parameter has a type
  
  Checks if the parameter has a type associated with it.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if a type is specified, <info>false</info> otherwise.

<comment>See Also:</comment>
   * ReflectionParameter::getType


id: ReflectionParameter::isArray
type: function
doc:
<comment>Description:</comment>
  Checks if parameter expects an array
  
  Checks if the parameter expects an array.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if an <info>array</info> is expected, <info>false</info> otherwise.

<comment>See Also:</comment>
   * ReflectionParameter::isOptional


id: ReflectionParameter::isCallable
type: function
doc:
<comment>Description:</comment>
  Returns whether parameter MUST be callable
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the parameter is <info>callable</info>, <info>false</info> if it is not or <info>null</info> on failure.


id: ReflectionParameter::isDefaultValueAvailable
type: function
doc:
<comment>Description:</comment>
  Checks if a default value is available
  
  Checks if a default value for the parameter is available.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if a default value is available, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionParameter::getDefaultValue
   * ReflectionParameter::isDefaultValueConstant
   * ReflectionParameter::getName


id: ReflectionParameter::isDefaultValueConstant
type: function
doc:
<comment>Description:</comment>
  Returns whether the default value of this parameter is a constant
  
  Returns whether the default value of this parameter is a constant.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the default value is constant, and <info>false</info> otherwise.

<comment>See Also:</comment>
   * ReflectionParameter::getDefaultValueConstantName
   * ReflectionParameter::isDefaultValueAvailable


id: ReflectionParameter::isOptional
type: function
doc:
<comment>Description:</comment>
  Checks if optional
  
  Checks if the parameter is optional.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the parameter is optional, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionParameter::getName


id: ReflectionParameter::isPassedByReference
type: function
doc:
<comment>Description:</comment>
  Checks if passed by reference
  
  Checks if the parameter is passed in by reference.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the parameter is passed in by reference, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionParameter::getName


id: ReflectionParameter::isVariadic
type: function
doc:
<comment>Description:</comment>
  Checks if the parameter is variadic
  
  Checks if the parameter was declared as a variadic parameter.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the parameter is variadic, otherwise <info>false</info>.


id: ReflectionProperty
type: class
doc:
<comment>Description:</comment>
  The <class>ReflectionProperty</class> class reports information about class properties.


id: ReflectionProperty::IS_PRIVATE
type: constant
doc:
<comment>Description:</comment>
  Indicates private properties. Prior to PHP 7.4.0, the value was <return>1024</return>.


id: ReflectionProperty::IS_PROTECTED
type: constant
doc:
<comment>Description:</comment>
  Indicates protected properties. Prior to PHP 7.4.0, the value was <return>512</return>.


id: ReflectionProperty::IS_PUBLIC
type: constant
doc:
<comment>Description:</comment>
  Indicates public properties. Prior to PHP 7.4.0, the value was <return>256</return>.


id: ReflectionProperty::IS_STATIC
type: constant
doc:
<comment>Description:</comment>
  Indicates static properties. Prior to PHP 7.4.0, the value was <return>1</return>.


id: ReflectionProperty::__clone
type: function
doc:
<comment>Description:</comment>
  Clone
  
  Clones.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * ReflectionProperty::export
   * Object cloning


id: ReflectionProperty::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a ReflectionProperty object

<comment>Param:</comment>
  <info>object|string</info>  <strong>$class</strong>     Either a string containing the name of the class to reflect, or an
                            object.
  <info>string</info>         <strong>$property</strong>  The name of the property being reflected.

<comment>See Also:</comment>
   * ReflectionProperty::getName
   * Constructors


id: ReflectionProperty::__toString
type: function
doc:
<comment>Description:</comment>
  To string
  
  Returns the string representation of the property.

<comment>Return:</comment>
  <info>string</info>  The string.

<comment>See Also:</comment>
   * __toString()


id: ReflectionProperty::export
type: function
doc:
<comment>Description:</comment>
  Export
  
  Exports a reflection.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info></info>        <strong>$argument</strong>  The reflection to export.
  <info>string</info>  <strong>$name</strong>      The property name.
  <info>bool</info>    <strong>$return</strong>    Setting to <info>true</info> will return the export,
                     as opposed to emitting it. Setting to <info>false</info> (the default) will do the opposite.

<comment>Return:</comment>
  <info>string</info>  

<comment>See Also:</comment>
   * ReflectionProperty::__toString


id: ReflectionProperty::getAttributes
type: function
doc:
<comment>Description:</comment>
  Gets Attributes
  
  Returns all attributes declared on this class property as an array of <info>ReflectionAttribute</info>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>   Filter the results to include only <class>ReflectionAttribute</class> instances for
                       attributes matching this class name.
  <info>int</info>          <strong>$flags</strong>  Flags for determining how to filter the results, if <strong>$name</strong> is provided.
                       
                       Default is <return>0</return> which will only return results for attributes that are of the
                       class <strong>$name</strong>.
                       
                       The only other option available, is to use
                       <info>ReflectionAttribute::IS_INSTANCEOF</info>, which will instead use <return>instanceof</return> for
                       filtering.

<comment>Return:</comment>
  <info>array</info>  Array of attributes, as a <class>ReflectionAttribute</class> object.

<comment>See Also:</comment>
   * ReflectionClass::getAttributes
   * ReflectionClassConstant::getAttributes
   * ReflectionFunctionAbstract::getAttributes
   * ReflectionParameter::getAttributes


id: ReflectionProperty::getDeclaringClass
type: function
doc:
<comment>Description:</comment>
  Gets declaring class
  
  Gets the declaring class.

<comment>Return:</comment>
  <info>ReflectionClass</info>  A <class>ReflectionClass</class> object.

<comment>See Also:</comment>
   * ReflectionProperty::getName


id: ReflectionProperty::getDefaultValue
type: function
doc:
<comment>Description:</comment>
  Returns the default value declared for a property
  
  Gets the implicit or explicitly declared default value for a property.

<comment>Return:</comment>
  <info>mixed</info>  The default value if the property has any default value (including <info>null</info>). If there is no
         default value, then <info>null</info> is returned. It is not possible to differentiate between a <info>null</info>
         default value and an unitialized typed property. Use ReflectionProperty::hasDefaultValue to
         detect the difference.

<comment>See Also:</comment>
   * ReflectionProperty::hasDefaultValue


id: ReflectionProperty::getDocComment
type: function
doc:
<comment>Description:</comment>
  Gets the property doc comment
  
  Gets the doc comment for a property.

<comment>Return:</comment>
  <info>string|false</info>  The doc comment if it exists, otherwise <info>false</info>.

<comment>See Also:</comment>
   * ReflectionProperty::getModifiers
   * ReflectionProperty::getName
   * ReflectionProperty::getValue


id: ReflectionProperty::getModifiers
type: function
doc:
<comment>Description:</comment>
  Gets the property modifiers
  
  Gets the modifiers.

<comment>Return:</comment>
  <info>int</info>  A numeric representation of the modifiers. The actual meaning of these modifiers are
       described under predefined constants.

<comment>See Also:</comment>
   * ReflectionProperty::isPrivate
   * Reflection::getModifierNames


id: ReflectionProperty::getName
type: function
doc:
<comment>Description:</comment>
  Gets property name
  
  Gets the properties name.

<comment>Return:</comment>
  <info>string</info>  The name of the reflected property.

<comment>See Also:</comment>
   * ReflectionProperty::getValue


id: ReflectionProperty::getType
type: function
doc:
<comment>Description:</comment>
  Gets a property's type
  
  Gets the associated type of a property.

<comment>Return:</comment>
  <info>ReflectionType|null</info>  Returns a <class>ReflectionType</class> if the property has a type, and <info>null</info> otherwise.

<comment>See Also:</comment>
   * ReflectionProperty::hasType
   * ReflectionProperty::isInitialized


id: ReflectionProperty::getValue
type: function
doc:
<comment>Description:</comment>
  Gets value
  
  Gets the property's value.

<comment>Param:</comment>
  <info>object|null</info>  <strong>$object</strong>  If the property is non-static an object must be provided to fetch the
                        property from. If you want to fetch the default property without providing
                        an object use ReflectionClass::getDefaultProperties instead.

<comment>Return:</comment>
  <info>mixed</info>  The current value of the property.

<comment>See Also:</comment>
   * ReflectionProperty::setValue
   * ReflectionProperty::setAccessible
   * ReflectionClass::getDefaultProperties
   * ReflectionClass::getStaticPropertyValue


id: ReflectionProperty::hasDefaultValue
type: function
doc:
<comment>Description:</comment>
  Checks if property has a default value declared
  
  Checks whether the property was declared with a default value, including an implicit <info>null</info> default
  value. Only returns <info>false</info> for typed properties without default value (or dynamic properties).

<comment>Return:</comment>
  <info>bool</info>  If the property has any default value (including <info>null</info>) <info>true</info> is returned; if the property is
        typed without a default value declared or is a dynamic property, <info>false</info> is returned.

<comment>See Also:</comment>
   * ReflectionProperty::getDefaultValue


id: ReflectionProperty::hasType
type: function
doc:
<comment>Description:</comment>
  Checks if property has a type
  
  Checks if the property has a type associated with it.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if a type is specified, <info>false</info> otherwise.

<comment>See Also:</comment>
   * ReflectionProperty::getType
   * ReflectionProperty::isInitialized


id: ReflectionProperty::isDefault
type: function
doc:
<comment>Description:</comment>
  Checks if property is a default property
  
  Checks whether the property was declared at compile-time, or whether the property was dynamically
  declared at run-time.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the property was declared at compile-time, or <info>false</info> if it was created at run-time.

<comment>See Also:</comment>
   * ReflectionProperty::getValue


id: ReflectionProperty::isInitialized
type: function
doc:
<comment>Description:</comment>
  Checks whether a property is initialized
  
  Checks whether a property is initialized.

<comment>Param:</comment>
  <info>object|null</info>  <strong>$object</strong>  If the property is non-static an object must be provided to fetch the
                        property from.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>false</info> for typed properties prior to initialization, and for properties that have
        been explicitly <strong>unset()</strong>. For all other properties <info>true</info> will be returned.

<comment>See Also:</comment>
   * ReflectionProperty::hasType


id: ReflectionProperty::isPrivate
type: function
doc:
<comment>Description:</comment>
  Checks if property is private
  
  Checks whether the property is private.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the property is private, <info>false</info> otherwise.

<comment>See Also:</comment>
   * ReflectionProperty::isPublic
   * ReflectionProperty::isProtected
   * ReflectionProperty::isReadOnly
   * ReflectionProperty::isStatic


id: ReflectionProperty::isPromoted
type: function
doc:
<comment>Description:</comment>
  Checks if property is promoted
  
  Checks whether the property is promoted

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the property is promoted, <info>false</info> otherwise.

<comment>See Also:</comment>
   * ReflectionProperty::isDefault
   * ReflectionProperty::isInitialized
   * ReflectionProperty::getValue


id: ReflectionProperty::isProtected
type: function
doc:
<comment>Description:</comment>
  Checks if property is protected
  
  Checks whether the property is protected.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the property is protected, <info>false</info> otherwise.

<comment>See Also:</comment>
   * ReflectionProperty::isPublic
   * ReflectionProperty::isPrivate
   * ReflectionProperty::isReadOnly
   * ReflectionProperty::isStatic


id: ReflectionProperty::isPublic
type: function
doc:
<comment>Description:</comment>
  Checks if property is public
  
  Checks whether the property is public.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the property is public, <info>false</info> otherwise.

<comment>See Also:</comment>
   * ReflectionProperty::isProtected
   * ReflectionProperty::isPrivate
   * ReflectionProperty::isReadOnly
   * ReflectionProperty::isStatic


id: ReflectionProperty::isReadOnly
type: function
doc:
<comment>Description:</comment>
  Checks if property is readonly
  
  Checks whether the property is readonly.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the property is readonly, <info>false</info> otherwise.

<comment>See Also:</comment>
   * ReflectionProperty::isPublic
   * ReflectionProperty::isProtected
   * ReflectionProperty::isPrivate
   * ReflectionProperty::isStatic


id: ReflectionProperty::isStatic
type: function
doc:
<comment>Description:</comment>
  Checks if property is static
  
  Checks whether the property is static.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the property is static, <info>false</info> otherwise.

<comment>See Also:</comment>
   * ReflectionProperty::isPublic
   * ReflectionProperty::isProtected
   * ReflectionProperty::isPrivate
   * ReflectionProperty::isReadOnly


id: ReflectionProperty::setAccessible
type: function
doc:
<comment>Description:</comment>
  Set property accessibility
  
  Enables access to a protected or private property via the ReflectionProperty::getValue and
  ReflectionProperty::setValue methods.
  
  As of PHP 8.1.0, calling this method has no effect; all properties are accessible by default.

<comment>Param:</comment>
  <info>bool</info>  <strong>$accessible</strong>  <info>true</info> to allow accessibility, or <info>false</info>.

<comment>Return:</comment>
  <info>void</info>  No value is returned.

<comment>See Also:</comment>
   * ReflectionProperty::isPrivate
   * ReflectionProperty::isProtected


id: ReflectionProperty::setValue
type: function
doc:
<comment>Description:</comment>
  Set property value
  
  Sets (changes) the property's value.
  
  As of PHP 8.3.0, calling this method with a single argument is deprecated, use
  ReflectionClass::setStaticPropertyValue instead.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  If the property is non-static an object must be provided to change the property
                   on. If the property is static a value of <info>null</info> must be to be provided.
  <info>mixed</info>   <strong>$value</strong>   The new value.

<comment>Return:</comment>
  <info>void</info>  No value is returned.

<comment>See Also:</comment>
   * ReflectionProperty::getValue
   * ReflectionProperty::setAccessible
   * ReflectionClass::setStaticPropertyValue


id: ReflectionReference
type: class
doc:
<comment>Description:</comment>
  The <class>ReflectionReference</class> class provides information about a reference.


id: ReflectionReference::fromArrayElement
type: function
doc:
<comment>Description:</comment>
  Create a ReflectionReference from an array element
  
  Creates a <class>ReflectionReference</class> from an array element.

<comment>Param:</comment>
  <info>array</info>       <strong>$array</strong>  The <info>array</info> which contains the potential reference.
  <info>int|string</info>  <strong>$key</strong>    The key; either an <info>int</info> or a <info>string</info>.

<comment>Return:</comment>
  <info>ReflectionReference|null</info>  Returns a <class>ReflectionReference </class> instance if <return>$array[$key]</return> is a reference,
                            or <info>null</info> otherwise.


id: ReflectionReference::getId
type: function
doc:
<comment>Description:</comment>
  Get unique ID of a reference
  
  Returns an ID which is unique for the reference for the lifetime of that reference. This ID can be
  used to compare references for equality, or to maintain a map of known references.

<comment>Return:</comment>
  <info>string</info>  Returns a <info>string</info> of unspecified format.


id: ReflectionType
type: class
doc:
<comment>Description:</comment>
  The <class>ReflectionType</class> class reports information about a function's parameter/return type or a class's
  property type. The Reflection extension declares the following subtypes: <class>ReflectionNamedType</class> (as
  of PHP 7.1.0)<class>ReflectionUnionType</class> (as of PHP 8.0.0)<class>ReflectionIntersectionType</class> (as of PHP 8.1.0)


id: ReflectionType::__toString
type: function
doc:
<comment>Description:</comment>
  To string
  
  Gets the parameter type name.

<comment>Return:</comment>
  <info>string</info>  Returns the type of the parameter.

<comment>See Also:</comment>
   * ReflectionNamedType::getName
   * ReflectionNamedType::isBuiltin
   * ReflectionType::allowsNull
   * ReflectionUnionType::getTypes
   * ReflectionParameter::getType


id: ReflectionType::allowsNull
type: function
doc:
<comment>Description:</comment>
  Checks if null is allowed
  
  Checks whether the parameter allows <info>null</info>.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if <info>null</info> is allowed, otherwise <info>false</info>

<comment>See Also:</comment>
   * ReflectionNamedType::isBuiltin
   * ReflectionType::__toString
   * ReflectionParameter::getType


id: ReflectionUnionType::getTypes
type: function
doc:
<comment>Description:</comment>
  Returns the types included in the union type
  
  Returns the reflections of types included in the union type.

<comment>Return:</comment>
  <info>array</info>  An array of <class>ReflectionType</class> objects.

<comment>See Also:</comment>
   * ReflectionType::allowsNull
   * ReflectionParameter::getType


id: ReflectionZendExtension::__clone
type: function
doc:
<comment>Description:</comment>
  Clone handler
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>void</info>  


id: ReflectionZendExtension::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a ReflectionZendExtension object
  
  Constructs a new <info>ReflectionZendExtension</info> object.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The extension name.


id: ReflectionZendExtension::__toString
type: function
doc:
<comment>Description:</comment>
  To string handler
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>string</info>  


id: ReflectionZendExtension::export
type: function
doc:
<comment>Description:</comment>
  Export
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>    
  <info>bool</info>    <strong>$return</strong>  

<comment>Return:</comment>
  <info>string</info>  

<comment>See Also:</comment>
   * ReflectionClassConstant::__toString


id: ReflectionZendExtension::getAuthor
type: function
doc:
<comment>Description:</comment>
  Gets author
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>string</info>  


id: ReflectionZendExtension::getCopyright
type: function
doc:
<comment>Description:</comment>
  Gets copyright
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>string</info>  


id: ReflectionZendExtension::getName
type: function
doc:
<comment>Description:</comment>
  Gets name
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>string</info>  


id: ReflectionZendExtension::getURL
type: function
doc:
<comment>Description:</comment>
  Gets URL
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>string</info>  


id: ReflectionZendExtension::getVersion
type: function
doc:
<comment>Description:</comment>
  Gets version
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>string</info>  


id: Reflector
type: class
doc:
<comment>Description:</comment>
  <class>Reflector</class> is an interface implemented by all exportable Reflection classes.


id: Reflector::export
type: function
doc:
<comment>Description:</comment>
  Exports
  
  Exports.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>string</info>  

<comment>See Also:</comment>
   * Reflection::__toString


id: RegexIterator
type: class
doc:
<comment>Description:</comment>
  This iterator can be used to filter another iterator based on a regular expression.


id: RegexIterator::ALL_MATCHES
type: constant
doc:
<comment>Description:</comment>
  Return all matches for the current entry  (see <strong>preg_match_all()</strong>).


id: RegexIterator::GET_MATCH
type: constant
doc:
<comment>Description:</comment>
  Return the first match for the current entry  (see <strong>preg_match()</strong>).


id: RegexIterator::MATCH
type: constant
doc:
<comment>Description:</comment>
  Only execute match (filter) for the current entry  (see <strong>preg_match()</strong>).


id: RegexIterator::REPLACE
type: constant
doc:
<comment>Description:</comment>
  Replace the current entry  (see <strong>preg_replace()</strong>; Not fully implemented yet)


id: RegexIterator::SPLIT
type: constant
doc:
<comment>Description:</comment>
  Returns the split values for the current entry (see <strong>preg_split()</strong>).


id: RegexIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new RegexIterator
  
  Create a new <class>RegexIterator</class> which filters an Iterator using a regular expression.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>   The iterator to apply this regex filter to.
  <info>string</info>    <strong>$pattern</strong>    The regular expression to match.
  <info>int</info>       <strong>$mode</strong>       Operation mode, see RegexIterator::setMode for a list of modes.
  <info>int</info>       <strong>$flags</strong>      Special flags, see RegexIterator::setFlags for a list of available flags.
  <info>int</info>       <strong>$pregFlags</strong>  The regular expression flags. These flags depend on the operation mode
                        parameter:
                        
                        <class>RegexIterator</class> preg_flagsoperation modeavailable
                        flagsRegexIterator::ALL_MATCHES See <strong>preg_match_all()</strong>.
                        RegexIterator::GET_MATCH See <strong>preg_match()</strong>. RegexIterator::MATCH See
                        <strong>preg_match()</strong>. RegexIterator::REPLACE none. RegexIterator::SPLIT See
                        <strong>preg_split()</strong>.

<comment>See Also:</comment>
   * <strong>preg_match()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_split()</strong>


id: RegexIterator::accept
type: function
doc:
<comment>Description:</comment>
  Get accept status
  
  Matches <return>(string)</return> RegexIterator::current (or RegexIterator::key if the RegexIterator::USE_KEY flag
  is set) against the regular expression.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if a match, <info>false</info> otherwise.

<comment>See Also:</comment>
   * RegexIterator constants
   * RegexIterator::setFlags


id: RegexIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  Get flags
  
  Returns the flags, see RegexIterator::setFlags for a list of available flags.

<comment>Return:</comment>
  <info>int</info>  Returns the set flags.

<comment>See Also:</comment>
   * RegexIterator::setFlags


id: RegexIterator::getMode
type: function
doc:
<comment>Description:</comment>
  Returns operation mode
  
  Returns the operation mode, see RegexIterator::setMode for the list of operation modes.

<comment>Return:</comment>
  <info>int</info>  Returns the operation mode.

<comment>See Also:</comment>
   * RegexIterator::setMode


id: RegexIterator::getPregFlags
type: function
doc:
<comment>Description:</comment>
  Returns the regular expression flags
  
  Returns the regular expression flags, see RegexIterator::__construct for the list of flags.

<comment>Return:</comment>
  <info>int</info>  Returns a bitmask of the regular expression flags.

<comment>See Also:</comment>
   * RegexIterator::setPregFlags


id: RegexIterator::getRegex
type: function
doc:
<comment>Description:</comment>
  Returns current regular expression
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>string</info>  


id: RegexIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  Sets the flags
  
  Sets the flags.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  The flags to set, a bitmask of class constants.
               
               The available flags are listed below. The actual meanings of these flags are
               described in the predefined constants. <class>RegexIterator</class>
               flagsvalueconstant1RegexIterator::USE_KEY

<comment>Return:</comment>
  <info>void</info>  No value is returned.

<comment>See Also:</comment>
   * RegexIterator::getFlags


id: RegexIterator::setMode
type: function
doc:
<comment>Description:</comment>
  Sets the operation mode
  
  Sets the operation mode.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  The operation mode.
              
              The available modes are listed below. The actual meanings of these modes are described
              in the predefined constants. <class>RegexIterator</class>
              modesvalueconstant0RegexIterator::MATCH1RegexIterator::GET_MATCH2RegexIterator::ALL_MATCHES3RegexIterator::SPLIT4RegexIterator::REPLACE

<comment>Return:</comment>
  <info>void</info>  No value is returned.

<comment>See Also:</comment>
   * RegexIterator::getMode


id: RegexIterator::setPregFlags
type: function
doc:
<comment>Description:</comment>
  Sets the regular expression flags
  
  Sets the regular expression flags.

<comment>Param:</comment>
  <info>int</info>  <strong>$pregFlags</strong>  The regular expression flags. See RegexIterator::__construct for an overview of
                   available flags.

<comment>Return:</comment>
  <info>void</info>  No value is returned.

<comment>See Also:</comment>
   * RegexIterator::getPregFlags


id: ResourceBundle
type: class
doc:
<comment>Description:</comment>
  Localized software products often require sets of data that are to be customized depending on
  current locale, e.g.: messages, labels, formatting patterns. ICU  resource mechanism allows to
  define sets of resources that the application can  load on locale basis, while accessing them in
  unified locale-independent fashion.
  
  This class implements access to ICU resource data files. These files are binary data arrays which
  ICU uses to store the localized data.
  
  ICU resource bundle can hold simple resources and complex resources. Complex resources are
  containers which can be either integer-indexed or string-indexed (just like PHP arrays). Simple
  resources can be of the following types: string, integer, binary data field  or integer array.
  
  <class>ResourceBundle</class> supports direct access to the data through array access pattern and iteration via
  foreach, as well as access via class methods. The result will be PHP value for simple resources
  and <class>ResourceBundle</class> object for complex ones. All resources are read-only.


id: ResourceBundle::__construct
type: function
doc:
<comment>Description:</comment>
  Create a resource bundle
  
  Object-oriented style (method)
  
  Procedural style
  
  Object-oriented style (constructor):
  
  Creates a resource bundle.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$locale</strong>    Locale for which the resources should be loaded (locale name, e.g. en_CA).
  <info>string|null</info>  <strong>$bundle</strong>    The directory where the data is stored or the name of the .dat file.
  <info>bool</info>         <strong>$fallback</strong>  Whether locale should match exactly or fallback to parent locale is
                          allowed.

<comment>Return:</comment>
  <info>ResourceBundle|null</info>  Returns <class>ResourceBundle</class> object or <info>null</info> on error.

<comment>See Also:</comment>
   * <strong>resourcebundle_get()</strong>


id: ResourceBundle::count
type: function
doc:
<comment>Description:</comment>
  Get number of elements in the bundle
  
  Object-oriented style
  
  Procedural style
  
  Get the number of elements in the bundle.

<comment>Param:</comment>
  <info>ResourceBundle</info>  <strong>$bundle</strong>  <class>ResourceBundle</class> object.

<comment>Return:</comment>
  <info>int</info>  Returns number of elements in the bundle.

<comment>See Also:</comment>
   * <strong>resourcebundle_get()</strong>


id: ResourceBundle::get
type: function
doc:
<comment>Description:</comment>
  Get data from the bundle
  
  Object-oriented style
  
  Procedural style
  
  Get the data from the bundle by index or string key.

<comment>Param:</comment>
  <info>ResourceBundle</info>  <strong>$bundle</strong>    <class>ResourceBundle</class> object.
  <info>string|int</info>      <strong>$index</strong>     Data index, must be string or integer.
  <info>bool</info>            <strong>$fallback</strong>  Whether locale should match exactly or fallback to parent locale is
                             allowed.

<comment>Return:</comment>
  <info>mixed</info>  Returns the data located at the index or <info>null</info> on error. Strings, integers and binary data
         strings are returned as corresponding PHP types, integer array is returned as PHP array.
         Complex types are returned as <class>ResourceBundle</class> object.

<comment>See Also:</comment>
   * <strong>resourcebundle_count()</strong>


id: ResourceBundle::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Get bundle's last error code
  
  Object-oriented style
  
  Procedural style
  
  Get error code from the last function performed by the bundle object.

<comment>Param:</comment>
  <info>ResourceBundle</info>  <strong>$bundle</strong>  <class>ResourceBundle</class> object.

<comment>Return:</comment>
  <info>int</info>  Returns error code from last bundle object call.

<comment>See Also:</comment>
   * <strong>resourcebundle_get_error_message()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: ResourceBundle::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Get bundle's last error message
  
  Object-oriented style
  
  Procedural style
  
  Get error message from the last function performed by the bundle object.

<comment>Param:</comment>
  <info>ResourceBundle</info>  <strong>$bundle</strong>  <class>ResourceBundle</class> object.

<comment>Return:</comment>
  <info>string</info>  Returns error message from last bundle object's call.

<comment>See Also:</comment>
   * <strong>resourcebundle_get_error_code()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: ResourceBundle::getLocales
type: function
doc:
<comment>Description:</comment>
  Get supported locales
  
  Object-oriented style
  
  Procedural style
  
  Get available locales from ResourceBundle name.

<comment>Param:</comment>
  <info>string</info>  <strong>$bundle</strong>  Path of ResourceBundle for which to get available locales, or empty string for
                   default locales list.

<comment>Return:</comment>
  <info>array|false</info>  Returns the list of locales supported by the bundle, or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>resourcebundle_get()</strong>


id: Result::__construct
type: function
doc:
<comment>Description:</comment>
  Result constructor
  
  An object that retrieves generated IDs, AUTO_INCREMENT values, and warnings, for a Result set.


id: Result::getAffectedItemsCount
type: function
doc:
<comment>Description:</comment>
  Get affected row count
  
  Get the number of affected rows by the previous operation.

<comment>Return:</comment>
  <info>int</info>  The number (as an integer) of affected rows.


id: Result::getAutoIncrementValue
type: function
doc:
<comment>Description:</comment>
  Get autoincremented value
  
  Get the last AUTO_INCREMENT value (last insert id).

<comment>Return:</comment>
  <info>int</info>  The last AUTO_INCREMENT value.


id: Result::getGeneratedIds
type: function
doc:
<comment>Description:</comment>
  Get generated ids
  
  Fetch the generated _id values from the last operation.  The unique _id field is generated by the
  MySQL server.

<comment>Return:</comment>
  <info>array</info>  An array of generated _id's from the last operation,  or an empty array if there are none.


id: Result::getWarnings
type: function
doc:
<comment>Description:</comment>
  Get warnings from last operation
  
  Retrieve warnings from the last Result operation.

<comment>Return:</comment>
  <info>array</info>  An array of Warning objects from the last operation. Each object defines an error
         'message', error 'level', and error 'code'. An empty array is returned if no errors are
         present.


id: Result::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  Get warning count from last operation
  
  Retrieve the number of warnings from the last Result operation.

<comment>Return:</comment>
  <info>int</info>  The number of warnings generated by the last operation.


id: ReturnTypeWillChange
type: class
doc:
<comment>Description:</comment>
  Most non-final internal methods now require overriding methods to declare a compatible return
  type, otherwise a deprecated notice is emitted during inheritance validation. In case the return
  type cannot be declared for an overriding method due to PHP cross-version compatibility concerns,
  a #[\ReturnTypeWillChange] attribute can be added to silence the deprecation notice.


id: ReturnTypeWillChange::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new ReturnTypeWillChange attribute instance
  
  Constructs a new <class>ReturnTypeWillChange</class> instance.


id: RowResult::__construct
type: function
doc:
<comment>Description:</comment>
  RowResult constructor
  
  Represents the result set obtained from querying the database.


id: RowResult::fetchAll
type: function
doc:
<comment>Description:</comment>
  Get all rows from result
  
  Fetch all the rows from the result set.

<comment>Return:</comment>
  <info>array</info>  A numerical array with all results from the query; each result is an associative array. An
         empty array is returned if no rows are present.


id: RowResult::fetchOne
type: function
doc:
<comment>Description:</comment>
  Get row from result
  
  Fetch one result from the result set.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>array</info>  The result, as an associative array  or <info>null</info> if no results are present.


id: RowResult::getColumnNames
type: function
doc:
<comment>Description:</comment>
  Get all column names
  
  Retrieve column names for columns present in the result set.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>array</info>  A numerical array of table columns names, or an empty array if the result set is empty.


id: RowResult::getColumns
type: function
doc:
<comment>Description:</comment>
  Get column metadata
  
  Retrieve column metadata for columns present in the result set.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>array</info>  An array of FieldMetadata objects representing the columns in the result,  or an empty
         array if the result set is empty.


id: RowResult::getColumnsCount
type: function
doc:
<comment>Description:</comment>
  Get column count
  
  Retrieve the column count for columns present in the result set.

<comment>Return:</comment>
  <info>int</info>  The number of columns; 0 if there are none.


id: RowResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  Get warnings from last operation
  
  Retrieve warnings from the last RowResult operation.

<comment>Return:</comment>
  <info>array</info>  An array of Warning objects from the last operation. Each object defines an error
         'message', error 'level', and error 'code'. An empty array is returned if no errors are
         present.


id: RowResult::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  Get warning count from last operation
  
  Retrieve the number of warnings from the last RowResult operation.

<comment>Return:</comment>
  <info>int</info>  The number of warnings generated by the last operation.


id: SCM_RIGHTS
type: constant
doc:
<comment>Description:</comment>
  Send or receive a set of  open  file  descriptors  from  another process.


id: SEASLOG_ALERT
type: constant
doc:
<comment>Description:</comment>
  "ALERT" - Action must be taken immediately.Immediate attention should be given to relevant
  personnel for emergency repairs.


id: SEASLOG_CRITICAL
type: constant
doc:
<comment>Description:</comment>
  "CRITICAL" - Critical conditions.Need to be repaired immediately, and the program component is
  unavailable.


id: SEASLOG_DEBUG
type: constant
doc:
<comment>Description:</comment>
  "DEBUG" - Detailed debug information.Fine-grained information events.


id: SEASLOG_ERROR
type: constant
doc:
<comment>Description:</comment>
  "ERROR" - Runtime errors that do not require immediate action but should typically.


id: SEASLOG_INFO
type: constant
doc:
<comment>Description:</comment>
  "INFO" - Interesting events.Emphasizes the running process of the application.


id: SEASLOG_NOTICE
type: constant
doc:
<comment>Description:</comment>
  "NOTICE" - Normal but significant events.Information that is more important than the INFO level
  during execution.


id: SEASLOG_WARNING
type: constant
doc:
<comment>Description:</comment>
  "WARNING" - Exceptional occurrences that are not errors.Potentially aberrant information that
  needs attention and needs to be repaired.


id: SID
type: constant
doc:
<comment>Description:</comment>
  Constant containing either the session name and session ID in the form of <return>"name=ID"</return> or empty
  string if session ID was set in an appropriate session cookie. This is the same id as the one
  returned by <strong>session_id()</strong>.


id: SIMDJSON_ERR_CAPACITY
type: constant
doc:
<comment>Description:</comment>
  This parser can't support a document that big. Thrown when parsing a JSON string that is over 4GiB
  long.


id: SIMDJSON_ERR_DEPTH_ERROR
type: constant
doc:
<comment>Description:</comment>
  The JSON document was too deep (too many nested objects and arrays)


id: SIMDJSON_ERR_INVALID_JSON_POINTER
type: constant
doc:
<comment>Description:</comment>
  Invalid JSON pointer syntax in <strong>simdjson_key_value()</strong> and other functions accepting a JSON pointer
  $key.


id: SIMDJSON_ERR_INVALID_PROPERTY
type: constant
doc:
<comment>Description:</comment>
  Invalid property name for an <class>stdClass</class> when decoding a value with <strong>simdjson_decode()</strong> or
  <strong>simdjson_key_value()</strong>


id: SIMDJSON_ERR_NUMBER_OUT_OF_RANGE
type: constant
doc:
<comment>Description:</comment>
  The JSON number is too large or too small to fit within the requested type. Note that the C
  simdjson library is a fork and this error is ignored to match php's handling of JSON numbers that
  are too large or too small.


id: SIMDJSON_ERR_TAPE_ERROR
type: constant
doc:
<comment>Description:</comment>
  The JSON document has an improper structure: missing or superfluous commas, braces, missing keys,
  etc.


id: SIMDJSON_ERR_UNESCAPED_CHARS
type: constant
doc:
<comment>Description:</comment>
  Within strings, some characters must be escaped, we found unescaped characters


id: SIMDJSON_ERR_UNEXPECTED_ERROR
type: constant
doc:
<comment>Description:</comment>
  Unexpected error, consider reporting this problem as you may have found a bug in the simdjson PECL


id: SIMDJSON_ERR_UNSUPPORTED_ARCHITECTURE
type: constant
doc:
<comment>Description:</comment>
  simdjson does not have an implementation supported by this CPU architecture (perhaps it's a
  non-SIMD CPU?).


id: SNMP::ERRNO_MULTIPLE_SET_QUERIES
type: constant
doc:
<comment>Description:</comment>
  Library will use multiple queries for SET operation requested. That means that operation will be
  performed in a non-transaction manner  and second or subsequent chunks may fail if a type or value
  failure will be faced.


id: SNMP::ERRNO_OID_NOT_INCREASING
type: constant
doc:
<comment>Description:</comment>
  SNMP agent faced OID cycling reporning non-increasing OID while executing (BULK)WALK command. This
  indicates bogus remote SNMP agent.


id: SNMP::ERRNO_OID_PARSING_ERROR
type: constant
doc:
<comment>Description:</comment>
  Library failed while parsing OID (and/or type for SET command). No queries has been made.


id: SNMP::__construct
type: function
doc:
<comment>Description:</comment>
  Creates SNMP instance representing session to remote SNMP agent
  
  The function description goes here.

<comment>Param:</comment>
  <info>int</info>     <strong>$version</strong>    SNMP protocol version: <info>SNMP::VERSION_1</info>,  <info>SNMP::VERSION_2C</info>,  <info>SNMP::VERSION_3</info>.
  <info>string</info>  <strong>$hostname</strong>   The SNMP agent. <strong>$hostname</strong> may be suffixed with optional SNMP agent port after
                      colon. IPv6 addresses must be enclosed in square brackets if used with port.
                      If FQDN is used for <strong>$hostname</strong> it will be resolved by php-snmp library, not by
                      Net-SNMP engine. Usage of IPv6 addresses when specifying FQDN may be forced by
                      enclosing FQDN into square brackets. Here it is some examples: IPv4 with
                      default port127.0.0.1IPv6 with default port::1 or [::1]IPv4 with specific
                      port127.0.0.1:1161IPv6 with specific port[::1]:1161FQDN with default
                      porthost.domainFQDN with specific porthost.domain:1161FQDN with default port,
                      force usage of IPv6 address[host.domain]FQDN with specific port, force usage
                      of IPv6 address[host.domain]:1161
  <info>string</info>  <strong>$community</strong>  The purpuse of <strong>$community</strong> is SNMP version specific:
  <info>int</info>     <strong>$timeout</strong>    The number of microseconds until the first timeout.
  <info>int</info>     <strong>$retries</strong>    The number of retries in case timeout occurs.

<comment>See Also:</comment>
   * SNMP::close


id: SNMP::close
type: function
doc:
<comment>Description:</comment>
  Close SNMP session
  
  Frees previously allocated SNMP session object.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * SNMP::__construct


id: SNMP::get
type: function
doc:
<comment>Description:</comment>
  Fetch an SNMP object
  
  Fetch an SNMP object specified in <strong>$objectId</strong> using GET query.

<comment>Param:</comment>
  <info>array|string</info>  <strong>$objectId</strong>      The SNMP object (OID) or objects
  <info>bool</info>          <strong>$preserveKeys</strong>  When <strong>$objectId</strong> is a array and <strong>$preserveKeys</strong> set to <info>true</info> keys in
                               results will be taken exactly as in <strong>$objectId</strong>, otherwise
                               SNMP::oid_output_format property is used to determinate the form of
                               keys.

<comment>Return:</comment>
  <info>mixed</info>  Returns SNMP objects requested as string or array depending on <strong>$objectId</strong> type or <info>false</info> on
         error.

<comment>See Also:</comment>
   * SNMP::getErrno
   * SNMP::getError


id: SNMP::getErrno
type: function
doc:
<comment>Description:</comment>
  Get last error code
  
  Returns error code from last SNMP request.

<comment>Return:</comment>
  <info>int</info>  Returns one of SNMP error code values described in constants chapter.

<comment>See Also:</comment>
   * SNMP::getError


id: SNMP::getError
type: function
doc:
<comment>Description:</comment>
  Get last error message
  
  Returns string with error from last SNMP request.

<comment>Return:</comment>
  <info>string</info>  String describing error from last SNMP request.

<comment>See Also:</comment>
   * SNMP::getErrno


id: SNMP::getnext
type: function
doc:
<comment>Description:</comment>
  Fetch an SNMP object which
    follows the given object id
    
  
  Fetch an SNMP object that follows specified <strong>$objectId</strong>.

<comment>Param:</comment>
  <info>array|string</info>  <strong>$objectId</strong>  The SNMP object (OID) or objects

<comment>Return:</comment>
  <info>mixed</info>  Returns SNMP objects requested as string or array depending on <strong>$objectId</strong> type or <info>false</info> on
         error.

<comment>See Also:</comment>
   * SNMP::getErrno
   * SNMP::getError


id: SNMP::set
type: function
doc:
<comment>Description:</comment>
  Set the value of an SNMP object
  
  Requests remote SNMP agent setting the value of one or more SNMP objects specified by the
  <strong>$objectId</strong>.

<comment>Param:</comment>
  <info>array|string</info>  <strong>$objectId</strong>  The SNMP object id
                           
                           When count of OIDs in object_id array is greater than max_oids object
                           property set method will have to use multiple queries to perform
                           requested value updates. In this case type and value checks are made
                           per-chunk so second or subsequent requests may fail due to wrong type or
                           value for OID requested. To mark this a warning is raised when count of
                           OIDs in object_id array is greater than max_oids.
  <info>array|string</info>  <strong>$type</strong>      The MIB defines the type of each object id. It has to be specified as a
                           single character from the below list.
                           
                           If <info>OPAQUE_SPECIAL_TYPES</info> was defined while compiling the SNMP library, the
                           following are also valid:
                           
                           Most of these will use the obvious corresponding ASN.1 type.  's', 'x',
                           'd' and 'b' are all different ways of specifying an OCTET STRING value,
                           and the 'u' unsigned type is also used for handling Gauge32 values.
                           
                           If the MIB-Files are loaded by into the MIB Tree with "snmp_read_mib" or
                           by specifying it in the libsnmp config, '=' may be used as the <strong>$type</strong>
                           parameter for all object ids as the type can then be automatically read
                           from the MIB.
                           
                           Note that there are two ways to set a variable of the type BITS like e.g.
                           "SYNTAX    BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5),
                           https(6)}":
                           
                           Using type "b" and a list of bit numbers. This method is not recommended
                           since GET query for the same OID would return e.g. 0xF8.
                           
                           Using type "x" and a hex number but without(!) the usual "0x" prefix.
                           
                           See examples section for more details.
  <info>array|string</info>  <strong>$value</strong>     The new value.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * SNMP::get


id: SNMP::setSecurity
type: function
doc:
<comment>Description:</comment>
  Configures security-related SNMPv3 session parameters
  
  setSecurity configures security-related session parameters used in SNMP protocol version 3

<comment>Param:</comment>
  <info>string</info>  <strong>$securityLevel</strong>      the security level (noAuthNoPriv|authNoPriv|authPriv)
  <info>string</info>  <strong>$authProtocol</strong>       the authentication protocol (MD5 or SHA)
  <info>string</info>  <strong>$authPassphrase</strong>     the authentication pass phrase
  <info>string</info>  <strong>$privacyProtocol</strong>    the privacy protocol (DES or AES)
  <info>string</info>  <strong>$privacyPassphrase</strong>  the privacy pass phrase
  <info>string</info>  <strong>$contextName</strong>        the context name
  <info>string</info>  <strong>$contextEngineId</strong>    the context EngineID

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * SNMP::__construct


id: SNMP::walk
type: function
doc:
<comment>Description:</comment>
  Fetch SNMP object subtree
  
  SNMP::walk is used to read SNMP subtree rooted at specified <strong>$objectId</strong>.

<comment>Param:</comment>
  <info>array|string</info>  <strong>$objectId</strong>        Root of subtree to be fetched
  <info>bool</info>          <strong>$suffixAsKey</strong>     By default full OID notation is used for keys in output array. If
                                 set to <info>true</info> subtree prefix will be removed from keys leaving only
                                 suffix of object_id.
  <info>int</info>           <strong>$nonRepeaters</strong>    This specifies the number of supplied variables that should not be
                                 iterated over. The default is to use this value from SNMP object.
  <info>int</info>           <strong>$maxRepetitions</strong>  This specifies the maximum number of iterations over the repeating
                                 variables. The default is to use this value from SNMP object.

<comment>Return:</comment>
  <info>array|false</info>  Returns an associative array of the SNMP object ids and their values on success or
               <info>false</info> on error. When a SNMP error occures SNMP::getErrno and SNMP::getError can be
               used for retrieving error number (specific to SNMP extension, see class constants)
               and error message respectively.

<comment>See Also:</comment>
   * SNMP::getErrno
   * SNMP::getError


id: SOAP_1_1
type: constant
doc:
<comment>Description:</comment>
  Specifies use of SOAP 1.1 when passed as <return>soap_version</return> option to SoapServer::__construct or
  SoapClient::__construct.


id: SOAP_1_2
type: constant
doc:
<comment>Description:</comment>
  Specifies use of SOAP 1.2 when passed as <return>soap_version</return> option to SoapServer::__construct or
  SoapClient::__construct.


id: SOAP_AUTHENTICATION_BASIC
type: constant
doc:
<comment>Description:</comment>
  Specifies use of HTTP Basic Authentication when passed as <return>authentication</return> option to
  SoapClient::__construct.


id: SOAP_AUTHENTICATION_DIGEST
type: constant
doc:
<comment>Description:</comment>
  Specifies use of HTTP Digest Authentication when passed as <return>authentication</return> option to
  SoapClient::__construct.


id: SOAP_COMPRESSION_ACCEPT
type: constant
doc:
<comment>Description:</comment>
  Specifies use of an "Accept-Encoding" header when passed as part of  the <strong>$compression</strong> option to
  SoapClient::__construct.


id: SOAP_COMPRESSION_DEFLATE
type: constant
doc:
<comment>Description:</comment>
  Specifies use of deflate compression when passed as part of  the <strong>$compression</strong> option to
  SoapClient::__construct.


id: SOAP_COMPRESSION_GZIP
type: constant
doc:
<comment>Description:</comment>
  Specifies use of gzip compression when passed as part of  the <strong>$compression</strong> option to
  SoapClient::__construct.


id: SOAP_DOCUMENT
type: constant
doc:
<comment>Description:</comment>
  Specifies use of document binding when passed as <return>style</return> option to SoapClient::__construct.


id: SOAP_ENCODED
type: constant
doc:
<comment>Description:</comment>
  Specifies use of SOAP Encoding when passed as <return>use</return> option to SoapClient::__construct.


id: SOAP_LITERAL
type: constant
doc:
<comment>Description:</comment>
  Specifies use of service-specific encoding when passed as <return>use</return> option to SoapClient::__construct.


id: SOAP_RPC
type: constant
doc:
<comment>Description:</comment>
  Specifies use of RPC-style binding when passed as <return>style</return> option to SoapClient::__construct.


id: SOAP_SINGLE_ELEMENT_ARRAYS
type: constant
doc:
<comment>Description:</comment>
  Used with the <strong>$features</strong> option to SoapClient::__construct.


id: SOAP_SSL_METHOD_SSLv2
type: constant
doc:
<comment>Description:</comment>
  Used with the deprecated <strong>$ssl_method</strong> option to SoapClient::__construct.


id: SORTCC
type: constant
doc:
<comment>Description:</comment>
  Sort criteria for <strong>imap_sort()</strong>: mailbox in first cc address


id: SORTFROM
type: constant
doc:
<comment>Description:</comment>
  Sort criteria for <strong>imap_sort()</strong>: mailbox in first From address


id: SORTSIZE
type: constant
doc:
<comment>Description:</comment>
  Sort criteria for <strong>imap_sort()</strong>: size of message in octets


id: SORTTO
type: constant
doc:
<comment>Description:</comment>
  Sort criteria for <strong>imap_sort()</strong>: mailbox in first To address


id: SORT_ASC
type: constant
doc:
<comment>Description:</comment>
  <info>SORT_ASC</info> is used with <strong>array_multisort()</strong> to sort in ascending order.


id: SORT_DESC
type: constant
doc:
<comment>Description:</comment>
  <info>SORT_DESC</info> is used with <strong>array_multisort()</strong> to sort in descending order.


id: SORT_FLAG_CASE
type: constant
doc:
<comment>Description:</comment>
  <info>SORT_FLAG_CASE</info> can be combined (bitwise OR) with <info>SORT_STRING</info> or <info>SORT_NATURAL</info> to sort strings
  case-insensitively. As of PHP 8.2.0, only ASCII case folding will be done.


id: SORT_LOCALE_STRING
type: constant
doc:
<comment>Description:</comment>
  <info>SORT_LOCALE_STRING</info> is used to compare items as strings, based on the current locale.


id: SORT_NATURAL
type: constant
doc:
<comment>Description:</comment>
  <info>SORT_NATURAL</info> is used to compare items as strings using "natural ordering" like <strong>natsort()</strong>.


id: SO_REUSEPORT
type: constant
doc:
<comment>Description:</comment>
  This constant is only available on platforms that support the <info>SO_REUSEPORT</info> socket option: this
  includes Linux, macOS and *BSD, but does not include Windows.


id: SQLITE3_ASSOC
type: constant
doc:
<comment>Description:</comment>
  Specifies that the Sqlite3Result::fetchArray method shall return an array indexed by column name
  as returned in the corresponding result set.


id: SQLITE3_BOTH
type: constant
doc:
<comment>Description:</comment>
  Specifies that the Sqlite3Result::fetchArray method shall return an array indexed by both column
  name and number as returned in the corresponding result set, starting at column 0.


id: SQLITE3_DETERMINISTIC
type: constant
doc:
<comment>Description:</comment>
  Specifies that a function created with <strong>SQLite3::createFunction()</strong> is deterministic, i.e. it always
  returns the same result given the same inputs within a single SQL statement. (Available as of PHP
  7.1.4.)


id: SQLITE3_NUM
type: constant
doc:
<comment>Description:</comment>
  Specifies that the Sqlite3Result::fetchArray method shall return an array indexed by column number
  as returned in the corresponding result set, starting at column 0.


id: SQLITE3_OPEN_CREATE
type: constant
doc:
<comment>Description:</comment>
  Specifies that the SQLite3 database be created if it does not already exist.


id: SQLITE3_OPEN_READWRITE
type: constant
doc:
<comment>Description:</comment>
  Specifies that the SQLite3 database be opened for reading and writing.


id: SQLSRV_CURSOR_BUFFERED
type: constant
doc:
<comment>Description:</comment>
  Creates a client-side cursor query. Lets you access rows in any order. For usage information, see
  Specifying a Cursor Type and Selecting Rows.


id: SQLSRV_CURSOR_DYNAMIC
type: constant
doc:
<comment>Description:</comment>
  Indicates a dynamic cursor. For usage information, see  Specifying a Cursor Type and Selecting
  Rows.


id: SQLSRV_CURSOR_FORWARD
type: constant
doc:
<comment>Description:</comment>
  Indicates a forward-only cursor. For usage information, see  Specifying a Cursor Type and
  Selecting Rows.


id: SQLSRV_CURSOR_KEYSET
type: constant
doc:
<comment>Description:</comment>
  Indicates a keyset cursor. For usage information, see  Specifying a Cursor Type and Selecting
  Rows.


id: SQLSRV_CURSOR_STATIC
type: constant
doc:
<comment>Description:</comment>
  Indicates a static cursor. For usage information, see  Specifying a Cursor Type and Selecting
  Rows.


id: SQLSRV_ENC_BINARY
type: constant
doc:
<comment>Description:</comment>
  Specifies that data is returned as a raw byte stream from the server without  performing encoding
  or translation. For usage information, see  How to: Specify PHP Types.


id: SQLSRV_ENC_CHAR
type: constant
doc:
<comment>Description:</comment>
  Data is returned in 8-bit characters as specified in the code page of the  Windows locale that is
  set on the system. Any multi-byte characters or characters  that do not map into this code page
  are substituted with a single byte question  mark (?) character. This is the default encoding. For
  usage information,  see How to: Specify PHP Types.


id: SQLSRV_ERR_ALL
type: constant
doc:
<comment>Description:</comment>
  Forces <strong>sqlsrv_errors()</strong> to return both errors and warings  when passed as a parameter (the default
  behavior).


id: SQLSRV_ERR_ERRORS
type: constant
doc:
<comment>Description:</comment>
  Forces <strong>sqlsrv_errors()</strong> to return errors only (no warnings)  when passed as a parameter.


id: SQLSRV_ERR_WARNINGS
type: constant
doc:
<comment>Description:</comment>
  Forces <strong>sqlsrv_errors()</strong> to return warnings only (no errors)  when passed as a parameter.


id: SQLSRV_FETCH_ASSOC
type: constant
doc:
<comment>Description:</comment>
  Forces <strong>sqlsrv_fetch_array()</strong> to return an associative  array when passed as a parameter.


id: SQLSRV_FETCH_BOTH
type: constant
doc:
<comment>Description:</comment>
  Forces <strong>sqlsrv_fetch_array()</strong> to return an array with both  associative and numeric keys when passed
  as a parameter (the default behavior).


id: SQLSRV_FETCH_NUMERIC
type: constant
doc:
<comment>Description:</comment>
  Forces <strong>sqlsrv_fetch_array()</strong> to return an array with  numeric when passed as a parameter.


id: SQLSRV_LOG_SEVERITY_ALL
type: constant
doc:
<comment>Description:</comment>
  Specifies that errors, warnings, and notices will be logged  when passed to <strong>sqlsrv_configure()</strong> as
  a parameter.


id: SQLSRV_LOG_SEVERITY_ERROR
type: constant
doc:
<comment>Description:</comment>
  Specifies that errors will be logged when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SEVERITY_NOTICE
type: constant
doc:
<comment>Description:</comment>
  Specifies that notices will be logged when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SEVERITY_WARNING
type: constant
doc:
<comment>Description:</comment>
  Specifies that warnings will be logged when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SYSTEM_ALL
type: constant
doc:
<comment>Description:</comment>
  Turns on logging of all subsystems when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SYSTEM_CONN
type: constant
doc:
<comment>Description:</comment>
  Turns on logging of connection activity when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SYSTEM_INIT
type: constant
doc:
<comment>Description:</comment>
  Turns on logging of initialization activity when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SYSTEM_OFF
type: constant
doc:
<comment>Description:</comment>
  Turns off logging of all subsystems when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SYSTEM_STMT
type: constant
doc:
<comment>Description:</comment>
  Turns on logging of statement activity when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_LOG_SYSTEM_UTIL
type: constant
doc:
<comment>Description:</comment>
  Turns on logging of error function activity when passed to  <strong>sqlsrv_configure()</strong> as a parameter.


id: SQLSRV_PARAM_IN
type: constant
doc:
<comment>Description:</comment>
  Indicates an input parameter when passed to <strong>sqlsrv_query()</strong>  or <strong>sqlsrv_prepare()</strong>.


id: SQLSRV_PARAM_INOUT
type: constant
doc:
<comment>Description:</comment>
  Indicates a bidirectional parameter when passed to <strong>sqlsrv_query()</strong>  or <strong>sqlsrv_prepare()</strong>.


id: SQLSRV_PARAM_OUT
type: constant
doc:
<comment>Description:</comment>
  Indicates an output parameter when passed to <strong>sqlsrv_query()</strong> or  <strong>sqlsrv_prepare()</strong>.


id: SQLSRV_PHPTYPE_DATETIME
type: constant
doc:
<comment>Description:</comment>
  Specifies a datetime PHP data type. For usage information, see  How to: Specify PHP Types.


id: SQLSRV_PHPTYPE_FLOAT
type: constant
doc:
<comment>Description:</comment>
  Specifies a float PHP data type. For usage information, see  How to: Specify PHP Types.


id: SQLSRV_PHPTYPE_INT
type: constant
doc:
<comment>Description:</comment>
  Specifies an integer PHP data type. For usage information, see  How to: Specify PHP Types.


id: SQLSRV_PHPTYPE_STREAM
type: constant
doc:
<comment>Description:</comment>
  Specifies a PHP stream. This constant works like a function and accepts an  encoding constant. See
  the SQLSRV_ENC_* constants. For usage information, see  How to: Specify PHP Types.


id: SQLSRV_PHPTYPE_STRING
type: constant
doc:
<comment>Description:</comment>
  Specifies a string PHP data type. This constant works like a function and  accepts an encoding
  constant. See the SQLSRV_ENC_* constants. For usage information,  see How to: Specify PHP Types.


id: SQLSRV_SCROLL_ABSOLUTE
type: constant
doc:
<comment>Description:</comment>
  Specifies which row to select in a result set. For usage information, see  Specifying a Cursor
  Type and Selecting Rows.


id: SQLSRV_SQLTYPE_BIGINT
type: constant
doc:
<comment>Description:</comment>
  Describes the bigint SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_BINARY
type: constant
doc:
<comment>Description:</comment>
  Describes the binary SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_BIT
type: constant
doc:
<comment>Description:</comment>
  Describes the bit SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_CHAR
type: constant
doc:
<comment>Description:</comment>
  Describes the char SQL Server data type. This constant works like a function  and accepts a
  parameter indicating the number characters. For usage information,  see How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_DATE
type: constant
doc:
<comment>Description:</comment>
  Describes the date SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_DATETIME
type: constant
doc:
<comment>Description:</comment>
  Describes the datetime SQL Server data type. For usage information, see  How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_DATETIME2
type: constant
doc:
<comment>Description:</comment>
  Describes the datetime2 SQL Server data type. For usage information, see  How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_DATETIMEOFFSET
type: constant
doc:
<comment>Description:</comment>
  Describes the datetimeoffset SQL Server data type. For usage information, see  How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_DECIMAL
type: constant
doc:
<comment>Description:</comment>
  Describes the decimal SQL Server data type. This constant works like a function  and accepts two
  parameters indicating (in order) precision and scale. For usage information,  see How to: Specify
  SQL Types.


id: SQLSRV_SQLTYPE_FLOAT
type: constant
doc:
<comment>Description:</comment>
  Describes the float SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_IMAGE
type: constant
doc:
<comment>Description:</comment>
  Describes the image SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_INT
type: constant
doc:
<comment>Description:</comment>
  Describes the int SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_MONEY
type: constant
doc:
<comment>Description:</comment>
  Describes the money SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_NCHAR
type: constant
doc:
<comment>Description:</comment>
  Describes the nchar SQL Server data type. This constant works like a function  and accepts a
  single parameter indicating the character count. For usage information,  see How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_NTEXT
type: constant
doc:
<comment>Description:</comment>
  Describes the ntext SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_NUMERIC
type: constant
doc:
<comment>Description:</comment>
  Describes the numeric SQL Server data type. This constant works like a function  and accepts two
  parameter indicating (in order) precision and scale. For usage  information, see How to: Specify
  SQL Types.


id: SQLSRV_SQLTYPE_NVARCHAR
type: constant
doc:
<comment>Description:</comment>
  Describes the nvarchar SQL Server data type. This constant works like a function  and accepts a
  single parameter indicating the character count. For usage  information, see How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_REAL
type: constant
doc:
<comment>Description:</comment>
  Describes the real SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_SMALLDATETIME
type: constant
doc:
<comment>Description:</comment>
  Describes the smalldatetime SQL Server data type. For usage information, see  How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_SMALLINT
type: constant
doc:
<comment>Description:</comment>
  Describes the smallint SQL Server data type. For usage information, see  How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_SMALLMONEY
type: constant
doc:
<comment>Description:</comment>
  Describes the smallmoney SQL Server data type. For usage information, see  How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_TEXT
type: constant
doc:
<comment>Description:</comment>
  Describes the text SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_TIME
type: constant
doc:
<comment>Description:</comment>
  Describes the time SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_TIMESTAMP
type: constant
doc:
<comment>Description:</comment>
  Describes the timestamp SQL Server data type. For usage information, see  How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_TINYINT
type: constant
doc:
<comment>Description:</comment>
  Describes the tinyint SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_UDT
type: constant
doc:
<comment>Description:</comment>
  Describes the UDT SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_UNIQUEIDENTIFIER
type: constant
doc:
<comment>Description:</comment>
  Describes the uniqueidentifier SQL Server data type. For usage information, see  How to: Specify
  SQL Types.


id: SQLSRV_SQLTYPE_VARBINARY
type: constant
doc:
<comment>Description:</comment>
  Describes the varbinary SQL Server data type. This constant works like a function  and accepts a
  single parameter indicating the byte count. For usage information,  see How to: Specify SQL Types.


id: SQLSRV_SQLTYPE_VARCHAR
type: constant
doc:
<comment>Description:</comment>
  Describes the varchar SQL Server data type. This constant works like a function  and accepts a
  single parameter indicating the character count. For usage information,  see How to: Specify SQL
  Types.


id: SQLSRV_SQLTYPE_XML
type: constant
doc:
<comment>Description:</comment>
  Describes the XML SQL Server data type. For usage information, see  How to: Specify SQL Types.


id: SQLSRV_TXN_READ_COMMITTED
type: constant
doc:
<comment>Description:</comment>
  Indicates a transaction isolation level of READ COMMITTED. This value is  used to set the
  TransactionIsolation level in the $connectionOptions array  passed to <strong>sqlsrv_connect()</strong>.


id: SQLSRV_TXN_READ_SERIALIZABLE
type: constant
doc:
<comment>Description:</comment>
  Indicates a transaction isolation level of SERIALIZABLE. This value is used  to set the
  TransactionIsolation level in the $connectionOptions array passed  to <strong>sqlsrv_connect()</strong>.


id: SQLSRV_TXN_READ_UNCOMMITTED
type: constant
doc:
<comment>Description:</comment>
  Indicates a transaction isolation level of READ UNCOMMITTED. This value is  used to set the
  TransactionIsolation level in the $connectionOptions array  passed to <strong>sqlsrv_connect()</strong>.


id: SQLSRV_TXN_REPEATABLE_READ
type: constant
doc:
<comment>Description:</comment>
  Indicates a transaction isolation level of REPEATABLE READ. This value is  used to set the
  TransactionIsolation level in the $connectionOptions array  passed to <strong>sqlsrv_connect()</strong>.


id: SQLSRV_TXN_SNAPSHOT
type: constant
doc:
<comment>Description:</comment>
  Indicates a transaction isolation level of SNAPSHOT. This value is used to  set the
  TransactionIsolation level in the $connectionOptions array passed  to <strong>sqlsrv_connect()</strong>.


id: SQLT_AFC
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_array_by_name()</strong> to bind arrays of CHAR.


id: SQLT_AVC
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_array_by_name()</strong> to bind arrays of VARCHAR2.


id: SQLT_CHR
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_array_by_name()</strong> to bind arrays of VARCHAR2. Also used with <strong>oci_bind_by_name()</strong>.


id: SQLT_FLT
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_array_by_name()</strong> to bind arrays of FLOAT.


id: SQLT_LBI
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_by_name()</strong> to bind LONG RAW values.


id: SQLT_LNG
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_by_name()</strong> to bind LONG values.


id: SQLT_LVC
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_array_by_name()</strong> to bind arrays of LONG VARCHAR.


id: SQLT_ODT
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_array_by_name()</strong> to bind arrays of LONG.


id: SQLT_STR
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_array_by_name()</strong> to bind arrays of STRING.


id: SQLT_VCS
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>oci_bind_array_by_name()</strong> to bind arrays of VARCHAR.


id: SQLite3::__construct
type: function
doc:
<comment>Description:</comment>
  Instantiates an SQLite3 object and opens an SQLite 3 database
    
  
  Instantiates an SQLite3 object and opens a connection to an SQLite 3 database. If the build
  includes encryption, then it will attempt to use the key.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>       Path to the SQLite database, or <return>:memory:</return> to use in-memory database. If
                          <strong>$filename</strong> is an empty string, then a private, temporary on-disk database
                          will be created. This private database will be automatically deleted as
                          soon as the database connection is closed.
  <info>int</info>     <strong>$flags</strong>          Optional flags used to determine how to open the SQLite database. By
                          default, open uses <return>SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE</return>.
                          <return>SQLITE3_OPEN_READONLY</return>: Open the database for reading only.
                          <return>SQLITE3_OPEN_READWRITE</return>: Open the database for reading and writing.
                          <return>SQLITE3_OPEN_CREATE</return>: Create the database if it does not exist.
                          
                          <return>SQLITE3_OPEN_READONLY</return>: Open the database for reading only.
                          
                          <return>SQLITE3_OPEN_READWRITE</return>: Open the database for reading and writing.
                          
                          <return>SQLITE3_OPEN_CREATE</return>: Create the database if it does not exist.
  <info>string</info>  <strong>$encryptionKey</strong>  An optional encryption key used when encrypting and decrypting an SQLite
                          database. If the SQLite encryption module is not installed, this parameter
                          will have no effect.


id: SQLite3::backup
type: function
doc:
<comment>Description:</comment>
  Backup one database to another database
  
  SQLite3::backup copies the contents of one database into another, overwriting the contents of the
  destination database. It is useful either for creating backups of databases or for copying
  in-memory databases to or from persistent files.
  
  As of SQLite 3.27.0 (2019-02-07), it is also possible to use the statement <return>VACUUM INTO 'file.db';</return>
  to backup the database to a new file.

<comment>Param:</comment>
  <info>SQLite3</info>  <strong>$destination</strong>          A database connection opened with SQLite3::open.
  <info>string</info>   <strong>$sourceDatabase</strong>       The database name is <return>"main"</return> for the main database, <return>"temp"</return> for the
                                 temporary database, or the name specified after the <return>AS</return> keyword in
                                 an <return>ATTACH</return> statement for an attached database.
  <info>string</info>   <strong>$destinationDatabase</strong>  Analogous to <strong>$sourceDatabase</strong> but for the <strong>$destination</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.


id: SQLite3::busyTimeout
type: function
doc:
<comment>Description:</comment>
  Sets the busy connection handler
  
  Sets a busy handler that will sleep until the database is not locked or the timeout is reached.

<comment>Param:</comment>
  <info>int</info>  <strong>$milliseconds</strong>  The milliseconds to sleep. Setting this value to a value less than or equal to
                      zero, will turn off an already set timeout handler.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success,  or <info>false</info> on failure.


id: SQLite3::changes
type: function
doc:
<comment>Description:</comment>
  Returns the number of database rows that were changed (or inserted or
     deleted) by the most recent SQL statement
    
  
  Returns the number of database rows that were changed (or inserted or deleted) by the most recent
  SQL statement.

<comment>Return:</comment>
  <info>int</info>  Returns an <info>int</info> value corresponding to the number of database rows changed (or inserted or
       deleted) by the most recent SQL statement.


id: SQLite3::close
type: function
doc:
<comment>Description:</comment>
  Closes the database connection
  
  Closes the database connection.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.


id: SQLite3::createAggregate
type: function
doc:
<comment>Description:</comment>
  Registers a PHP function for use as an SQL aggregate function
  
  Registers a PHP function or user-defined function for use as an SQL aggregate function for use
  within SQL statements.

<comment>Param:</comment>
  <info>string</info>    <strong>$name</strong>           Name of the SQL aggregate to be created or redefined.
  <info>callable</info>  <strong>$stepCallback</strong>   Callback function called for each row of the result set. Your PHP
                            function should accumulate the result and store it in the aggregation
                            context.
                            
                            This function need to be defined as:
                            <info>mixed</info>step<info>mixed</info><strong>$context</strong><info>int</info><strong>$rownumber</strong><info>mixed</info><strong>$value</strong><info>mixed</info><strong>$values</strong> <strong>$context</strong><info>null</info>
                            for the first row; on subsequent rows it will have the value that was
                            previously returned from the step function; you should use this to
                            maintain the aggregate state. <strong>$rownumber</strong> The current row number. <strong>$value</strong>
                            The first argument passed to the aggregate. <strong>$values</strong> Further arguments
                            passed to the aggregate.  The return value of this function will be used
                            as the <strong>$context</strong> argument in the next call of the step or finalize
                            functions.
                            
                            <info>null</info> for the first row; on subsequent rows it will have the value that
                            was previously returned from the step function; you should use this to
                            maintain the aggregate state.
                            
                            The current row number.
                            
                            The first argument passed to the aggregate.
                            
                            Further arguments passed to the aggregate.
  <info>mixed</info>     <strong>$context</strong>        <info>null</info> for the first row; on subsequent rows it will have the value that
                            was previously returned from the step function; you should use this to
                            maintain the aggregate state.
  <info>int</info>       <strong>$rownumber</strong>      The current row number.
  <info>mixed</info>     <strong>$value</strong>          The first argument passed to the aggregate.
  <info>mixed</info>     <strong>$values</strong>         Further arguments passed to the aggregate.
  <info>callable</info>  <strong>$finalCallback</strong>  Callback function to aggregate the "stepped" data from each row.  Once
                            all the rows have been processed, this function will be called and it
                            should then take the data from the aggregation context and return the
                            result. This callback function should return a type understood by SQLite
                            (i.e. scalar type).
                            
                            This function need to be defined as: <info>mixed</info>fini<info>mixed</info><strong>$context</strong><info>int</info><strong>$rownumber</strong>
                            <strong>$context</strong> Holds the return value from the very last call to the step
                            function. <strong>$rownumber</strong> Always <return>0</return>.  The return value of this function will
                            be used as the return value for the aggregate.
                            
                            Holds the return value from the very last call to the step function.
                            
                            Always <return>0</return>.
  <info>mixed</info>     <strong>$context</strong>        Holds the return value from the very last call to the step function.
  <info>int</info>       <strong>$rownumber</strong>      Always <return>0</return>.
  <info>int</info>       <strong>$argCount</strong>       The number of arguments that the SQL aggregate takes. If this parameter
                            is negative, then the SQL aggregate may take any number of arguments.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> upon successful creation of the aggregate,  or <info>false</info> on failure.


id: SQLite3::createCollation
type: function
doc:
<comment>Description:</comment>
  Registers a PHP function for use as an SQL collating function
  
  Registers a PHP function or user-defined function for use as a collating function within SQL
  statements.

<comment>Param:</comment>
  <info>string</info>    <strong>$name</strong>      Name of the SQL collating function to be created or redefined
  <info>callable</info>  <strong>$callback</strong>  The name of a PHP function or user-defined function to apply as a callback,
                       defining the behavior of the collation.  It should accept two values and
                       return as <strong>strcmp()</strong> does, i.e. it should return -1, 1, or 0 if the first
                       string sorts before, sorts after, or is equal to the second.
                       
                       This function need to be defined as: <info>int</info>collation<info>mixed</info><strong>$value1</strong><info>mixed</info><strong>$value2</strong>

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * The SQLite collation documentation: http://sqlite.org/datatype3.html#collation


id: SQLite3::createFunction
type: function
doc:
<comment>Description:</comment>
  Registers a PHP function for use as an SQL scalar function
  
  Registers a PHP function or user-defined function for use as an SQL scalar function for use within
  SQL statements.

<comment>Param:</comment>
  <info>string</info>    <strong>$name</strong>      Name of the SQL function to be created or redefined.
  <info>callable</info>  <strong>$callback</strong>  The name of a PHP function or user-defined function to apply as a callback,
                       defining the behavior of the SQL function.
                       
                       This function need to be defined as: <info>mixed</info>callback<info>mixed</info><strong>$value</strong><info>mixed</info><strong>$values</strong>
                       <strong>$value</strong> The first argument passed to the SQL function. <strong>$values</strong> Further
                       arguments passed to the SQL function.
                       
                       The first argument passed to the SQL function.
                       
                       Further arguments passed to the SQL function.
  <info>mixed</info>     <strong>$value</strong>     The first argument passed to the SQL function.
  <info>mixed</info>     <strong>$values</strong>    Further arguments passed to the SQL function.
  <info>int</info>       <strong>$argCount</strong>  The number of arguments that the SQL function takes. If this parameter is <return>-1</return>,
                       then the SQL function may take any number of arguments.
  <info>int</info>       <strong>$flags</strong>     A bitwise conjunction of flags. Currently, only <info>SQLITE3_DETERMINISTIC</info> is
                       supported, which specifies that the function always returns the same result
                       given the same inputs within a single SQL statement.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> upon successful creation of the function, <info>false</info> on failure.


id: SQLite3::enableExceptions
type: function
doc:
<comment>Description:</comment>
  Enable throwing exceptions
    
  
  Controls whether the <class>SQLite3</class> instance will throw exceptions or warnings on error.

<comment>Param:</comment>
  <info>bool</info>  <strong>$enable</strong>  When <info>true</info>, the <class>SQLite3</class> instance, and  <class>SQLite3Stmt</class> and <class>SQLite3Result</class> instances
                 derived from it, will throw exceptions on error.
                 
                 When <info>false</info>, the <class>SQLite3</class> instance, and <class>SQLite3Stmt</class> and <class>SQLite3Result</class> instances
                 derived from it, will raise warnings on error.
                 
                 For either mode, the error code and message, if any, will be available via
                 SQLite3::lastErrorCode and SQLite3::lastErrorMsg respectively.

<comment>Return:</comment>
  <info>bool</info>  Returns the old value; <info>true</info> if exceptions were enabled, <info>false</info> otherwise.


id: SQLite3::escapeString
type: function
doc:
<comment>Description:</comment>
  Returns a string that has been properly escaped
  
  Returns a string that has been properly escaped for safe inclusion in an SQL statement.
  
  This function
  is not (yet) binary safe!
  
  To properly handle BLOB fields which may contain NUL characters, use <strong>SQLite3Stmt::bindParam()</strong>
  instead.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The string to be escaped.

<comment>Return:</comment>
  <info>string</info>  Returns a properly escaped string that may be used safely in an SQL statement.


id: SQLite3::exec
type: function
doc:
<comment>Description:</comment>
  Executes a result-less query against a given database
  
  Executes a result-less query against a given database.
  
  SQLite3 may need to create temporary files during the execution of queries, so the respective
  directories may have to be writable.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The SQL query to execute (typically an INSERT, UPDATE, or DELETE query).

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the query succeeded, <info>false</info> on failure.


id: SQLite3::lastErrorCode
type: function
doc:
<comment>Description:</comment>
  Returns the numeric result code of the most recent failed SQLite request
    
  
  Returns the numeric result code of the most recent failed SQLite request.

<comment>Return:</comment>
  <info>int</info>  Returns an integer value representing the numeric result code of the most recent failed
       SQLite request.


id: SQLite3::lastErrorMsg
type: function
doc:
<comment>Description:</comment>
  Returns English text describing the most recent failed SQLite request
    
  
  Returns English text describing the most recent failed SQLite request.

<comment>Return:</comment>
  <info>string</info>  Returns an English string describing the most recent failed SQLite request.


id: SQLite3::lastInsertRowID
type: function
doc:
<comment>Description:</comment>
  Returns the row ID of the most recent INSERT into the database
  
  Returns the row ID of the most recent INSERT into the database.

<comment>Return:</comment>
  <info>int</info>  Returns the row ID of the most recent INSERT into the database. If no successful INSERTs into
       rowid tables have ever occurred on this database connection, then SQLite3::lastInsertRowID
       returns <return>0</return>.


id: SQLite3::loadExtension
type: function
doc:
<comment>Description:</comment>
  Attempts to load an SQLite extension library
  
  Attempts to load an SQLite extension library.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the library to load. The library must be located in the directory
                 specified in the configure option sqlite3.extension_dir.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the extension is successfully loaded, <info>false</info> on failure.


id: SQLite3::open
type: function
doc:
<comment>Description:</comment>
  Opens an SQLite database
  
  Opens an SQLite 3 Database. If the build includes encryption, then it will attempt to use the key.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>       Path to the SQLite database, or <return>:memory:</return> to use in-memory database.
  <info>int</info>     <strong>$flags</strong>          Optional flags used to determine how to open the SQLite database. By
                          default, open uses <return>SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE</return>.
                          <return>SQLITE3_OPEN_READONLY</return>: Open the database for reading only.
                          <return>SQLITE3_OPEN_READWRITE</return>: Open the database for reading and writing.
                          <return>SQLITE3_OPEN_CREATE</return>: Create the database if it does not exist.
                          
                          <return>SQLITE3_OPEN_READONLY</return>: Open the database for reading only.
                          
                          <return>SQLITE3_OPEN_READWRITE</return>: Open the database for reading and writing.
                          
                          <return>SQLITE3_OPEN_CREATE</return>: Create the database if it does not exist.
  <info>string</info>  <strong>$encryptionKey</strong>  An optional encryption key used when encrypting and decrypting an SQLite
                          database. If the SQLite encryption module is not installed, this parameter
                          will have no effect.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: SQLite3::openBlob
type: function
doc:
<comment>Description:</comment>
  Opens a stream resource to read a BLOB
  
  Opens a stream resource to read or write a BLOB, which would be selected by:
  
  SELECT <strong>$column</strong> FROM <strong>$database</strong>.<strong>$table</strong> WHERE rowid = <strong>$rowid</strong>
  
  It is not possible to change the size of a BLOB by writing to the stream. Instead, an UPDATE
  statement has to be executed, possibly using SQLite's zeroblob() function to set the desired BLOB
  size.

<comment>Param:</comment>
  <info>string</info>  <strong>$table</strong>     The table name.
  <info>string</info>  <strong>$column</strong>    The column name.
  <info>int</info>     <strong>$rowid</strong>     The row ID.
  <info>string</info>  <strong>$database</strong>  The symbolic name of the DB
  <info>int</info>     <strong>$flags</strong>     Either <info>SQLITE3_OPEN_READONLY</info> or  <info>SQLITE3_OPEN_READWRITE</info> to open the stream for
                     reading only, or for reading and writing, respectively.

<comment>Return:</comment>
  <info>resource|false</info>  Returns a stream resource,  or <info>false</info> on failure.


id: SQLite3::prepare
type: function
doc:
<comment>Description:</comment>
  Prepares an SQL statement for execution
  
  Prepares an SQL statement for execution and returns an <class>SQLite3Stmt</class> object.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The SQL query to prepare.

<comment>Return:</comment>
  <info>SQLite3Stmt|false</info>  Returns an <class>SQLite3Stmt</class> object on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * SQLite3Stmt::paramCount
   * SQLite3Stmt::bindValue
   * SQLite3Stmt::bindParam


id: SQLite3::query
type: function
doc:
<comment>Description:</comment>
  Executes an SQL query
  
  Executes an SQL query, returning an <class>SQLite3Result</class> object. If the query does not yield a result
  (such as DML statements) the returned <class>SQLite3Result</class> object is not really usable. Use SQLite3::exec
  for such queries instead.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The SQL query to execute.

<comment>Return:</comment>
  <info>SQLite3Result|false</info>  Returns an <class>SQLite3Result</class> object,  or <info>false</info> on failure.


id: SQLite3::querySingle
type: function
doc:
<comment>Description:</comment>
  Executes a query and returns a single result
  
  Executes a query and returns a single result.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>      The SQL query to execute.
  <info>bool</info>    <strong>$entireRow</strong>  By default, <strong>querySingle()</strong> returns the value of the first column returned by
                      the query. If <strong>$entireRow</strong> is <info>true</info>, then it returns an array of the entire first
                      row.

<comment>Return:</comment>
  <info>mixed</info>  Returns the value of the first column of results or an array of the entire first row (if
         <strong>$entireRow</strong> is <info>true</info>).
         
         If the query is valid but no results are returned, then <info>null</info> will be returned if <strong>$entireRow</strong>
         is <info>false</info>, otherwise an empty array is returned.
         
         Invalid or failing queries will return <info>false</info>.


id: SQLite3::setAuthorizer
type: function
doc:
<comment>Description:</comment>
  Configures a callback to be used as an authorizer to limit what a statement can do
  
  Sets a callback that will be called by SQLite every time an action is performed (reading,
  deleting, updating, etc.). This is used when preparing a SQL statement from an untrusted source to
  ensure that the SQL statements do not try to access data they are not allowed to see, or that they
  do not try to execute malicious statements that damage the database. For example, an application
  may allow a user to enter arbitrary SQL queries for evaluation by a database. But the application
  does not want the user to be able to make arbitrary changes to the database. An authorizer could
  then be put in place while the user-entered SQL is being prepared that disallows everything except
  SELECT statements.
  
  The authorizer callback may be called multiple times for each statement prepared by SQLite. A
  <return>SELECT</return> or <return>UPDATE</return> query will call the authorizer for every column that would be read or updated.
  
  The authorizer is called with up to five parameters. The first parameter is always given, and is
  an <info>int</info> (action code) matching a constant from <return>SQLite3</return>. The other parameters are only passed for
  some actions. The following table describes the second and third parameters according to the
  action: List of action codes and parametersActionSecond parameterThird
  parameter<info>SQLite3::CREATE_INDEX</info>Index NameTable Name<info>SQLite3::CREATE_TABLE</info>Table
  Name<info>null</info><info>SQLite3::CREATE_TEMP_INDEX</info>Index NameTable Name<info>SQLite3::CREATE_TEMP_TABLE</info>Table
  Name<info>null</info><info>SQLite3::CREATE_TEMP_TRIGGER</info>Trigger NameTable Name<info>SQLite3::CREATE_TEMP_VIEW</info>View
  Name<info>null</info><info>SQLite3::CREATE_TRIGGER</info>Trigger NameTable Name<info>SQLite3::CREATE_VIEW</info>View
  Name<info>null</info><info>SQLite3::DELETE</info>Table Name<info>null</info><info>SQLite3::DROP_INDEX</info>Index NameTable
  Name<info>SQLite3::DROP_TABLE</info>Table Name<info>null</info><info>SQLite3::DROP_TEMP_INDEX</info>Index NameTable
  Name<info>SQLite3::DROP_TEMP_TABLE</info>Table Name<info>null</info><info>SQLite3::DROP_TEMP_TRIGGER</info>Trigger NameTable
  Name<info>SQLite3::DROP_TEMP_VIEW</info>View Name<info>null</info><info>SQLite3::DROP_TRIGGER</info>Trigger NameTable
  Name<info>SQLite3::DROP_VIEW</info>View Name<info>null</info><info>SQLite3::INSERT</info>Table Name<info>null</info><info>SQLite3::PRAGMA</info>Pragma NameFirst
  argument passed to the pragma, or <info>null</info><info>SQLite3::READ</info>Table NameColumn
  Name<info>SQLite3::SELECT</info><info>null</info><info>null</info><info>SQLite3::TRANSACTION</info>Operation<info>null</info><info>SQLite3::UPDATE</info>Table NameColumn
  Name<info>SQLite3::ATTACH</info>Filename<info>null</info><info>SQLite3::DETACH</info>Database Name<info>null</info><info>SQLite3::ALTER_TABLE</info>Database
  NameTable Name<info>SQLite3::REINDEX</info>Index Name<info>null</info><info>SQLite3::ANALYZE</info>Table
  Name<info>null</info><info>SQLite3::CREATE_VTABLE</info>Table NameModule Name<info>SQLite3::DROP_VTABLE</info>Table NameModule
  Name<info>SQLite3::FUNCTION</info><info>null</info>Function Name<info>SQLite3::SAVEPOINT</info>OperationSavepoint
  Name<info>SQLite3::RECURSIVE</info><info>null</info><info>null</info>
  
  The 4th parameter will be the name of the database (<return>"main"</return>, <return>"temp"</return>, etc.) if applicable.
  
  The 5th parameter to the authorizer callback is the name of the inner-most trigger or view that is
  responsible for the access attempt or <info>null</info> if this access attempt is directly from top-level SQL
  code.
  
  When the callback returns <info>SQLite3::OK</info>, that means the operation requested is accepted. When the
  callback returns <info>SQLite3::DENY</info>, the call that triggered the authorizer will fail with an error
  message explaining that access is denied.
  
  If the action code is <info>SQLite3::READ</info> and the callback returns <info>SQLite3::IGNORE</info> then the prepared
  statement is constructed to substitute a <info>null</info> value in place of the table column that would have
  been read if <info>SQLite3::OK</info> had been returned. The <info>SQLite3::IGNORE</info> return can be used to deny an
  untrusted user access to individual columns of a table.
  
  When a table is referenced by a <return>SELECT</return> but no column values are extracted from that table (for
  example in a query like <return>"SELECT count(*) FROM table"</return>) then the <info>SQLite3::READ</info> authorizer callback
  is invoked once for that table with a column name that is an empty string.
  
  If the action code is <info>SQLite3::DELETE</info> and the callback returns <info>SQLite3::IGNORE</info> then the DELETE
  operation proceeds but the truncate optimization is disabled and all rows are deleted
  individually.
  
  Only a single authorizer can be in place on a database connection at a time. Each call to
  SQLite3::setAuthorizer overrides the previous call. Disable the authorizer by installing a <info>null</info>
  callback. The authorizer is disabled by default.
  
  The authorizer callback must not do anything that will modify the database connection that invoked
  the authorizer callback.
  
  Note that the authorizer is only called when a statement is prepared, not when it's executed.
  
  More details can be found in the SQLite3 documentation.

<comment>Param:</comment>
  <info>callable|null</info>  <strong>$callback</strong>  The <info>callable</info> to be called.
                            
                            If <info>null</info> is passed instead, this will disable the current authorizer
                            callback.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.


id: SQLite3::version
type: function
doc:
<comment>Description:</comment>
  Returns the SQLite3 library version as a string constant and as a number
    
  
  Returns the SQLite3 library version as a string constant and as a number.

<comment>Return:</comment>
  <info>array</info>  Returns an associative array with the keys "versionString" and "versionNumber".


id: SQLite3Result::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs an SQLite3Result
  
  <class>SQLite3Result</class> instances are created by SQLite3::query and SQLite3Stmt::execute.


id: SQLite3Result::columnName
type: function
doc:
<comment>Description:</comment>
  Returns the name of the nth column
  
  Returns the name of the column specified by the <strong>$column</strong>. Note that the name of a result column is
  the value of the <return>AS</return> clause for that column, if there is an <return>AS</return> clause. If there is no <return>AS</return> clause
  then the name of the column is unspecified and may change from one release of libsqlite3 to the
  next.

<comment>Param:</comment>
  <info>int</info>  <strong>$column</strong>  The numeric zero-based index of the column.

<comment>Return:</comment>
  <info>string|false</info>  Returns the <info>string</info> name of the column identified by <strong>$column</strong>, or <info>false</info> if the column
                does not exist.


id: SQLite3Result::columnType
type: function
doc:
<comment>Description:</comment>
  Returns the type of the nth column
  
  Returns the type of the column identified by <strong>$column</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$column</strong>  The numeric zero-based index of the column.

<comment>Return:</comment>
  <info>int|false</info>  Returns the data type index of the column identified by <strong>$column</strong> (one of
             <info>SQLITE3_INTEGER</info>, <info>SQLITE3_FLOAT</info>, <info>SQLITE3_TEXT</info>, <info>SQLITE3_BLOB</info>, or <info>SQLITE3_NULL</info>), or <info>false</info>
             if the column does not exist.


id: SQLite3Result::fetchArray
type: function
doc:
<comment>Description:</comment>
  Fetches a result row as an associative or numerically indexed array or both
    
  
  Fetches a result row as an associative or numerically indexed array or both. By default, fetches
  as both.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Controls how the next row will be returned to the caller. This value must be one of
              either <return>SQLITE3_ASSOC</return>, <return>SQLITE3_NUM</return>, or <return>SQLITE3_BOTH</return>. <return>SQLITE3_ASSOC</return>: returns an array
              indexed by column name as returned in the corresponding result set <return>SQLITE3_NUM</return>:
              returns an array indexed by column number as returned in the corresponding result set,
              starting at column 0 <return>SQLITE3_BOTH</return>: returns an array indexed by both column name and
              number as returned in the corresponding result set, starting at column 0
              
              <return>SQLITE3_ASSOC</return>: returns an array indexed by column name as returned in the
              corresponding result set
              
              <return>SQLITE3_NUM</return>: returns an array indexed by column number as returned in the
              corresponding result set, starting at column 0
              
              <return>SQLITE3_BOTH</return>: returns an array indexed by both column name and number as returned in
              the corresponding result set, starting at column 0

<comment>Return:</comment>
  <info>array|false</info>  Returns a result row as an associatively or numerically indexed array or both.
               Alternately will return <info>false</info> if there are no more rows.
               
               The types of the values of the returned array are mapped from SQLite3 types as
               follows: integers are mapped to <info>int</info> if they fit into the range
               <info>PHP_INT_MIN</info>..<info>PHP_INT_MAX</info>, and to <info>string</info> otherwise. Floats are mapped to <info>float</info>, <return>NULL</return>
               values are mapped to <info>null</info>, and strings and blobs are mapped to <info>string</info>.


id: SQLite3Result::finalize
type: function
doc:
<comment>Description:</comment>
  Closes the result set
  
  Closes the result set.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info>.


id: SQLite3Result::numColumns
type: function
doc:
<comment>Description:</comment>
  Returns the number of columns in the result set
  
  Returns the number of columns in the result set.

<comment>Return:</comment>
  <info>int</info>  Returns the number of columns in the result set.


id: SQLite3Result::reset
type: function
doc:
<comment>Description:</comment>
  Resets the result set back to the first row
  
  Resets the result set back to the first row.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the result set is successfully reset back to the first row, <info>false</info> on
        failure.


id: SQLite3Stmt
type: class
doc:
<comment>Description:</comment>
  A class that handles prepared statements for the SQLite 3 extension.


id: SQLite3Stmt::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs an SQLite3Stmt object
  
  <class>SQLite3Stmt</class> instances are created by SQLite3::prepare.

<comment>Param:</comment>
  <info>SQLite3</info>  <strong>$sqlite3</strong>  
  <info>string</info>   <strong>$query</strong>    


id: SQLite3Stmt::bindParam
type: function
doc:
<comment>Description:</comment>
  Binds a parameter to a statement variable
  
  Binds a parameter to a statement variable.
  
  Before PHP 7.2.14 and 7.3.0, respectively, SQLite3Stmt::reset must be called after the first call
  to SQLite3Stmt::execute if the bound value should be properly updated on following calls to
  SQLite3Stmt::execute. If SQLite3Stmt::reset is not called, the bound value will not change, even
  if the value assigned to the variable passed to SQLite3Stmt::bindParam has changed, or
  SQLite3Stmt::bindParam has been called again.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$param</strong>  Either a <info>string</info> (for named parameters) or an <info>int</info> (for positional parameters)
                      identifying the statement variable to which the value should be bound. If a
                      named parameter does not start with a colon (<return>:</return>) or an at sign (<return>@</return>), a colon (<return>:</return>)
                      is automatically preprended. Positional parameters start with <return>1</return>.
  <info>mixed</info>       <strong>$var</strong>    The parameter to bind to a statement variable.
  <info>int</info>         <strong>$type</strong>   The data type of the parameter to bind. <info>SQLITE3_INTEGER</info>: The value is a signed
                      integer, stored in 1, 2, 3, 4, 6, or 8 bytes depending on the magnitude of the
                      value. <info>SQLITE3_FLOAT</info>: The value is a floating point value, stored as an 8-byte
                      IEEE floating point number. <info>SQLITE3_TEXT</info>: The value is a text string, stored
                      using the database encoding (UTF-8, UTF-16BE or UTF-16-LE). <info>SQLITE3_BLOB</info>: The
                      value is a blob of data, stored exactly as it was input. <info>SQLITE3_NULL</info>: The
                      value is a NULL value.
                      
                      <info>SQLITE3_INTEGER</info>: The value is a signed integer, stored in 1, 2, 3, 4, 6, or 8
                      bytes depending on the magnitude of the value.
                      
                      <info>SQLITE3_FLOAT</info>: The value is a floating point value, stored as an 8-byte IEEE
                      floating point number.
                      
                      <info>SQLITE3_TEXT</info>: The value is a text string, stored using the database encoding
                      (UTF-8, UTF-16BE or UTF-16-LE).
                      
                      <info>SQLITE3_BLOB</info>: The value is a blob of data, stored exactly as it was input.
                      
                      <info>SQLITE3_NULL</info>: The value is a NULL value.
                      
                      As of PHP 7.0.7, if <strong>$type</strong> is omitted, it is automatically detected from the
                      type of the <strong>$var</strong>: <info>bool</info> and <info>int</info> are treated as <info>SQLITE3_INTEGER</info>, <info>float</info> as
                      <info>SQLITE3_FLOAT</info>, <info>null</info> as <info>SQLITE3_NULL</info> and all others as <info>SQLITE3_TEXT</info>. Formerly,
                      if <strong>$type</strong> has been omitted, it has defaulted to <info>SQLITE3_TEXT</info>.
                      
                      If <strong>$var</strong> is <info>null</info>, it is always treated as <info>SQLITE3_NULL</info>, regardless of the given
                      <strong>$type</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the parameter is bound to the statement variable, <info>false</info> on failure.

<comment>See Also:</comment>
   * SQLite3Stmt::bindValue
   * SQLite3::prepare


id: SQLite3Stmt::bindValue
type: function
doc:
<comment>Description:</comment>
  Binds the value of a parameter to a statement variable
  
  Binds the value of a parameter to a statement variable.
  
  Before PHP 7.2.14 and 7.3.0, respectively, once the statement has been executed,
  SQLite3Stmt::reset  needs to be called to be able to change the value of bound parameters.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$param</strong>  Either a <info>string</info> (for named parameters) or an <info>int</info> (for positional parameters)
                      identifying the statement variable to which the value should be bound. If a
                      named parameter does not start with a colon (<return>:</return>) or an at sign (<return>@</return>), a colon (<return>:</return>)
                      is automatically preprended. Positional parameters start with <return>1</return>.
  <info>mixed</info>       <strong>$value</strong>  The value to bind to a statement variable.
  <info>int</info>         <strong>$type</strong>   The data type of the value to bind. <info>SQLITE3_INTEGER</info>: The value is a signed
                      integer, stored in 1, 2, 3, 4, 6, or 8 bytes depending on the magnitude of the
                      value. <info>SQLITE3_FLOAT</info>: The value is a floating point value, stored as an 8-byte
                      IEEE floating point number. <info>SQLITE3_TEXT</info>: The value is a text string, stored
                      using the database encoding (UTF-8, UTF-16BE or UTF-16-LE). <info>SQLITE3_BLOB</info>: The
                      value is a blob of data, stored exactly as it was input. <info>SQLITE3_NULL</info>: The
                      value is a NULL value.
                      
                      <info>SQLITE3_INTEGER</info>: The value is a signed integer, stored in 1, 2, 3, 4, 6, or 8
                      bytes depending on the magnitude of the value.
                      
                      <info>SQLITE3_FLOAT</info>: The value is a floating point value, stored as an 8-byte IEEE
                      floating point number.
                      
                      <info>SQLITE3_TEXT</info>: The value is a text string, stored using the database encoding
                      (UTF-8, UTF-16BE or UTF-16-LE).
                      
                      <info>SQLITE3_BLOB</info>: The value is a blob of data, stored exactly as it was input.
                      
                      <info>SQLITE3_NULL</info>: The value is a NULL value.
                      
                      As of PHP 7.0.7, if <strong>$type</strong> is omitted, it is automatically detected from the
                      type of the <strong>$value</strong>: <info>bool</info> and <info>int</info> are treated as <info>SQLITE3_INTEGER</info>, <info>float</info> as
                      <info>SQLITE3_FLOAT</info>, <info>null</info> as <info>SQLITE3_NULL</info> and all others as <info>SQLITE3_TEXT</info>. Formerly,
                      if <strong>$type</strong> has been omitted, it has defaulted to <info>SQLITE3_TEXT</info>.
                      
                      If <strong>$value</strong> is <info>null</info>, it is always treated as <info>SQLITE3_NULL</info>, regardless of the
                      given <strong>$type</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the value is bound to the statement variable,  or <info>false</info> on failure.

<comment>See Also:</comment>
   * SQLite3Stmt::bindParam
   * SQLite3::prepare


id: SQLite3Stmt::clear
type: function
doc:
<comment>Description:</comment>
  Clears all current bound parameters
  
  Clears all current bound parameters (sets them to <info>null</info>).
  
  This method needs to be used with SQLite3Stmt::reset. If used alone, any call to
  SQLite3Stmt::bindValue or SQLite3Stmt::bindParam will be of no effect and all bound parameters
  will have the <info>null</info> value.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on successful clearing of bound parameters, <info>false</info> on failure.


id: SQLite3Stmt::close
type: function
doc:
<comment>Description:</comment>
  Closes the prepared statement
  
  Closes the prepared statement.
  
  Note that all <class>SQLite3Result</class>s that have been retrieved by executing this statement will be
  invalidated when the statement is closed.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info>


id: SQLite3Stmt::execute
type: function
doc:
<comment>Description:</comment>
  Executes a prepared statement and returns a result set object
  
  Executes a prepared statement and returns a result set object.
  
  Result set objects retrieved by calling this method on the same statement object are not
  independent, but rather share the same underlying structure. Therefore it is recommended to call
  SQLite3Result::finalize, before calling SQLite3Stmt::execute on the same statement object again.

<comment>Return:</comment>
  <info>SQLite3Result|false</info>  Returns an <class>SQLite3Result</class> object on successful execution of the prepared
                       statement, <info>false</info> on failure.

<comment>See Also:</comment>
   * SQLite3::prepare
   * SQLite3Stmt::bindValue
   * SQLite3Stmt::bindParam


id: SQLite3Stmt::getSQL
type: function
doc:
<comment>Description:</comment>
  Get the SQL of the statement
  
  Retrieves the SQL of the prepared statement. If <strong>$expand</strong> is <info>false</info>, the unmodified SQL is retrieved.
  If <strong>$expand</strong> is <info>true</info>, all query parameters are replaced with their bound values, or with an SQL
  <return>NULL</return>, if not already bound.

<comment>Param:</comment>
  <info>bool</info>  <strong>$expand</strong>  Whether to retrieve the expanded SQL. Passing <info>true</info> is only supported as of
                 libsqlite 3.14.

<comment>Return:</comment>
  <info>string|false</info>  Returns the SQL of the prepared statement,  or <info>false</info> on failure.


id: SQLite3Stmt::paramCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of parameters within the prepared statement
  
  Returns the number of parameters within the prepared statement.

<comment>Return:</comment>
  <info>int</info>  Returns the number of parameters within the prepared statement.

<comment>See Also:</comment>
   * SQLite3::prepare


id: SQLite3Stmt::readOnly
type: function
doc:
<comment>Description:</comment>
  Returns whether a statement is definitely read only
  
  Returns whether a statement is definitely read only. A statement is considered read only, if it
  makes no direct changes to the content of the database file. Note that user defined SQL functions
  might change the database indirectly as a side effect.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if a statement is definitely read only, <info>false</info> otherwise.


id: SQLite3Stmt::reset
type: function
doc:
<comment>Description:</comment>
  Resets the prepared statement
  
  Resets the prepared statement to its state prior to execution. All bindings remain intact after
  reset.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the statement is successfully reset,  or <info>false</info> on failure.


id: SSH2_DEFAULT_TERMINAL
type: constant
doc:
<comment>Description:</comment>
  Default terminal type (e.g. vt102, ansi, xterm, vanilla) requested by <strong>ssh2_shell()</strong>.


id: SSH2_DEFAULT_TERM_HEIGHT
type: constant
doc:
<comment>Description:</comment>
  Default terminal height requested by <strong>ssh2_shell()</strong>.


id: SSH2_DEFAULT_TERM_UNIT
type: constant
doc:
<comment>Description:</comment>
  Default terminal units requested by <strong>ssh2_shell()</strong>.


id: SSH2_DEFAULT_TERM_WIDTH
type: constant
doc:
<comment>Description:</comment>
  Default terminal width requested by <strong>ssh2_shell()</strong>.


id: SSH2_FINGERPRINT_HEX
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_fingerprint()</strong> requesting hostkey fingerprint as a string of hexits.


id: SSH2_FINGERPRINT_MD5
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_fingerprint()</strong> requesting hostkey fingerprint as an MD5 hash.


id: SSH2_FINGERPRINT_RAW
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_fingerprint()</strong> requesting hostkey fingerprint as a raw string of 8-bit characters.


id: SSH2_FINGERPRINT_SHA1
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_fingerprint()</strong> requesting hostkey fingerprint as an SHA1 hash.


id: SSH2_STREAM_STDERR
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_fetch_stream()</strong> requesting STDERR subchannel.


id: SSH2_STREAM_STDIO
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_fetch_stream()</strong> requesting STDIO subchannel.


id: SSH2_TERM_UNIT_CHARS
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_shell()</strong> specifying that <strong>$width</strong> and <strong>$height</strong> are provided as character sizes.


id: SSH2_TERM_UNIT_PIXELS
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_shell()</strong> specifying that <strong>$width</strong> and <strong>$height</strong> are provided in pixel units.


id: STREAM_CAST_AS_STREAM
type: constant
doc:
<comment>Description:</comment>
  Stream casting, when <strong>stream_cast()</strong> is called  otherwise (see above).


id: STREAM_CAST_FOR_SELECT
type: constant
doc:
<comment>Description:</comment>
  Stream casting, for when <strong>stream_select()</strong> is  calling <strong>stream_cast()</strong>.


id: STREAM_CLIENT_ASYNC_CONNECT
type: constant
doc:
<comment>Description:</comment>
  Open client socket asynchronously. This option must be used together with the
  <info>STREAM_CLIENT_CONNECT</info> flag. Used with <strong>stream_socket_client()</strong>.


id: STREAM_CLIENT_CONNECT
type: constant
doc:
<comment>Description:</comment>
  Open client socket connection. Client sockets should always include this flag. Used with
  <strong>stream_socket_client()</strong>.


id: STREAM_CLIENT_PERSISTENT
type: constant
doc:
<comment>Description:</comment>
  Client socket opened with <strong>stream_socket_client()</strong> should remain persistent between page loads.


id: STREAM_FILTER_ALL
type: constant
doc:
<comment>Description:</comment>
  This constant is equivalent to  STREAM_FILTER_READ | STREAM_FILTER_WRITE


id: STREAM_FILTER_READ
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_filter_append()</strong> and <strong>stream_filter_prepend()</strong> to indicate that the specified filter
  should only be applied when reading


id: STREAM_FILTER_WRITE
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_filter_append()</strong> and <strong>stream_filter_prepend()</strong> to indicate that the specified filter
  should only be applied when writing


id: STREAM_META_ACCESS
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_metadata()</strong>, to specify <strong>chmod()</strong> call.


id: STREAM_META_GROUP
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_metadata()</strong>, to specify <strong>chgrp()</strong> call.


id: STREAM_META_OWNER
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_metadata()</strong>, to specify <strong>chown()</strong> call.


id: STREAM_META_TOUCH
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_metadata()</strong>, to specify <strong>touch()</strong> call.


id: STREAM_NOTIFY_AUTH_REQUIRED
type: constant
doc:
<comment>Description:</comment>
  Additional authorization is required to access the specified resource. Typical issued with
  <strong>$severity</strong> level of <info>STREAM_NOTIFY_SEVERITY_ERR</info>.


id: STREAM_NOTIFY_FAILURE
type: constant
doc:
<comment>Description:</comment>
  A generic error occurred on the stream, consult <strong>$message</strong> and <strong>$message_code</strong> for details.


id: STREAM_NOTIFY_MIME_TYPE_IS
type: constant
doc:
<comment>Description:</comment>
  The <return>mime-type</return> of resource has been identified, refer to <strong>$message</strong> for a description of the
  discovered type.


id: STREAM_NOTIFY_PROGRESS
type: constant
doc:
<comment>Description:</comment>
  Indicates current progress of the stream transfer in <strong>$bytes_transferred</strong> and possibly <strong>$bytes_max</strong> as
  well.


id: STREAM_NOTIFY_REDIRECTED
type: constant
doc:
<comment>Description:</comment>
  The external resource has redirected the stream to an alternate location.  Refer to <strong>$message</strong>.


id: STREAM_NOTIFY_RESOLVE
type: constant
doc:
<comment>Description:</comment>
  A remote address required for this stream has been resolved, or the resolution failed.  See
  <strong>$severity</strong> for an indication of which happened.


id: STREAM_REPORT_ERRORS
type: constant
doc:
<comment>Description:</comment>
  <return>Flag</return> indicating if the <return>wrapper</return> is responsible for raising errors using <strong>trigger_error()</strong>  during
  opening of the stream.  If this flag is not set, you should not raise any errors.


id: STREAM_SERVER_BIND
type: constant
doc:
<comment>Description:</comment>
  Tells a stream created with <strong>stream_socket_server()</strong> to bind to the specified target.  Server
  sockets should always include this flag.


id: STREAM_SERVER_LISTEN
type: constant
doc:
<comment>Description:</comment>
  Tells a stream created with <strong>stream_socket_server()</strong> and bound using the <info>STREAM_SERVER_BIND</info> flag to
  start listening on the socket. Connection-orientated transports (such as TCP) must use this flag,
  otherwise the server socket will not be enabled. Using this flag for connect-less transports (such
  as UDP) is an error.


id: STREAM_SHUT_RD
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_socket_shutdown()</strong> to disable further receptions.


id: STREAM_SHUT_RDWR
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_socket_shutdown()</strong> to disable further receptions and transmissions.


id: STREAM_SHUT_WR
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_socket_shutdown()</strong> to disable further transmissions.


id: STREAM_SOCK_DGRAM
type: constant
doc:
<comment>Description:</comment>
  Provides datagrams, which are connectionless messages (UDP, for example).


id: STREAM_SOCK_RAW
type: constant
doc:
<comment>Description:</comment>
  Provides a raw socket, which provides access to internal network protocols and interfaces. Usually
  this type of socket is just available to the root user.


id: STREAM_SOCK_STREAM
type: constant
doc:
<comment>Description:</comment>
  Provides sequenced, two-way byte streams with a transmission mechanism for out-of-band data (TCP,
  for example).


id: STREAM_USE_PATH
type: constant
doc:
<comment>Description:</comment>
  <return>Flag</return> indicating if the <return>stream</return> used the include path.


id: SVM::EPSILON_SVR
type: constant
doc:
<comment>Description:</comment>
  A SVM type for regression (predicting a value rather than just a class)


id: SVM::KERNEL_LINEAR
type: constant
doc:
<comment>Description:</comment>
  A very simple kernel, can work well on large document classification problems


id: SVM::KERNEL_RBF
type: constant
doc:
<comment>Description:</comment>
  The common Gaussian RBD kernel. Handles non-linear problems well and is a good default for
  classification


id: SVM::KERNEL_SIGMOID
type: constant
doc:
<comment>Description:</comment>
  A kernel based on the sigmoid function. Using this makes the SVM very similar to a two layer
  sigmoid based neural network


id: SVM::ONE_CLASS
type: constant
doc:
<comment>Description:</comment>
  One class SVM type. Train just on a single class, using outliers as negative examples


id: SVM::OPT_C
type: constant
doc:
<comment>Description:</comment>
  The option for the cost parameter that controls tradeoff between errors and generality -
  effectively the penalty for misclassifying training examples.


id: SVM::OPT_EPS
type: constant
doc:
<comment>Description:</comment>
  The option key for the Epsilon parameter, used in epsilon regression


id: SVM::OPT_NU
type: constant
doc:
<comment>Description:</comment>
  The option key for the nu parameter, only used in the NU_ SVM types


id: SVM::OPT_PROBABILITY
type: constant
doc:
<comment>Description:</comment>
  Training parameter, boolean, for whether to collect and use probability estimates


id: SVM::OPT_SHRINKING
type: constant
doc:
<comment>Description:</comment>
  Training parameter, boolean, for whether to use the shrinking heuristics


id: SVM::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new SVM object
  
  Constructs a new SVM object ready to accept training data.


id: SVM::crossvalidate
type: function
doc:
<comment>Description:</comment>
  Test training params on subsets of the training data
  
  Crossvalidate can be used to test the effectiveness of the current  parameter set on a subset of
  the training data. Given a problem set  and a n "folds", it separates the problem set into n
  subsets, and the  repeatedly trains on one subset and tests on another. While the accuracy  will
  generally be lower than a SVM trained on the enter data set, the  accuracy score returned should
  be relatively useful, so it can be used to  test different training parameters.

<comment>Param:</comment>
  <info>array</info>  <strong>$problem</strong>          The problem data. This can either be in the form of an array, the URL  of
                           an SVMLight formatted file, or a stream to an opened SVMLight  formatted
                           datasource.
  <info>int</info>    <strong>$number_of_folds</strong>  The number of sets the data should be divided into and cross tested.  A
                           higher number means smaller training sets and less reliability. 5 is  a
                           good number to start with.

<comment>Return:</comment>
  <info>float</info>  The correct percentage, expressed as a floating point number from 0-1.  In the case of
         NU_SVC or EPSILON_SVR kernels the mean squared error will  returned instead.

<comment>See Also:</comment>
   * SVM::train


id: SVM::getOptions
type: function
doc:
<comment>Description:</comment>
  Return the current training parameters
  
  Retrieve an array containing the training parameters.  The parameters will be keyed on the
  predefined SVM constants.

<comment>Return:</comment>
  <info>array</info>  Returns an array of configuration settings.


id: SVM::setOptions
type: function
doc:
<comment>Description:</comment>
  Set training parameters
  
  Set one or more training parameters.

<comment>Param:</comment>
  <info>array</info>  <strong>$params</strong>  An array of training parameters, keyed on the SVM constants.

<comment>Return:</comment>
  <info>bool</info>  Return true on success, throws SVMException on error.


id: SVM::train
type: function
doc:
<comment>Description:</comment>
  Create a SVMModel based on training data
  
  Train a support vector machine based on the supplied training data.

<comment>Param:</comment>
  <info>array</info>  <strong>$problem</strong>  The problem can be provided in three different ways.  An array, where the data
                   should start with the class label  (usually 1 or -1) then followed by a sparse
                   data set of  dimension =&gt; data pairs.  A URL to a file containing a SVM Light
                   formatted problem, with the  each line being a new training example, the start of
                   each line  containing the class (1, -1) then a series of tab separated data
                   values shows as key:value.  A opened stream pointing to a data source formatted
                   as in the file above.
  <info>array</info>  <strong>$weights</strong>  Weights are an optional set of weighting parameters for the different  classes,
                   to help account for unbalanced training sets. For example,  if the classes were 1
                   and -1, and -1 had significantly more example  than one, the weight for -1 could
                   be 0.5. Weights should be in the range 0-1.

<comment>Return:</comment>
  <info>SVMModel</info>  Returns an SVMModel that can be used to classify previously unseen data. Throws
            SVMException on error


id: SVMModel
type: class
doc:
<comment>Description:</comment>
  The SVMModel is the end result of the training process. It can be used to classify previously
  unseen data.


id: SVMModel::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new SVMModel
  
  Build a new SVMModel. Models will usually be created from the  SVM::train function, but then saved
  models may be restored directly.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename for the saved model file this model should load.

<comment>See Also:</comment>
   * SVMModel::load


id: SVMModel::checkProbabilityModel
type: function
doc:
<comment>Description:</comment>
  Returns true if the model has probability information
  
  Returns true if the model contains probability information.

<comment>Return:</comment>
  <info>bool</info>  Return a boolean value


id: SVMModel::getLabels
type: function
doc:
<comment>Description:</comment>
  Get the labels the model was trained on
  
  Return an array of labels that the model was trained on. For regression and one class models an
  empty array is returned.

<comment>Return:</comment>
  <info>array</info>  Return an array of labels

<comment>See Also:</comment>
   * SVMModel::getNrClass


id: SVMModel::getNrClass
type: function
doc:
<comment>Description:</comment>
  Returns the number of classes the model was trained with
  
  Returns the number of classes the model was trained with, will return 2 for one class and
  regression models.

<comment>Return:</comment>
  <info>int</info>  Return an integer number of classes


id: SVMModel::getSvmType
type: function
doc:
<comment>Description:</comment>
  Get the SVM type the model was trained with
  
  Returns an integer value representing the type of the SVM model used, e.g SVM::C_SVC.

<comment>Return:</comment>
  <info>int</info>  Return an integer SVM type


id: SVMModel::getSvrProbability
type: function
doc:
<comment>Description:</comment>
  Get the sigma value for regression types
  
  For regression models, returns a sigma value. If there is no probability information or the model
  is not SVR, 0 is returned.

<comment>Return:</comment>
  <info>float</info>  Returns a sigma value


id: SVMModel::load
type: function
doc:
<comment>Description:</comment>
  Load a saved SVM Model
  
  Load a model file ready for classification or regression.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the model.

<comment>Return:</comment>
  <info>bool</info>  Throws SVMException on error. Returns true on success.

<comment>See Also:</comment>
   * SVMModel::save


id: SVMModel::predict
type: function
doc:
<comment>Description:</comment>
  Predict a value for previously unseen data
  
  This function accepts an array of data and attempts to predict the class  or regression value
  based on the model extracted from previously trained data.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  The array to be classified. This should be a series of key =&gt; value  pairs in
                increasing key order, but not necessarily continuous.

<comment>Return:</comment>
  <info>float</info>  Float the predicted value. This will be a class label in the case of  classification, a
         real value in the case of regression. Throws SVMException on error

<comment>See Also:</comment>
   * SVM::train


id: SVMModel::predict_probability
type: function
doc:
<comment>Description:</comment>
  Return class probabilities for previous unseen data
  
  This function accepts an array of data and attempts to predict the class, as with the predict
  function. Additionally, however, this function returns an array of probabilities, one per class in
  the model, which represent the estimated chance of the data supplied being a member of that class.
  Requires that the model to be used has been trained with the probability parameter set to true.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>           The array to be classified. This should be a series of key =&gt; value
                         pairs in increasing key order, but not necessarily continuous.
  <info></info>       <strong>$probabilities</strong>  The supplied value will be filled with the probabilities. This will be
                         either null, in the case  of a model without probability information, or an
                         array where the index is the class name and the value the predicted
                         probability.

<comment>Return:</comment>
  <info>float</info>  Float the predicted value. This will be a class label in the case of  classification, a
         real value in the case of regression. Throws SVMException on error

<comment>See Also:</comment>
   * SVM::predict


id: SVMModel::save
type: function
doc:
<comment>Description:</comment>
  Save a model to a file
  
  Save the model data to a file, for later use.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The file to save the model to.

<comment>Return:</comment>
  <info>bool</info>  Throws SVMException on error.  Returns true on success.

<comment>See Also:</comment>
   * SVMModel::load


id: SVN_AUTH_PARAM_DEFAULT_PASSWORD
type: constant
doc:
<comment>Description:</comment>
  Property for default password to use when performing basic authentication


id: SVN_AUTH_PARAM_DEFAULT_USERNAME
type: constant
doc:
<comment>Description:</comment>
  Property for default username to use when performing basic authentication


id: SVN_WC_STATUS_CONFLICTED
type: constant
doc:
<comment>Description:</comment>
  Item's local modifications conflicted with repository modifications


id: SVN_WC_STATUS_MERGED
type: constant
doc:
<comment>Description:</comment>
  Item's local modifications were merged with repository modifications


id: Schema::__construct
type: function
doc:
<comment>Description:</comment>
  Schema constructor
  
  The Schema object provides full access to the schema (database).


id: Schema::createCollection
type: function
doc:
<comment>Description:</comment>
  Add collection to schema
  
  Create a collection within the schema.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      Collection name.
  <info>string</info>  <strong>$validate</strong>  Validation definition, as a JSON object.

<comment>Return:</comment>
  <info>mysql_xdevapi\Collection</info>  The Collection object.


id: Schema::dropCollection
type: function
doc:
<comment>Description:</comment>
  Drop collection from schema
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_name</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Schema::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  Check if exists in database
  
  Checks if the current object (schema, table, collection, or view) exists in the schema object.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the schema, table, collection, or view still exists in the schema, else <info>false</info>.


id: Schema::getCollection
type: function
doc:
<comment>Description:</comment>
  Get collection from schema
  
  Get a collection from the schema.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Collection name to retrieve.

<comment>Return:</comment>
  <info>mysql_xdevapi\Collection</info>  The Collection object for the selected collection.


id: Schema::getCollectionAsTable
type: function
doc:
<comment>Description:</comment>
  Get collection as a Table object
  
  Get a collection, but as a Table object instead of a Collection object.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the collection to instantiate a Table object from.

<comment>Return:</comment>
  <info>mysql_xdevapi\Table</info>  A <class>mysql_xdevapi\Table</class> object for the collection.


id: Schema::getCollections
type: function
doc:
<comment>Description:</comment>
  Get all schema collections
  
  Fetch a list of collections for this schema.

<comment>Return:</comment>
  <info>array</info>  Array of all collections in this schema, where each array element value is a Collection
         object with the collection name as the key.


id: Schema::getName
type: function
doc:
<comment>Description:</comment>
  Get schema name
  
  Get the name of the schema.

<comment>Return:</comment>
  <info>string</info>  The name of the schema connected to the schema object, as a string.


id: Schema::getSession
type: function
doc:
<comment>Description:</comment>
  Get schema session
  
  Get a new Session object from the Schema object.

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  A Session object.


id: Schema::getTable
type: function
doc:
<comment>Description:</comment>
  Get schema table
  
  Fetch a Table object for the provided table in the schema.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the table.

<comment>Return:</comment>
  <info>mysql_xdevapi\Table</info>  A Table object.


id: Schema::getTables
type: function
doc:
<comment>Description:</comment>
  Get schema tables
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>array</info>  Array of all tables in this schema, where each array element value is a Table object with
         the table name as the key.


id: SchemaObject::getSchema
type: function
doc:
<comment>Description:</comment>
  Get schema object
  
  Used by other objects to retrieve a schema object.

<comment>Return:</comment>
  <info>mysql_xdevapi\Schema</info>  The current Schema object.


id: SeasLog::__construct
type: function
doc:
<comment>Description:</comment>
  Description
  
  This function is
  currently not documented; only its argument list is available.


id: SeasLog::alert
type: function
doc:
<comment>Description:</comment>
  Record alert log information
  
  Record alert log information.  "ALERT" - Action must be taken immediately. Immediate attention
  should be given to relevant personnel for emergency repairs.
  
  "ALERT" - Action must be taken immediately. Immediate attention should be given to relevant
  personnel for emergency repairs.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::analyzerCount
type: function
doc:
<comment>Description:</comment>
  Get log count by level, log_path and key_word
  
  `SeasLog` get count value of `grep -ai '{level}' | grep -aic '{key_word}'`  use system pipe and
  return to PHP (array or int).

<comment>Param:</comment>
  <info>string</info>  <strong>$level</strong>     String. The log information level.
  <info>string</info>  <strong>$log_path</strong>  String. The log information path.
  <info>string</info>  <strong>$key_word</strong>  String. The search key word for log information.

<comment>Return:</comment>
  <info>mixed</info>  If `level` is SEASLOG_ALL or Empty, return all levels count as `array`. If `level` is
         SEASLOG_INFO or the other level, return count as `int`.

<comment>See Also:</comment>
   * SeasLog::analyzerDetail


id: SeasLog::analyzerDetail
type: function
doc:
<comment>Description:</comment>
  Get log detail by level, log_path, key_word, start, limit, order
  
  `SeasLog` get results of  `grep -ai '{level}' | grep -ai '{key_word}' |  sed -n
  '{start},{limit}'p`  use system pipe and return array to PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$level</strong>     String. The log information level.
  <info>string</info>  <strong>$log_path</strong>  String. The log information path.
  <info>string</info>  <strong>$key_word</strong>  String. The search key word for log information.
  <info>int</info>     <strong>$start</strong>     Int. Default is `1`.
  <info>int</info>     <strong>$limit</strong>     Int. Default is `20`.
  <info>int</info>     <strong>$order</strong>     Int. Default is SEASLOG_DETAIL_ORDER_ASC. See also:
                     SEASLOG_DETAIL_ORDER_ASCSEASLOG_DETAIL_ORDER_DESC

<comment>Return:</comment>
  <info>mixed</info>  Return results as array.  When `start`,`limit` is not NULL and in Windows,  SeasLog will
         threw exception with message 'Param start and limit don't support Windows'.
         
         When `start`,`limit` is not NULL and in Windows,  SeasLog will threw exception with message
         'Param start and limit don't support Windows'.

<comment>See Also:</comment>
   * SeasLog::analyzerCount


id: SeasLog::closeLoggerStream
type: function
doc:
<comment>Description:</comment>
  Manually release stream flow from logger
  
  Manually release stream flow from logger. SeasLog caches the stream handle opened by the log
  logger to save the overhead of creating a stream. The handle will be automatically released at the
  end of the request. If in CLI mode, the process will also automatically release when it exits. Or
  you can use the following functions to manually release(manually release function needs to update
  SeasLog 1.8.6 or updated version).

<comment>Param:</comment>
  <info>int</info>     <strong>$model</strong>   Constant int.
                   SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALLSEASLOG_CLOSE_LOGGER_STREAM_MOD_ASSIGN
  <info>string</info>  <strong>$logger</strong>  The logger name.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on released stream flow success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::setLogger
   * SeasLog::getLastLogger


id: SeasLog::critical
type: function
doc:
<comment>Description:</comment>
  Record critical log information
  
  Record critical log information.  "CRITICAL" - Critical conditions.Need to be repaired
  immediately, and the program component is unavailable.
  
  "CRITICAL" - Critical conditions.Need to be repaired immediately, and the program component is
  unavailable.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::debug
type: function
doc:
<comment>Description:</comment>
  Record debug log information
  
  Record debug log information.  "DEBUG" - Detailed debug information.Fine-grained information
  events.
  
  "DEBUG" - Detailed debug information.Fine-grained information events.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::emergency
type: function
doc:
<comment>Description:</comment>
  Record emergency log information
  
  Record emergency log information.  "EMERGENCY" - System is unusable. 
  
  "EMERGENCY" - System is unusable.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::log


id: SeasLog::error
type: function
doc:
<comment>Description:</comment>
  Record error log information
  
  Record error log information.  "ERROR" - Runtime errors that do not require immediate action but
  should typically.
  
  "ERROR" - Runtime errors that do not require immediate action but should typically.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::flushBuffer
type: function
doc:
<comment>Description:</comment>
  Flush logs buffer, dump to appender file, or send to remote api with tcp/udp
  
  Flush logs buffer by seaslog.appender:  dump to file, or send to remote api with tcp/udp.  See
  also: seaslog.appender_retry seaslog.remote_host seaslog.remote_port
  
  See also: seaslog.appender_retry seaslog.remote_host seaslog.remote_port

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on flush buffer success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.use_buffer
   * seaslog.buffer_size
   * seaslog.buffer_disabled_in_cli
   * SeasLog::getBufferEnabled
   * SeasLog::getBuffer


id: SeasLog::getBasePath
type: function
doc:
<comment>Description:</comment>
  Get SeasLog base path.
  
  Use the Function SeasLog::getBasePath will get the value of seaslog.default_basepath what
  configured in php.ini(seaslog.ini).
  
  If you use Seaslog::setBasePath, will change the result.

<comment>Return:</comment>
  <info>string</info>  Return seaslog.default_basepath as string.


id: SeasLog::getBuffer
type: function
doc:
<comment>Description:</comment>
  Get the logs buffer in memory as array

<comment>Return:</comment>
  <info>array</info>  Return an array from logs buffer in memory.

<comment>See Also:</comment>
   * seaslog.use_buffer
   * seaslog.buffer_size
   * seaslog.buffer_disabled_in_cli
   * SeasLog::getBufferEnabled
   * SeasLog::flushBuffer


id: SeasLog::getBufferEnabled
type: function
doc:
<comment>Description:</comment>
  Determin if buffer enabled
  
  Result join seaslog.use_buffer  and seaslog.buffer_disabled_in_cli.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on seaslog.use_buffer is true. If switch seaslog.buffer_disabled_in_cli on, and
        running in cli,  seaslog.use_buffer setting will be discarded, Seaslog write to the Data
        Store IMMEDIATELY.

<comment>See Also:</comment>
   * seaslog.use_buffer
   * seaslog.buffer_size
   * seaslog.buffer_disabled_in_cli
   * SeasLog::getBuffer
   * SeasLog::flushBuffer


id: SeasLog::getDatetimeFormat
type: function
doc:
<comment>Description:</comment>
  Get SeasLog datetime format style
  
  Get SeasLog datetime format style. Use the Function SeasLog::getDatetimeFormat will  get the value
  of seaslog.default_datetime_format  what configured in php.ini(seaslog.ini).

<comment>Return:</comment>
  <info>string</info>  Get SeasLog datetime format style of  seaslog.default_datetime_format. Use the Function
          SeasLog::setDatetimeFormat  will change this value.

<comment>See Also:</comment>
   * SeasLog::setDatetimeFormat


id: SeasLog::getLastLogger
type: function
doc:
<comment>Description:</comment>
  Get SeasLog last logger path
  
  Use the Function SeasLog::getLastLogger will  get the value of seaslog.default_logger  what
  configured in php.ini(seaslog.ini).

<comment>Return:</comment>
  <info>string</info>  Use the Function SeasLog::setLogger  will change the value of function
          SeasLog::getLastLogger.

<comment>See Also:</comment>
   * SeasLog::setLogger


id: SeasLog::getRequestID
type: function
doc:
<comment>Description:</comment>
  Get SeasLog request_id differentiated requests
  
  To distinguish a single request, such as not invoking the  SeasLog::setRequestId function， the
  unique value generated by the built-in `static char *get_uniqid ()`  function is used when the
  request is initialized.

<comment>Return:</comment>
  <info>string</info>  Return string generated by the built-in `static char *get_uniqid ()` function, or setted
          by SeasLog::setRequestId function.

<comment>See Also:</comment>
   * SeasLog::setRequestID
   * The Variable `%Q` in 
   Seaslog Default Variable Table.


id: SeasLog::getRequestVariable
type: function
doc:
<comment>Description:</comment>
  Get SeasLog request variable
  
  Get SeasLog request variable.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  Constant int.
             SEASLOG_REQUEST_VARIABLE_DOMAIN_PORTSEASLOG_REQUEST_VARIABLE_REQUEST_URISEASLOG_REQUEST_VARIABLE_REQUEST_METHODSEASLOG_REQUEST_VARIABLE_CLIENT_IP

<comment>Return:</comment>
  <info>bool</info>  Return request variable value on set success.

<comment>See Also:</comment>
   * SeasLog::setRequestVariable


id: SeasLog::info
type: function
doc:
<comment>Description:</comment>
  Record info log information
  
  Record info log information.  "INFO" - Interesting events.Emphasizes the running process of the
  application.
  
  "INFO" - Interesting events.Emphasizes the running process of the application.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::log
type: function
doc:
<comment>Description:</comment>
  The Common Record Log Function
  
  The Common Record Log Function.

<comment>Param:</comment>
  <info>string</info>  <strong>$level</strong>    Can use level in:
                    SEASLOG_DEBUGSEASLOG_INFOSEASLOG_NOTICESEASLOG_WARNINGSEASLOG_ERRORSEASLOG_CRITICALSEASLOG_ALERTSEASLOG_EMERGENCY
                    Or you can create a new level self-help.
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency


id: SeasLog::notice
type: function
doc:
<comment>Description:</comment>
  Record notice log information
  
  Record notice log information.  "NOTICE" - Normal but significant events.Information that is more
  important than the INFO level during execution.
  
  "NOTICE" - Normal but significant events.Information that is more important than the INFO level
  during execution.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::setBasePath
type: function
doc:
<comment>Description:</comment>
  Set SeasLog base path
  
  Set SeasLog base path.

<comment>Param:</comment>
  <info>string</info>  <strong>$base_path</strong>  String.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on setted base path success, FALSE on failure.


id: SeasLog::setDatetimeFormat
type: function
doc:
<comment>Description:</comment>
  Set SeasLog datetime format style
  
  Set SeasLog datetime format style.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  String. Such as `Y-m-d H:i:s` or `Ymd His`. See also first param `format` at
                   <strong>date()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on setted datetime format success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::getDateTimeFormat


id: SeasLog::setLogger
type: function
doc:
<comment>Description:</comment>
  Set SeasLog logger name
  
  Use the Function SeasLog::setLogger will change the value of function SeasLog::getLastLogger.
  Than's mean, SeasLog will record loginfo into the logger directory.

<comment>Param:</comment>
  <info>string</info>  <strong>$logger</strong>  Logger name.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on created logger disectory success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::getLastLogger
   * SeasLog::closeLoggerStream


id: SeasLog::setRequestID
type: function
doc:
<comment>Description:</comment>
  Set SeasLog request_id differentiated requests
  
  To distinguish a single request, such as not invoking the  SeasLog::setRequestId function， the
  unique value generated by the built-in `static char *get_uniqid ()`  function is used when the
  request is initialized.

<comment>Param:</comment>
  <info>string</info>  <strong>$request_id</strong>  String.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on set request_id success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::getRequestID


id: SeasLog::setRequestVariable
type: function
doc:
<comment>Description:</comment>
  Manually set SeasLog request variable
  
  Manually set SeasLog request variable.

<comment>Param:</comment>
  <info>int</info>     <strong>$key</strong>    Constant int.
                  SEASLOG_REQUEST_VARIABLE_DOMAIN_PORTSEASLOG_REQUEST_VARIABLE_REQUEST_URISEASLOG_REQUEST_VARIABLE_REQUEST_METHODSEASLOG_REQUEST_VARIABLE_CLIENT_IP
  <info>string</info>  <strong>$value</strong>  The request variable value.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on set success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::getRequestVariable


id: SeasLog::warning
type: function
doc:
<comment>Description:</comment>
  Record warning log information
  
  Record warning log information.  "WARNING" - Exceptional occurrences that are not errors.
  Potentially aberrant information that needs attention and needs to be repaired.
  
  "WARNING" - Exceptional occurrences that are not errors. Potentially aberrant information that
  needs attention and needs to be repaired.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeekableIterator::seek
type: function
doc:
<comment>Description:</comment>
  Seeks to a position
  
  Seeks to a given position in the iterator.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The position to seek to.

<comment>Return:</comment>
  <info>void</info>  No value is returned.

<comment>See Also:</comment>
   * <class>SeekableIterator</class>
   * <class>Iterator</class>


id: SensitiveParameter
type: class
doc:
<comment>Description:</comment>
   This attribute is used to mark a parameter that is sensitive and should have its value redacted
  if present in a stack trace.


id: SensitiveParameter::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new SensitiveParameter attribute instance
  
  Constructs a new <class>SensitiveParameter</class> instance.


id: SensitiveParameterValue
type: class
doc:
<comment>Description:</comment>
  The <class>SensitiveParameterValue</class> class allows wrapping sensitive values to protect them against
  accidental exposure.
  
  Values of parameters having the <class>SensitiveParameter</class> attribute will automatically be wrapped inside
  of a <class>SensitiveParameterValue</class> object within stack traces.


id: SensitiveParameterValue::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SensitiveParameterValue object
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  An arbitrary value that should be stored inside the <class>SensitiveParameterValue</class> object.


id: SensitiveParameterValue::__debugInfo
type: function
doc:
<comment>Description:</comment>
  Protects the sensitive value against accidental exposure
  
  Returns an empty <info>array</info> to protect the sensitive value against accidental exposure when using
  <strong>var_dump()</strong>.

<comment>Return:</comment>
  <info>array</info>  An empty <info>array</info>.


id: SensitiveParameterValue::getValue
type: function
doc:
<comment>Description:</comment>
  Returns the sensitive value
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>mixed</info>  The sensitive value.


id: Serializable
type: class
doc:
<comment>Description:</comment>
  Interface for customized serializing.
  
  Classes that implement this interface no longer support __sleep() and __wakeup(). The method
  serialize is called whenever an instance needs to be serialized. This does not invoke __destruct()
  or have any other side effect unless programmed inside the method. When the data is unserialized
  the class is known and the appropriate unserialize() method is called as a constructor instead of
  calling __construct(). If you need to execute the standard constructor you may do so in the
  method.
  
  As of PHP 8.1.0, a class which implements Serializable without also implementing __serialize() and
  __unserialize() will generate a deprecation warning.


id: Serializable::serialize
type: function
doc:
<comment>Description:</comment>
  String representation of object
  
  Should return the string representation of the object.

<comment>Return:</comment>
  <info>string|null</info>  Returns the string representation of the object or <info>null</info>

<comment>See Also:</comment>
   * __sleep()
   * __serialize()


id: Serializable::unserialize
type: function
doc:
<comment>Description:</comment>
  Constructs the object
  
  Called during unserialization of the object.
  
  This method acts as the constructor of the object. The __construct() method will not be called
  after this method.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The string representation of the object.

<comment>Return:</comment>
  <info>void</info>  The return value from this method is ignored.

<comment>See Also:</comment>
   * __wakeup()
   * __unserialize()


id: Session::__construct
type: function
doc:
<comment>Description:</comment>
  Description constructor
  
  A Session object, as initiated by getSession().


id: Session::close
type: function
doc:
<comment>Description:</comment>
  Close session
  
  Close the session with the server.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the session closed.


id: Session::commit
type: function
doc:
<comment>Description:</comment>
  Commit transaction
  
  Commit the transaction.

<comment>Return:</comment>
  <info>Object</info>  An SqlStatementResult object.


id: Session::createSchema
type: function
doc:
<comment>Description:</comment>
  Create new schema
  
  Creates a new schema.

<comment>Param:</comment>
  <info>string</info>  <strong>$schema_name</strong>  Name of the schema to create.

<comment>Return:</comment>
  <info>mysql_xdevapi\Schema</info>  A Schema object on success, and emits an exception on failure.


id: Session::dropSchema
type: function
doc:
<comment>Description:</comment>
  Drop a schema
  
  Drop a schema (database).

<comment>Param:</comment>
  <info>string</info>  <strong>$schema_name</strong>  Name of the schema to drop.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the schema is dropped, or <info>false</info> if it does not exist or can't be dropped.
        
        An <info>E_WARNING</info> level error is generated if the  schema does not exist.


id: Session::generateUUID
type: function
doc:
<comment>Description:</comment>
  Get new UUID
  
  Generate a Universal Unique IDentifier (UUID) generated according to  RFC 4122.

<comment>Return:</comment>
  <info>string</info>  The UUID; a string with a length of 32.


id: Session::getDefaultSchema
type: function
doc:
<comment>Description:</comment>
  Get default schema name
  
  Retrieve name of the default schema that's typically set in the connection URI.

<comment>Return:</comment>
  <info>string</info>  Name of the default schema defined by the connection, or <info>null</info> if one was not set.


id: Session::getSchema
type: function
doc:
<comment>Description:</comment>
  Get a new schema object
  
  A new Schema object for the provided schema name.

<comment>Param:</comment>
  <info>string</info>  <strong>$schema_name</strong>  Name of the schema (database) to fetch a Schema object for.

<comment>Return:</comment>
  <info>mysql_xdevapi\Schema</info>  A Schema object.


id: Session::getSchemas
type: function
doc:
<comment>Description:</comment>
  Get the schemas
  
  Get schema objects for all schemas available to the session.

<comment>Return:</comment>
  <info>array</info>  An array containing objects that represent all of the schemas  available to the session.


id: Session::getServerVersion
type: function
doc:
<comment>Description:</comment>
  Get server version
  
  Retrieve the MySQL server version for the session.

<comment>Return:</comment>
  <info>int</info>  The MySQL server version for the session, as an integer such as "80012".


id: Session::listClients
type: function
doc:
<comment>Description:</comment>
  Get client list
  
  Get a list of client connections to the session's MySQL server.

<comment>Return:</comment>
  <info>array</info>  An array containing the currently logged clients. The array elements are "client_id",
         "user", "host", and "sql_session".


id: Session::quoteName
type: function
doc:
<comment>Description:</comment>
  Add quotes
  
  A quoting function to escape SQL names and identifiers. It escapes the identifier  given in
  accordance to the settings of the current connection. This escape  function should not be used to
  escape values.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The string to quote.

<comment>Return:</comment>
  <info>string</info>  The quoted string.


id: Session::releaseSavepoint
type: function
doc:
<comment>Description:</comment>
  Release set savepoint
  
  Release a previously set savepoint.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the savepoint to release.

<comment>Return:</comment>
  <info>void</info>  An SqlStatementResult object.


id: Session::rollback
type: function
doc:
<comment>Description:</comment>
  Rollback transaction
  
  Rollback the transaction.

<comment>Return:</comment>
  <info>void</info>  An SqlStatementResult object.


id: Session::rollbackTo
type: function
doc:
<comment>Description:</comment>
  Rollback transaction to savepoint
  
  Rollback the transaction back to the savepoint.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the savepoint to rollback to; case-insensitive.

<comment>Return:</comment>
  <info>void</info>  An SqlStatementResult object.


id: Session::setSavepoint
type: function
doc:
<comment>Description:</comment>
  Create savepoint
  
  Create a new savepoint for the transaction.
  
  This function is
  currently not documented; only its argument list is available.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the savepoint. The name is auto-generated if the optional <return>name</return>
                 parameter is not defined as 'SAVEPOINT1', 'SAVEPOINT2', and so on.

<comment>Return:</comment>
  <info>string</info>  The name of the save point.


id: Session::sql
type: function
doc:
<comment>Description:</comment>
  Create SQL query
  
  Create a native SQL statement. Placeholders are supported using the native "?" syntax. Use the
  <return>execute</return> method to execute the SQL statement.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  SQL statement to execute.

<comment>Return:</comment>
  <info>mysql_xdevapi\SqlStatement</info>  An SqlStatement object.


id: Session::startTransaction
type: function
doc:
<comment>Description:</comment>
  Start transaction
  
  Start a new transaction.

<comment>Return:</comment>
  <info>void</info>  An SqlStatementResult object.


id: SessionHandler
type: class
doc:
<comment>Description:</comment>
  <class>SessionHandler</class> is a special class that can be used to expose the current internal PHP session save
  handler by inheritance. There are seven methods which wrap the seven internal session save handler
  callbacks (<strong>$open</strong>, <strong>$close</strong>, <strong>$read</strong>, <strong>$write</strong>, <strong>$destroy</strong>, <strong>$gc</strong> and <strong>$create_sid</strong>).  By default, this class
  will wrap whatever internal save handler is set as defined by the session.save_handler
  configuration directive which is usually <strong>$files</strong> by default.  Other internal session save handlers
  are provided by PHP extensions such as SQLite (as <strong>$sqlite</strong>), Memcache (as <strong>$memcache</strong>), and Memcached
  (as <strong>$memcached</strong>).
  
  When a plain instance of <class>SessionHandler</class> is set as the save handler using
  <strong>session_set_save_handler()</strong> it will wrap the current save handlers. A class extending from
  <class>SessionHandler</class> allows you to override the methods or intercept or filter them by calls the parent
  class methods which ultimately wrap the internal PHP session handlers.
  
  This allows you, for example, to intercept the <strong>$read</strong> and <strong>$write</strong> methods to encrypt/decrypt the
  session data and then pass the result to and from the parent class. Alternatively one might chose
  to entirely override a method like the garbage collection callback <strong>$gc</strong>.
  
  Because the <class>SessionHandler</class> wraps the current internal save handler methods, the above example of
  encryption can be applied to any internal save handler without having to know the internals of the
  handlers.
  
  To use this class, first set the save handler you wish to expose using session.save_handler and
  then pass an instance of <class>SessionHandler</class> or one extending it to <strong>session_set_save_handler()</strong>.
  
  Please note that the callback methods of this class are designed to be called internally by PHP
  and are not meant to be called from user-space code.  The return values are equally processed
  internally by PHP.  For more information on the session workflow, please refer to
  <strong>session_set_save_handler()</strong>.


id: SessionHandler::close
type: function
doc:
<comment>Description:</comment>
  Close the session
  
  Closes the current session. This method is automatically executed internally by PHP when closing
  the session, or explicitly via <strong>session_write_close()</strong> (which first calls the
  <strong>SessionHandler::write()</strong>).
  
  This method wraps the internal PHP save handler defined in the session.save_handler ini setting
  that was set before this handler was activated by <strong>session_set_save_handler()</strong>.
  
  If this class is extended by inheritance, calling the parent <strong>$close</strong> method will invoke the wrapper
  for this method and therefore invoke the associated internal callback.  This allows the method to
  be overridden and or intercepted.
  
  For more information on what this method is expected to do, please refer to the documentation at
  <strong>SessionHandlerInterface::close()</strong>.

<comment>Return:</comment>
  <info>bool</info>  The return value (usually <info>true</info> on success, <info>false</info> on failure). Note this value is returned
        internally to PHP for processing.


id: SessionHandler::create_sid
type: function
doc:
<comment>Description:</comment>
  Return a new session ID
  
  Generates and returns a new session ID.

<comment>Return:</comment>
  <info>string</info>  A session ID valid for the default session handler.

<comment>See Also:</comment>
   * <strong>session_id()</strong>
   * <strong>session_create_id()</strong>


id: SessionHandler::destroy
type: function
doc:
<comment>Description:</comment>
  Destroy a session
  
  Destroys a session. Called internally by PHP with <strong>session_regenerate_id()</strong> (assuming the <strong>$destroy</strong>
  is set to <info>true</info>, by <strong>session_destroy()</strong> or when <strong>session_decode()</strong> fails.
  
  This method wraps the internal PHP save handler defined in the session.save_handler ini setting
  that was set before this handler was set by <strong>session_set_save_handler()</strong>.
  
  If this class is extended by inheritance, calling the parent <strong>$destroy</strong> method will invoke the
  wrapper for this method and therefore invoke the associated internal callback.  This allows this
  method to be overridden and or intercepted and filtered.
  
  For more information on what this method is expected to do, please refer to the documentation at
  <strong>SessionHandlerInterface::destroy()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The session ID being destroyed.

<comment>Return:</comment>
  <info>bool</info>  The return value (usually <info>true</info> on success, <info>false</info> on failure). Note this value is returned
        internally to PHP for processing.


id: SessionHandler::gc
type: function
doc:
<comment>Description:</comment>
  Cleanup old sessions
  
  Cleans up expired sessions. Called randomly by PHP internally when a session starts or when
  <strong>session_start()</strong> is invoked.  The frequency this is called is based on the session.gc_divisor and
  session.gc_probability configuration directives.
  
  This method wraps the internal PHP save handler defined in the session.save_handler ini setting
  that was set before this handler was set by <strong>session_set_save_handler()</strong>.
  
  If this class is extended by inheritance, calling the parent <strong>$gc</strong> method will invoke the wrapper
  for this method and therefore invoke the associated internal callback.  This allows this method to
  be overridden and or intercepted and filtered.
  
  For more information on what this method is expected to do, please refer to the documentation at
  <strong>SessionHandlerInterface::gc()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$max_lifetime</strong>  Sessions that have not updated for the last <strong>$max_lifetime</strong> seconds will be
                      removed.

<comment>Return:</comment>
  <info>int|false</info>  Returns the number of deleted sessions on success,  or <info>false</info> on failure. Note this
             value is returned internally to PHP for processing.


id: SessionHandler::open
type: function
doc:
<comment>Description:</comment>
  Initialize session
  
  Create new session, or re-initialize existing session. Called internally by PHP when a session
  starts either automatically or when <strong>session_start()</strong> is invoked.
  
  This method wraps the internal PHP save handler defined in the session.save_handler ini setting
  that was set before this handler was set by <strong>session_set_save_handler()</strong>.
  
  If this class is extended by inheritance, calling the parent <strong>$open</strong> method will invoke the wrapper
  for this method and therefore invoke the associated internal callback.  This allows this method to
  be overridden and or intercepted and filtered.
  
  For more information on what this method is expected to do, please refer to the documentation at
  <strong>SessionHandlerInterface::open()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  The path where to store/retrieve the session.
  <info>string</info>  <strong>$name</strong>  The session name.

<comment>Return:</comment>
  <info>bool</info>  The return value (usually <info>true</info> on success, <info>false</info> on failure). Note this value is returned
        internally to PHP for processing.

<comment>See Also:</comment>
   * 
     The session.auto-start
     configuration directive.
    


id: SessionHandler::read
type: function
doc:
<comment>Description:</comment>
  Read session data
  
  Reads the session data from the session storage, and returns the result back to PHP for internal
  processing. This method is called automatically by PHP when a session is started (either
  automatically or explicitly with <strong>session_start()</strong> and is preceded by an internal call to the
  <strong>SessionHandler::open()</strong>.
  
  This method wraps the internal PHP save handler defined in the session.save_handler ini setting
  that was set before this handler was set by <strong>session_set_save_handler()</strong>.
  
  If this class is extended by inheritance, calling the parent <strong>$read</strong> method will invoke the wrapper
  for this method and therefore invoke the associated internal callback.  This allows the method to
  be overridden and or intercepted and filtered (for example, decrypting the <strong>$data</strong> value returned by
  the parent <strong>$read</strong> method).
  
  For more information on what this method is expected to do, please refer to the documentation at
  <strong>SessionHandlerInterface::read()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The session id to read data for.

<comment>Return:</comment>
  <info>string|false</info>  Returns an encoded string of the read data. If nothing was read, it must return
                <info>false</info>. Note this value is returned internally to PHP for processing.

<comment>See Also:</comment>
   * 
     The session.serialize_handler
     configuration directive.
    


id: SessionHandler::write
type: function
doc:
<comment>Description:</comment>
  Write session data
  
  Writes the session data to the session storage. Called by normal PHP shutdown, by
  <strong>session_write_close()</strong>, or when <strong>session_register_shutdown()</strong> fails. PHP will call
  <strong>SessionHandler::close()</strong> immediately after this method returns.
  
  This method wraps the internal PHP save handler defined in the session.save_handler ini setting
  that was set before this handler was set by <strong>session_set_save_handler()</strong>.
  
  If this class is extended by inheritance, calling the parent <strong>$write</strong> method will invoke the wrapper
  for this method and therefore invoke the associated internal callback.  This allows this method to
  be overridden and or intercepted and filtered (for example, encrypting the <strong>$data</strong> value before
  sending it to the parent <strong>$write</strong> method).
  
  For more information on what this method is expected to do, please refer to the documentation at
  <strong>SessionHandlerInterface::write()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>    The session id.
  <info>string</info>  <strong>$data</strong>  The encoded session data.  This data is the result of the PHP internally encoding
                 the $_SESSION superglobal to a serialized string and passing it as this parameter.
                 Please note sessions use an alternative serialization method.

<comment>Return:</comment>
  <info>bool</info>  The return value (usually <info>true</info> on success, <info>false</info> on failure). Note this value is returned
        internally to PHP for processing.

<comment>See Also:</comment>
   * 
     The session.serialize_handler
     configuration directive.
    


id: SessionHandlerInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionHandlerInterface</class> is an interface which defines the minimal prototype for creating a custom
  session handler. In order to pass a custom session handler to <strong>session_set_save_handler()</strong> using its
  OOP invocation, the class can implement this interface.
  
  Please note the callback methods of this class are designed to be called internally by PHP and are
  not meant to be called from user-space code.


id: SessionHandlerInterface::close
type: function
doc:
<comment>Description:</comment>
  Close the session
  
  Closes the current session. This function is automatically executed when closing the session, or
  explicitly via <strong>session_write_close()</strong>.

<comment>Return:</comment>
  <info>bool</info>  The return value (usually <info>true</info> on success, <info>false</info> on failure). Note this value is returned
        internally to PHP for processing.


id: SessionHandlerInterface::destroy
type: function
doc:
<comment>Description:</comment>
  Destroy a session
  
  Destroys a session. Called by <strong>session_regenerate_id()</strong> (with $destroy = <info>true</info>), <strong>session_destroy()</strong>
  and when <strong>session_decode()</strong> fails.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The session ID being destroyed.

<comment>Return:</comment>
  <info>bool</info>  The return value (usually <info>true</info> on success, <info>false</info> on failure). Note this value is returned
        internally to PHP for processing.


id: SessionHandlerInterface::gc
type: function
doc:
<comment>Description:</comment>
  Cleanup old sessions
  
  Cleans up expired sessions. Called by <strong>session_start()</strong>, based on session.gc_divisor,
  session.gc_probability and session.gc_maxlifetime settings.

<comment>Param:</comment>
  <info>int</info>  <strong>$max_lifetime</strong>  Sessions that have not updated for the last <strong>$max_lifetime</strong> seconds will be
                      removed.

<comment>Return:</comment>
  <info>int|false</info>  Returns the number of deleted sessions on success,  or <info>false</info> on failure. Note this
             value is returned internally to PHP for processing.


id: SessionHandlerInterface::open
type: function
doc:
<comment>Description:</comment>
  Initialize session
  
  Re-initialize existing session, or creates a new one. Called when a session starts or when
  <strong>session_start()</strong> is invoked.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  The path where to store/retrieve the session.
  <info>string</info>  <strong>$name</strong>  The session name.

<comment>Return:</comment>
  <info>bool</info>  The return value (usually <info>true</info> on success, <info>false</info> on failure). Note this value is returned
        internally to PHP for processing.

<comment>See Also:</comment>
   * <strong>session_name()</strong>
   * 
     The session.auto-start
     configuration directive.
    


id: SessionHandlerInterface::read
type: function
doc:
<comment>Description:</comment>
  Read session data
  
  Reads the session data from the session storage, and returns the results. Called right after the
  session starts or when <strong>session_start()</strong> is called. Please note that before this method is called
  <strong>SessionHandlerInterface::open()</strong> is invoked.
  
  This method is called by PHP itself when the session is started. This method should retrieve the
  session data from storage by the session ID provided. The string returned by this method must be
  in the same serialized format as when originally passed to the <strong>SessionHandlerInterface::write()</strong> If
  the record was not found, return <info>false</info>.
  
  The data returned by this method will be decoded internally by PHP using the unserialization
  method specified in session.serialize_handler. The resulting data will be used to populate the
  $_SESSION superglobal.
  
  Note that the serialization scheme is not the same as <strong>unserialize()</strong> and can be accessed by
  <strong>session_decode()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The session id.

<comment>Return:</comment>
  <info>string|false</info>  Returns an encoded string of the read data. If nothing was read, it must return
                <info>false</info>. Note this value is returned internally to PHP for processing.

<comment>See Also:</comment>
   * 
     The session.serialize_handler
     configuration directive.
    


id: SessionHandlerInterface::write
type: function
doc:
<comment>Description:</comment>
  Write session data
  
  Writes the session data to the session storage. Called by <strong>session_write_close()</strong>, when
  <strong>session_register_shutdown()</strong> fails, or during a normal shutdown. Note:
  <strong>SessionHandlerInterface::close()</strong> is called immediately after this function.
  
  PHP will call this method when the session is ready to be saved and closed. It encodes the session
  data from the $_SESSION superglobal to a serialized string and passes this along with the session
  ID to this method for storage.  The serialization method used is specified in the
  session.serialize_handler setting.
  
  Note this method is normally called by PHP after the output buffers have been closed unless
  explicitly called by <strong>session_write_close()</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>    The session id.
  <info>string</info>  <strong>$data</strong>  The encoded session data.  This data is the result of the PHP internally encoding
                 the $_SESSION superglobal to a serialized string and passing it as this parameter.
                 Please note sessions use an alternative serialization method.

<comment>Return:</comment>
  <info>bool</info>  The return value (usually <info>true</info> on success, <info>false</info> on failure). Note this value is returned
        internally to PHP for processing.

<comment>See Also:</comment>
   * 
     The session.serialize_handler
     configuration directive.
    


id: SessionIdInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionIdInterface</class> is an interface which defines optional methods for creating a custom session
  handler. In order to pass a custom session handler to <strong>session_set_save_handler()</strong> using its OOP
  invocation, the class can implement this interface.
  
  Note that the callback methods of classes implementing this interface are designed to be called
  internally by PHP and are not meant to be called from user-space code.


id: SessionIdInterface::create_sid
type: function
doc:
<comment>Description:</comment>
  Create session ID
  
  Creates a new session ID.This function is automatically executed when a new session ID needs to be
  created.

<comment>Return:</comment>
  <info>string</info>  The new session ID. Note that this value is returned internally to PHP for processing.

<comment>See Also:</comment>
   * SessionHandler::create_sid


id: SessionUpdateTimestampHandlerInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionUpdateTimestampHandlerInterface</class> is an interface which defines optional methods for creating
  a custom session handler. In order to pass a custom session handler to <strong>session_set_save_handler()</strong>
  using its OOP invocation, the class can implement this interface.
  
  Note that the callback methods of classes implementing this interface are designed to be called
  internally by PHP and are not meant to be called from user-space code.


id: SessionUpdateTimestampHandlerInterface::updateTimestamp
type: function
doc:
<comment>Description:</comment>
  Update timestamp
  
  Updates the last modification timestamp of the session. This function is automatically executed
  when a session is updated.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>    The session ID.
  <info>string</info>  <strong>$data</strong>  The session data.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the timestamp was updated, <info>false</info> otherwise. Note that this value is returned
        internally to PHP for processing.


id: SessionUpdateTimestampHandlerInterface::validateId
type: function
doc:
<comment>Description:</comment>
  Validate ID
  
  Validates a given session ID. A session ID is valid, if a session with that ID already exists.
  This function is automatically executed when a session is to be started, a session ID is supplied
  and session.use_strict_mode is enabled.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The session ID.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> for valid ID, <info>false</info> otherwise. Note that this value is returned internally to
        PHP for processing.


id: Shmop
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces <return>shmop</return> resources as of PHP 8.0.0.


id: SimdJsonException
type: class
doc:
<comment>Description:</comment>
  Exception thrown if <strong>simdjson_decode()</strong>, <strong>simdjson_key_count()</strong>, <strong>simdjson_key_exists()</strong>, or
  <strong>simdjson_key_value()</strong>.
   For possible values see the simdjson error codes constants.


id: SimdJsonValueError
type: class
doc:
<comment>Description:</comment>
  A <class>SimdJsonValueError</class> is thrown when the type of an argument to a function from simdjson is correct
  but the value of it is incorrect. E.g. when the JSON decoding $depth is not positive or the $depth
  is too large.


id: SimpleXMLElement::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new SimpleXMLElement object
    
  
  Creates a new <class>SimpleXMLElement</class> object.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>               A well-formed XML string or the path or URL to an XML document if
                              <strong>$dataIsURL</strong> is <info>true</info>.
  <info>int</info>     <strong>$options</strong>            Optionally used to specify additional Libxml parameters, which affect
                              reading of XML documents. Options which affect the output of XML
                              documents (e.g. <info>LIBXML_NOEMPTYTAG</info>) are silently ignored.
                              
                              It may be necessary to pass <info>LIBXML_PARSEHUGE</info> to be able to process
                              deeply nested XML or very large text nodes.
  <info>bool</info>    <strong>$dataIsURL</strong>          By default, <strong>$dataIsURL</strong> is <info>false</info>. Use <info>true</info> to specify that <strong>$data</strong> is a
                              path or URL to an XML  document instead of <info>string</info> data.
  <info>string</info>  <strong>$namespaceOrPrefix</strong>  Namespace prefix or URI.
  <info>bool</info>    <strong>$isPrefix</strong>           <info>true</info> if <strong>$namespaceOrPrefix</strong> is a prefix, <info>false</info> if it's a URI; defaults
                              to <info>false</info>.

<comment>See Also:</comment>
   * 
   * <strong>simplexml_load_string()</strong>
   * <strong>simplexml_load_file()</strong>
   * 
   * <strong>libxml_use_internal_errors()</strong>
   * <strong>libxml_set_streams_context()</strong>


id: SimpleXMLElement::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string content
  
  Returns text content that is directly in this element. Does not return text content that is inside
  this element's children.

<comment>Return:</comment>
  <info>string</info>  Returns the string content on success or an empty string on failure.

<comment>See Also:</comment>
   * SimpleXMLElement::asXML


id: SimpleXMLElement::addAttribute
type: function
doc:
<comment>Description:</comment>
  Adds an attribute to the SimpleXML element
    
  
  Adds an attribute to the SimpleXML element.

<comment>Param:</comment>
  <info>string</info>       <strong>$qualifiedName</strong>  The name of the attribute to add.
  <info>string</info>       <strong>$value</strong>          The value of the attribute.
  <info>string|null</info>  <strong>$namespace</strong>      If specified, the namespace to which the attribute belongs.

<comment>Return:</comment>
  <info>void</info>  No value is returned.

<comment>See Also:</comment>
   * SimpleXMLElement::addChild
   * 


id: SimpleXMLElement::addChild
type: function
doc:
<comment>Description:</comment>
  Adds a child element to the XML node
    
  
  Adds a child element to the node and returns a SimpleXMLElement of the child.

<comment>Param:</comment>
  <info>string</info>       <strong>$qualifiedName</strong>  The name of the child element to add.
  <info>string|null</info>  <strong>$value</strong>          If specified, the value of the child element.
  <info>string|null</info>  <strong>$namespace</strong>      If specified, the namespace to which the child element belongs.

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  The <return>addChild</return> method returns a <info>SimpleXMLElement</info> object representing the
                         child added to the XML node on success; <info>null</info> on failure.

<comment>See Also:</comment>
   * SimpleXMLElement::addAttribute
   * 


id: SimpleXMLElement::asXML
type: function
doc:
<comment>Description:</comment>
  Return a well-formed XML string based on SimpleXML element
    
  
  The <return>asXML</return> method formats the parent object's data in XML version 1.0.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  If a <info>string</info> value is provided, the function writes the data to the file
                          rather than returning it.

<comment>Return:</comment>
  <info>string|bool</info>  If the <strong>$filename</strong> isn't specified, this function returns a <info>string</info> on success and <info>false</info>
               on error. If the parameter is specified, it returns <info>true</info> if the file was written
               successfully and <info>false</info> otherwise.

<comment>See Also:</comment>
   * SimpleXMLElement::__toString
   * 


id: SimpleXMLElement::attributes
type: function
doc:
<comment>Description:</comment>
  Identifies an element's attributes
  
  This function provides the attributes and values defined within an xml tag.
  
  SimpleXML has made a rule of adding
  iterative properties to most methods. They cannot be viewed using <strong>var_dump()</strong>
  or anything else which can examine objects.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespaceOrPrefix</strong>  An optional namespace for the retrieved attributes
  <info>bool</info>         <strong>$isPrefix</strong>           Default to <info>false</info>

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  Returns a <class>SimpleXMLElement</class> object that can be iterated over to loop through
                         the attributes on the tag.
                         
                         Returns <info>null</info> if called on a <class>SimpleXMLElement</class> object that already represents
                         an attribute and not a tag.

<comment>See Also:</comment>
   * 


id: SimpleXMLElement::children
type: function
doc:
<comment>Description:</comment>
  Finds children of given node
  
  This method finds the children of an element. The result follows normal iteration rules.
  
  SimpleXML has made a rule of adding
  iterative properties to most methods. They cannot be viewed using <strong>var_dump()</strong>
  or anything else which can examine objects.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespaceOrPrefix</strong>  An XML namespace.
  <info>bool</info>         <strong>$isPrefix</strong>           If <strong>$isPrefix</strong> is <info>true</info>, <strong>$namespaceOrPrefix</strong> will be regarded as a
                                   prefix. If <info>false</info>, <strong>$namespaceOrPrefix</strong> will be regarded as a
                                   namespace URL.

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  Returns a <class>SimpleXMLElement</class> element, whether the node  has children or not,
                         unless the node represents an attribute, in which case <info>null</info> is returned.

<comment>See Also:</comment>
   * SimpleXMLElement::count
   * <strong>count()</strong>


id: SimpleXMLElement::count
type: function
doc:
<comment>Description:</comment>
  Counts the children of an element
  
  This method counts the number of children of an element.

<comment>Return:</comment>
  <info>int</info>  Returns the number of elements of an element.

<comment>See Also:</comment>
   * SimpleXMLElement::children


id: SimpleXMLElement::current
type: function
doc:
<comment>Description:</comment>
  Returns the current element
  
  Prior to PHP 8.0, SimpleXMLElement::current was only declared on the subclass <class>SimpleXMLIterator</class>.
  
  This method returns the current element as a <class>SimpleXMLElement</class> object.

<comment>Return:</comment>
  <info>SimpleXMLElement</info>  Returns the current element as a <class>SimpleXMLElement</class> object.

<comment>See Also:</comment>
   * SimpleXMLElement::key
   * SimpleXMLElement::next
   * SimpleXMLElement::rewind
   * SimpleXMLElement::valid
   * <class>SimpleXMLElement</class>


id: SimpleXMLElement::getChildren
type: function
doc:
<comment>Description:</comment>
  Returns the sub-elements of the current element
  
  Prior to PHP 8.0, SimpleXMLElement::getChildren was only declared on the subclass
  <class>SimpleXMLIterator</class>.
  
  This method returns a <class>SimpleXMLElement</class> object containing sub-elements of the current
  <class>SimpleXMLElement</class> element.

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  Returns a <class>SimpleXMLElement</class> object containing the sub-elements of the
                         current element.


id: SimpleXMLElement::getDocNamespaces
type: function
doc:
<comment>Description:</comment>
  Returns namespaces declared in document
    
  
  Returns namespaces declared in document

<comment>Param:</comment>
  <info>bool</info>  <strong>$recursive</strong>  If specified, returns all namespaces declared in parent and child nodes.
                    Otherwise, returns only namespaces declared in root node.
  <info>bool</info>  <strong>$fromRoot</strong>   Allows you to recursively check namespaces under a child node instead of from
                    the root of the XML doc.

<comment>Return:</comment>
  <info>array|false</info>  The <return>getDocNamespaces</return> method returns an <info>array</info>  of namespace names with their
               associated URIs.

<comment>See Also:</comment>
   * SimpleXMLElement::getNamespaces
   * SimpleXMLElement::registerXPathNamespace


id: SimpleXMLElement::getName
type: function
doc:
<comment>Description:</comment>
  Gets the name of the XML element
  
  Gets the name of the XML element.

<comment>Return:</comment>
  <info>string</info>  The <return>getName</return> method returns as a <info>string</info> the  name of the XML tag referenced by the
          SimpleXMLElement object.


id: SimpleXMLElement::getNamespaces
type: function
doc:
<comment>Description:</comment>
  Returns namespaces used in document
    
  
  Returns namespaces used in document

<comment>Param:</comment>
  <info>bool</info>  <strong>$recursive</strong>  If specified, returns all namespaces used in parent and child nodes.  Otherwise,
                    returns only namespaces used in root node.

<comment>Return:</comment>
  <info>array</info>  The <return>getNamespaces</return> method returns an <info>array</info> of  namespace names with their associated URIs.

<comment>See Also:</comment>
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::registerXPathNamespace


id: SimpleXMLElement::hasChildren
type: function
doc:
<comment>Description:</comment>
  Checks whether the current element has sub elements
  
  Prior to PHP 8.0, SimpleXMLElement::hasChildren was only declared on the subclass
  <class>SimpleXMLIterator</class>.
  
  This method checks whether the current <class>SimpleXMLElement</class> element has sub-elements.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the current element has sub-elements, otherwise <info>false</info>


id: SimpleXMLElement::key
type: function
doc:
<comment>Description:</comment>
  Return current key
  
  Prior to PHP 8.0, SimpleXMLElement::key was only declared on the subclass <class>SimpleXMLIterator</class>.
  
  This method gets the XML tag name of the current element.

<comment>Return:</comment>
  <info>string</info>  Returns the XML tag name of the element referenced by the current <class>SimpleXMLElement</class> object.


id: SimpleXMLElement::next
type: function
doc:
<comment>Description:</comment>
  Move to next element
  
  Prior to PHP 8.0, SimpleXMLElement::next was only declared on the subclass <class>SimpleXMLIterator</class>.
  
  This method moves the <class>SimpleXMLElement</class> to the next element.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: SimpleXMLElement::registerXPathNamespace
type: function
doc:
<comment>Description:</comment>
  Creates a prefix/ns context for the next XPath query
    
  
  Creates a prefix/ns context for the next XPath query. In particular, this is helpful if the
  provider of the given XML document alters the namespace prefixes. <return>registerXPathNamespace</return> will
  create a prefix for the associated namespace, allowing one to access nodes in that namespace
  without the need to change code to allow for the new prefixes dictated by the provider.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>     The namespace prefix to use in the XPath query for the namespace given in
                      <strong>$namespace</strong>.
  <info>string</info>  <strong>$namespace</strong>  The namespace to use for the XPath query. This must match a namespace in use
                      by the XML document or the XPath query using  <strong>$prefix</strong> will not return any
                      results.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * SimpleXMLElement::xpath
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::getNamespaces


id: SimpleXMLElement::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind to the first element
  
  Prior to PHP 8.0, SimpleXMLElement::rewind was only declared on the subclass <class>SimpleXMLIterator</class>.
  
  This method rewinds the <class>SimpleXMLElement</class> to the first element.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: SimpleXMLElement::saveXML
type: function
doc:
<comment>Description:</comment>
  Alias of SimpleXMLElement::asXML
  
  This method is an alias of:  SimpleXMLElement::asXML


id: SimpleXMLElement::valid
type: function
doc:
<comment>Description:</comment>
  Check whether the current element is valid
  
  Prior to PHP 8.0, SimpleXMLElement::valid was only declared on the subclass <class>SimpleXMLIterator</class>.
  
  This method checks if the current element is valid after calls to SimpleXMLElement::rewind or
  SimpleXMLElement::next.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the current element is valid, otherwise <info>false</info>


id: SimpleXMLElement::xpath
type: function
doc:
<comment>Description:</comment>
  Runs XPath query on XML data
  
  The <return>xpath</return> method searches the SimpleXML node for children matching the XPath <strong>$expression</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$expression</strong>  An XPath path

<comment>Return:</comment>
  <info>array|null|false</info>  Returns an <info>array</info> of SimpleXMLElement objects on success; or <info>null</info> or <info>false</info> in
                    case of an error.

<comment>See Also:</comment>
   * SimpleXMLElement::registerXPathNamespace
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::getNamespaces
   * 


id: SimpleXMLIterator
type: class
doc:
<comment>Description:</comment>
  The SimpleXMLIterator provides recursive iteration over all nodes of a <class>SimpleXMLElement</class> object.


id: SoapClient
type: class
doc:
<comment>Description:</comment>
  The SoapClient class provides a client for SOAP 1.1, SOAP 1.2 servers. It can be used in WSDL or
  non-WSDL mode.


id: SoapClient::__call
type: function
doc:
<comment>Description:</comment>
  Calls a SOAP function (deprecated)
  
  Calling this method directly is deprecated. Usually, SOAP functions can be called as methods of
  the <class>SoapClient</class> object; in situations where this is not possible or additional options are needed,
  use SoapClient::__soapCall.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the SOAP function to call.
  <info>array</info>   <strong>$args</strong>  An array of the arguments to pass to the function. This can be either an ordered or
                 an associative array. Note that most SOAP servers require parameter names to be
                 provided, in which case this must be an associative array.

<comment>Return:</comment>
  <info>mixed</info>  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.
         
         On error, if the <class>SoapClient</class> object was constructed with the <return>exceptions</return> option set to <info>false</info>,
         a <class>SoapFault</class> object will be returned.


id: SoapClient::__construct
type: function
doc:
<comment>Description:</comment>
  SoapClient constructor
  
  Creates a <class>SoapClient</class> object to connect to a SOAP service.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$wsdl</strong>                URI of a WSDL file describing the service, which is used to
                                    automatically configure the client. If not provided, the client
                                    will operate in non-WSDL mode.
                                    
                                    By default, the WSDL file will be cached for performance. To
                                    disable or configure this caching, see SOAP Configure Options
                                    and the <return>cache_wsdl</return> option.
  <info>array</info>        <strong>$options</strong>             An associative array specifying additional options for the SOAP
                                    client. If <strong>$wsdl</strong> is provided, this is optional; otherwise, at
                                    least <return>location</return> and <return>url</return> must be provided. <strong>$location</strong><info>string</info> The URL
                                    of the SOAP server to send the request to.  Required if the
                                    <strong>$wsdl</strong> parameter is not provided. If both a <strong>$wsdl</strong> parameter and
                                    <return>location</return> option are provided, the <return>location</return> option will over-ride
                                    any location specified in the WSDL file. <strong>$uri</strong><info>string</info> The target
                                    namespace of the SOAP service.  Required if the <strong>$wsdl</strong> parameter
                                    is not provided; ignored otherwise. <strong>$style</strong><info>int</info> Specifies the
                                    binding style to use for this client, using the constants
                                    <info>SOAP_RPC</info> and <info>SOAP_DOCUMENT</info>. <info>SOAP_RPC</info> indicates RPC-style
                                    binding, where the SOAP request body contains a standard
                                    encoding of a function call. <info>SOAP_DOCUMENT</info> indicates
                                    document-style binding, where the SOAP request body contains an
                                    XML document with service-defined meaning.  If the <strong>$wsdl</strong>
                                    parameter is provided, this option is ignored, and the style is
                                    read from the WSDL file.  If neither this option nor the <strong>$wsdl</strong>
                                    parameter is provided, RPC-style is used. <strong>$use</strong><info>int</info> Specifies the
                                    encoding style to use for this client, using the constants
                                    <info>SOAP_ENCODED</info> or <info>SOAP_LITERAL</info>. <info>SOAP_ENCODED</info> indicates encoding
                                    using the types defined in the SOAP specification. <info>SOAP_LITERAL</info>
                                    indicates encoding using a schema defined by the service.  If
                                    the <strong>$wsdl</strong> parameter is provided, this option is ignored, and the
                                    encoding is read from the WSDL file.  If neither this option nor
                                    the <strong>$wsdl</strong> parameter is provided, the "encoded" style is used.
                                    <strong>$soap_version</strong><info>int</info> Specifies the version of the SOAP protocol to
                                    use: <info>SOAP_1_1</info> for SOAP 1.1, or <info>SOAP_1_2</info> for SOAP 1.2.  If
                                    omitted, SOAP 1.1 is used. <strong>$authentication</strong><info>int</info> Specifies the
                                    authentication method when using HTTP authentication in
                                    requests. The value may be either <info>SOAP_AUTHENTICATION_BASIC</info> or
                                    <info>SOAP_AUTHENTICATION_DIGEST</info>.  If omitted, and the <return>login</return> option is
                                    provided, Basic Authentication is used. <strong>$login</strong><info>string</info> Username to
                                    use with HTTP Basic or Digest Authentication. <strong>$password</strong><info>string</info>
                                    Password to use with HTTP Basic or Digest Authentication.  Not
                                    to be confused with <return>passphrase</return>, which is used with HTTPS Client
                                    Certificate authentication. <strong>$local_cert</strong><info>string</info> Path to a client
                                    certificate for use with HTTPS authentication. It must be a PEM
                                    encoded file which contains your certificate and private key.
                                    The file can also include a chain of issuers, which must come
                                    after the client certificate.  Can also be set via
                                    <strong>$stream_context</strong>, which also supports specifying a separate
                                    private key file. <strong>$passphrase</strong><info>string</info> Passphrase for the client
                                    certificate specified in the <return>local_cert</return> option.  Not to be
                                    confused with <return>password</return>, which is used for Basic or Digest
                                    Authentication.  Can also be set via <strong>$stream_context</strong>.
                                    <strong>$proxy_host</strong><info>string</info> Hostname to use as a proxy server for HTTP
                                    requests.  The <return>proxy_port</return> option must also be specified.
                                    <strong>$proxy_port</strong><info>int</info> TCP port to use when connecting to the proxy
                                    server specified in <return>proxy_host</return>. <strong>$proxy_login</strong><info>string</info> Optional
                                    username to authenticate with the proxy server specified in
                                    <return>proxy_host</return>, using HTTP Basic Authentication.
                                    <strong>$proxy_password</strong><info>string</info> Optional password to authenticate with the
                                    proxy server specified in <return>proxy_host</return>, using HTTP Basic
                                    Authentication. <strong>$compression</strong><info>int</info> Enables compression of HTTP SOAP
                                    requests and responses.  The value should be the bitwise OR of
                                    three parts: an optional <info>SOAP_COMPRESSION_ACCEPT</info>, to send an
                                    "Accept-Encoding" header; either <info>SOAP_COMPRESSION_GZIP</info> or
                                    <info>SOAP_COMPRESSION_DEFLATE</info> to indicate the compression algorithm
                                    to use; and a number between 1 and 9 to indicate the level of
                                    compression to use in the request. For example, to enable
                                    two-way gzip compression with the maximum compression level, use
                                    <return>SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP | 9</return>.
                                    <strong>$encoding</strong><info>string</info> Defines the internal character encoding.
                                    Requests are always sent in UTF-8, and converted to and from
                                    this encoding. <strong>$trace</strong><info>bool</info> Captures request and response
                                    information, which can then be accessed with the methods
                                    SoapClient::__getLastRequest,
                                    SoapClient::__getLastRequestHeaders,
                                    SoapClient::__getLastResponse, and
                                    SoapClient::__getLastResponseHeaders.  If omitted, defaults to
                                    <info>false</info> <strong>$classmap</strong><info>array</info> Used to map types defined in the WSDL to
                                    PHP classes. It should be specified as an associative <info>array</info> with
                                    type names from the WSDL as keys and names of PHP classes as
                                    values. Note that the type names of an element is not
                                    necessarily the same as the element (tag) name.  The provided
                                    class names should always be fully qualified with any
                                    namespaces, and never start with a leading <return>\</return>. The correct form
                                    can be generated by using ::class.  Note that when creating a
                                    class, the constructor will not be called, but magic __set() and
                                    __get() methods for individual properties will be. <strong>$typemap</strong><info>array</info>
                                    Used to define type mappings using user-defined callback
                                    functions. Each type mapping should be an array with keys
                                    <return>type_name</return> (<info>string</info> specifying the XML element type); <return>type_ns</return>
                                    (<info>string</info> containing namespace URI); <return>from_xml</return> (<info>callable</info> accepting
                                    one string parameter and returning an object) and <return>to_xml</return>
                                    (<info>callable</info> accepting one object parameter and returning a
                                    string). <strong>$exceptions</strong><info>bool</info> Defines whether errors throw exceptions
                                    of type <class>SoapFault</class>.  Defaults to <info>true</info> <strong>$connection_timeout</strong><info>int</info>
                                    Defines a timeout in seconds for the connection to the SOAP
                                    service. This option does not define a timeout for services with
                                    slow responses. To limit the time to wait for calls to finish
                                    the default_socket_timeout configuration option is available.
                                    <strong>$cache_wsdl</strong><info>int</info> If the <strong>$wsdl</strong> parameter is provided, and the
                                    soap.wsdl_cache_enabled configuration option is on, this option
                                    determines the type of caching. One of <info>WSDL_CACHE_NONE</info>,
                                    <info>WSDL_CACHE_DISK</info>, <info>WSDL_CACHE_MEMORY</info> or <info>WSDL_CACHE_BOTH</info>.  Two
                                    types of cache are available: in-memory caching, which caches
                                    the WSDL in the memory of the current process; and disk caching,
                                    which caches the WSDL in a file on disk, shared between all
                                    processes. The directory to use for the disk cache is determined
                                    by the soap.wsdl_cache_dir configuration option. Both caches use
                                    the same lifetime, determined by the soap.wsdl_cache_ttl
                                    configuration option. The in-memory cache also has a maximum
                                    number of entries determined by the soap.wsdl_cache_limit
                                    configuration option.  If not specified, the  soap.wsdl_cache
                                    configuration option will be used. <strong>$user_agent</strong><info>string</info> The value
                                    to use in the <return>User-Agent</return> HTTP header when making requests.  Can
                                    also be set via <strong>$stream_context</strong>.  If not specified, the user
                                    agent will be <return>"PHP-SOAP/"</return> followed by the value of <info>PHP_VERSION</info>.
                                    <strong>$stream_context</strong><info>resource</info> A stream context created by
                                    <strong>stream_context_create()</strong>, which allows additional options to be
                                    set.  The context may include socket context options, SSL
                                    context options, plus selected HTTP context options:
                                    <return>content_type</return>, <return>header</return>, <return>max_redirects</return>, <return>protocol_version</return>, and
                                    <return>user_agent</return>.  Note that the following HTTP headers are generated
                                    automatically or from other options, and will be ignored if
                                    specified in the <return>'header'</return> context option: <return>host</return>, <return>connection</return>,
                                    <return>user-agent</return>, <return>content-length</return>, <return>content-type</return>, <return>cookie</return>, <return>authorization</return>,
                                    and <return>proxy-authorization</return> <strong>$features</strong><info>int</info> A bitmask to enable one or
                                    more of the following features: <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> When
                                    decoding a response to an array, the default behaviour is to
                                    detect whether an element name appears once or multiple times in
                                    a particular parent element. For elements which appear only
                                    once, an object property allows direct access to the content;
                                    for elements which appear more than once, the property contains
                                    an array with the content of each matching element.  If the
                                    <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> feature is enabled, elements which
                                    appear only once are placed in a single-element array, so that
                                    access is consistent for all elements. This only has an effect
                                    when using a WSDL containing a schema for the response. See
                                    Examples section for an illustration. <info>SOAP_USE_XSI_ARRAY_TYPE</info>
                                    When the <return>use</return> option or WSDL property is set to <return>encoded</return>, force
                                    arrays to use a type of <return>SOAP-ENC:Array</return>, rather than a
                                    schema-specific type. <info>SOAP_WAIT_ONE_WAY_CALLS</info> Wait for a
                                    response even if the WSDL indicates a one-way request.
                                    <strong>$keep_alive</strong><info>bool</info> a boolean value defining whether to send the
                                    <return>Connection: Keep-Alive</return> header or <return>Connection: close</return>.  Defaults to
                                    <info>true</info> <strong>$ssl_method</strong><info>string</info> Specifies the SSL or TLS protocol version
                                    to use with secure HTTP connections, instead of the default
                                    negotiation. Specifying <info>SOAP_SSL_METHOD_SSLv2</info> or
                                    <info>SOAP_SSL_METHOD_SSLv3</info> will force use of SSL 2 or SSL 3,
                                    respectively. Specifying <info>SOAP_SSL_METHOD_SSLv23</info> has no effect;
                                    the constant exists only for backwards compatibility. As of PHP
                                    7.2, specifying <info>SOAP_SSL_METHOD_TLS</info> also has no effect; in
                                    earlier versions, it forced use of TLS 1.0.  Note that SSL
                                    versions 2 and 3 are considered insecure, and may not be
                                    supported by the installed OpenSSL library.  This option is
                                    DEPRECATED as of PHP 8.1.0. A more flexible alternative, which
                                    allows specifying individual versions of TLS, is to use the
                                    <strong>$stream_context</strong> option with the 'crypto_method' context
                                    parameter. Specifying use of TLS 1.3 only [ 'crypto_method' =>
                                    STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT ]
                                    ]);
                                    $client = new SoapClient("some.wsdl", ['context' => $context]);
                                    ]]> 
                                    
                                    The URL of the SOAP server to send the request to.
                                    
                                    Required if the <strong>$wsdl</strong> parameter is not provided. If both a <strong>$wsdl</strong>
                                    parameter and <return>location</return> option are provided, the <return>location</return> option
                                    will over-ride any location specified in the WSDL file.
                                    
                                    The target namespace of the SOAP service.
                                    
                                    Required if the <strong>$wsdl</strong> parameter is not provided; ignored
                                    otherwise.
                                    
                                    Specifies the binding style to use for this client, using the
                                    constants <info>SOAP_RPC</info> and <info>SOAP_DOCUMENT</info>. <info>SOAP_RPC</info> indicates
                                    RPC-style binding, where the SOAP request body contains a
                                    standard encoding of a function call. <info>SOAP_DOCUMENT</info> indicates
                                    document-style binding, where the SOAP request body contains an
                                    XML document with service-defined meaning.
                                    
                                    If the <strong>$wsdl</strong> parameter is provided, this option is ignored, and
                                    the style is read from the WSDL file.
                                    
                                    If neither this option nor the <strong>$wsdl</strong> parameter is provided,
                                    RPC-style is used.
                                    
                                    Specifies the encoding style to use for this client, using the
                                    constants <info>SOAP_ENCODED</info> or <info>SOAP_LITERAL</info>. <info>SOAP_ENCODED</info> indicates
                                    encoding using the types defined in the SOAP specification.
                                    <info>SOAP_LITERAL</info> indicates encoding using a schema defined by the
                                    service.
                                    
                                    If the <strong>$wsdl</strong> parameter is provided, this option is ignored, and
                                    the encoding is read from the WSDL file.
                                    
                                    If neither this option nor the <strong>$wsdl</strong> parameter is provided, the
                                    "encoded" style is used.
                                    
                                    Specifies the version of the SOAP protocol to use: <info>SOAP_1_1</info> for
                                    SOAP 1.1, or <info>SOAP_1_2</info> for SOAP 1.2.
                                    
                                    If omitted, SOAP 1.1 is used.
                                    
                                    Specifies the authentication method when using HTTP
                                    authentication in requests. The value may be either
                                    <info>SOAP_AUTHENTICATION_BASIC</info> or <info>SOAP_AUTHENTICATION_DIGEST</info>.
                                    
                                    If omitted, and the <return>login</return> option is provided, Basic
                                    Authentication is used.
                                    
                                    Username to use with HTTP Basic or Digest Authentication.
                                    
                                    Password to use with HTTP Basic or Digest Authentication.
                                    
                                    Not to be confused with <return>passphrase</return>, which is used with HTTPS
                                    Client Certificate authentication.
                                    
                                    Path to a client certificate for use with HTTPS authentication.
                                    It must be a PEM encoded file which contains your certificate
                                    and private key.
                                    
                                    The file can also include a chain of issuers, which must come
                                    after the client certificate.
                                    
                                    Can also be set via <strong>$stream_context</strong>, which also supports
                                    specifying a separate private key file.
                                    
                                    Passphrase for the client certificate specified in the
                                    <return>local_cert</return> option.
                                    
                                    Not to be confused with <return>password</return>, which is used for Basic or
                                    Digest Authentication.
                                    
                                    Can also be set via <strong>$stream_context</strong>.
                                    
                                    Hostname to use as a proxy server for HTTP requests.
                                    
                                    The <return>proxy_port</return> option must also be specified.
                                    
                                    TCP port to use when connecting to the proxy server specified in
                                    <return>proxy_host</return>.
                                    
                                    Optional username to authenticate with the proxy server
                                    specified in <return>proxy_host</return>, using HTTP Basic Authentication.
                                    
                                    Optional password to authenticate with the proxy server
                                    specified in <return>proxy_host</return>, using HTTP Basic Authentication.
                                    
                                    Enables compression of HTTP SOAP requests and responses.
                                    
                                    The value should be the bitwise OR of three parts: an optional
                                    <info>SOAP_COMPRESSION_ACCEPT</info>, to send an "Accept-Encoding" header;
                                    either <info>SOAP_COMPRESSION_GZIP</info> or <info>SOAP_COMPRESSION_DEFLATE</info> to
                                    indicate the compression algorithm to use; and a number between
                                    1 and 9 to indicate the level of compression to use in the
                                    request. For example, to enable two-way gzip compression with
                                    the maximum compression level, use <return>SOAP_COMPRESSION_ACCEPT |
                                    SOAP_COMPRESSION_GZIP | 9</return>.
                                    
                                    Defines the internal character encoding. Requests are always
                                    sent in UTF-8, and converted to and from this encoding.
                                    
                                    Captures request and response information, which can then be
                                    accessed with the methods SoapClient::__getLastRequest,
                                    SoapClient::__getLastRequestHeaders,
                                    SoapClient::__getLastResponse, and
                                    SoapClient::__getLastResponseHeaders.
                                    
                                    If omitted, defaults to <info>false</info>
                                    
                                    Used to map types defined in the WSDL to PHP classes. It should
                                    be specified as an associative <info>array</info> with type names from the
                                    WSDL as keys and names of PHP classes as values. Note that the
                                    type names of an element is not necessarily the same as the
                                    element (tag) name.
                                    
                                    The provided class names should always be fully qualified with
                                    any namespaces, and never start with a leading <return>\</return>. The correct
                                    form can be generated by using ::class.
                                    
                                    Note that when creating a class, the constructor will not be
                                    called, but magic __set() and __get() methods for individual
                                    properties will be.
                                    
                                    Used to define type mappings using user-defined callback
                                    functions. Each type mapping should be an array with keys
                                    <return>type_name</return> (<info>string</info> specifying the XML element type); <return>type_ns</return>
                                    (<info>string</info> containing namespace URI); <return>from_xml</return> (<info>callable</info> accepting
                                    one string parameter and returning an object) and <return>to_xml</return>
                                    (<info>callable</info> accepting one object parameter and returning a
                                    string).
                                    
                                    Defines whether errors throw exceptions of type <class>SoapFault</class>.
                                    
                                    Defaults to <info>true</info>
                                    
                                    Defines a timeout in seconds for the connection to the SOAP
                                    service. This option does not define a timeout for services with
                                    slow responses. To limit the time to wait for calls to finish
                                    the default_socket_timeout configuration option is available.
                                    
                                    If the <strong>$wsdl</strong> parameter is provided, and the
                                    soap.wsdl_cache_enabled configuration option is on, this option
                                    determines the type of caching. One of <info>WSDL_CACHE_NONE</info>,
                                    <info>WSDL_CACHE_DISK</info>, <info>WSDL_CACHE_MEMORY</info> or <info>WSDL_CACHE_BOTH</info>.
                                    
                                    Two types of cache are available: in-memory caching, which
                                    caches the WSDL in the memory of the current process; and disk
                                    caching, which caches the WSDL in a file on disk, shared between
                                    all processes. The directory to use for the disk cache is
                                    determined by the soap.wsdl_cache_dir configuration option. Both
                                    caches use the same lifetime, determined by the
                                    soap.wsdl_cache_ttl configuration option. The in-memory cache
                                    also has a maximum number of entries determined by the
                                    soap.wsdl_cache_limit configuration option.
                                    
                                    If not specified, the  soap.wsdl_cache configuration option will
                                    be used.
                                    
                                    The value to use in the <return>User-Agent</return> HTTP header when making
                                    requests.
                                    
                                    Can also be set via <strong>$stream_context</strong>.
                                    
                                    If not specified, the user agent will be <return>"PHP-SOAP/"</return> followed by
                                    the value of <info>PHP_VERSION</info>.
                                    
                                    A stream context created by <strong>stream_context_create()</strong>, which
                                    allows additional options to be set.
                                    
                                    The context may include socket context options, SSL context
                                    options, plus selected HTTP context options: <return>content_type</return>,
                                    <return>header</return>, <return>max_redirects</return>, <return>protocol_version</return>, and <return>user_agent</return>.
                                    
                                    Note that the following HTTP headers are generated automatically
                                    or from other options, and will be ignored if specified in the
                                    <return>'header'</return> context option: <return>host</return>, <return>connection</return>, <return>user-agent</return>,
                                    <return>content-length</return>, <return>content-type</return>, <return>cookie</return>, <return>authorization</return>, and
                                    <return>proxy-authorization</return>
                                    
                                    A bitmask to enable one or more of the following features:
                                    <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> When decoding a response to an array,
                                    the default behaviour is to detect whether an element name
                                    appears once or multiple times in a particular parent element.
                                    For elements which appear only once, an object property allows
                                    direct access to the content; for elements which appear more
                                    than once, the property contains an array with the content of
                                    each matching element.  If the <info>SOAP_SINGLE_ELEMENT_ARRAYS</info>
                                    feature is enabled, elements which appear only once are placed
                                    in a single-element array, so that access is consistent for all
                                    elements. This only has an effect when using a WSDL containing a
                                    schema for the response. See Examples section for an
                                    illustration. <info>SOAP_USE_XSI_ARRAY_TYPE</info> When the <return>use</return> option or
                                    WSDL property is set to <return>encoded</return>, force arrays to use a type of
                                    <return>SOAP-ENC:Array</return>, rather than a schema-specific type.
                                    <info>SOAP_WAIT_ONE_WAY_CALLS</info> Wait for a response even if the WSDL
                                    indicates a one-way request.
                                    
                                    When decoding a response to an array, the default behaviour is
                                    to detect whether an element name appears once or multiple times
                                    in a particular parent element. For elements which appear only
                                    once, an object property allows direct access to the content;
                                    for elements which appear more than once, the property contains
                                    an array with the content of each matching element.
                                    
                                    If the <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> feature is enabled, elements
                                    which appear only once are placed in a single-element array, so
                                    that access is consistent for all elements. This only has an
                                    effect when using a WSDL containing a schema for the response.
                                    See Examples section for an illustration.
                                    
                                    When the <return>use</return> option or WSDL property is set to <return>encoded</return>, force
                                    arrays to use a type of <return>SOAP-ENC:Array</return>, rather than a
                                    schema-specific type.
                                    
                                    Wait for a response even if the WSDL indicates a one-way
                                    request.
                                    
                                    a boolean value defining whether to send the <return>Connection:
                                    Keep-Alive</return> header or <return>Connection: close</return>.
                                    
                                    Defaults to <info>true</info>
                                    
                                    Specifies the SSL or TLS protocol version to use with secure
                                    HTTP connections, instead of the default negotiation. Specifying
                                    <info>SOAP_SSL_METHOD_SSLv2</info> or <info>SOAP_SSL_METHOD_SSLv3</info> will force use of
                                    SSL 2 or SSL 3, respectively. Specifying <info>SOAP_SSL_METHOD_SSLv23</info>
                                    has no effect; the constant exists only for backwards
                                    compatibility. As of PHP 7.2, specifying <info>SOAP_SSL_METHOD_TLS</info>
                                    also has no effect; in earlier versions, it forced use of TLS
                                    1.0.
                                    
                                    Note that SSL versions 2 and 3 are considered insecure, and may
                                    not be supported by the installed OpenSSL library.
                                    
                                    This option is DEPRECATED as of PHP 8.1.0. A more flexible
                                    alternative, which allows specifying individual versions of TLS,
                                    is to use the <strong>$stream_context</strong> option with the 'crypto_method'
                                    context parameter. Specifying use of TLS 1.3 only [
                                    'crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT ]
                                    ]);
                                    $client = new SoapClient("some.wsdl", ['context' => $context]);
                                    ]]>
  <info></info>             <strong>$location</strong>            The URL of the SOAP server to send the request to.
                                    
                                    Required if the <strong>$wsdl</strong> parameter is not provided. If both a <strong>$wsdl</strong>
                                    parameter and <return>location</return> option are provided, the <return>location</return> option
                                    will over-ride any location specified in the WSDL file.
  <info></info>             <strong>$uri</strong>                 The target namespace of the SOAP service.
                                    
                                    Required if the <strong>$wsdl</strong> parameter is not provided; ignored
                                    otherwise.
  <info></info>             <strong>$style</strong>               Specifies the binding style to use for this client, using the
                                    constants <info>SOAP_RPC</info> and <info>SOAP_DOCUMENT</info>. <info>SOAP_RPC</info> indicates
                                    RPC-style binding, where the SOAP request body contains a
                                    standard encoding of a function call. <info>SOAP_DOCUMENT</info> indicates
                                    document-style binding, where the SOAP request body contains an
                                    XML document with service-defined meaning.
                                    
                                    If the <strong>$wsdl</strong> parameter is provided, this option is ignored, and
                                    the style is read from the WSDL file.
                                    
                                    If neither this option nor the <strong>$wsdl</strong> parameter is provided,
                                    RPC-style is used.
  <info></info>             <strong>$use</strong>                 Specifies the encoding style to use for this client, using the
                                    constants <info>SOAP_ENCODED</info> or <info>SOAP_LITERAL</info>. <info>SOAP_ENCODED</info> indicates
                                    encoding using the types defined in the SOAP specification.
                                    <info>SOAP_LITERAL</info> indicates encoding using a schema defined by the
                                    service.
                                    
                                    If the <strong>$wsdl</strong> parameter is provided, this option is ignored, and
                                    the encoding is read from the WSDL file.
                                    
                                    If neither this option nor the <strong>$wsdl</strong> parameter is provided, the
                                    "encoded" style is used.
  <info></info>             <strong>$soap_version</strong>        Specifies the version of the SOAP protocol to use: <info>SOAP_1_1</info> for
                                    SOAP 1.1, or <info>SOAP_1_2</info> for SOAP 1.2.
                                    
                                    If omitted, SOAP 1.1 is used.
  <info></info>             <strong>$authentication</strong>      Specifies the authentication method when using HTTP
                                    authentication in requests. The value may be either
                                    <info>SOAP_AUTHENTICATION_BASIC</info> or <info>SOAP_AUTHENTICATION_DIGEST</info>.
                                    
                                    If omitted, and the <return>login</return> option is provided, Basic
                                    Authentication is used.
  <info></info>             <strong>$login</strong>               Username to use with HTTP Basic or Digest Authentication.
  <info></info>             <strong>$password</strong>            Password to use with HTTP Basic or Digest Authentication.
                                    
                                    Not to be confused with <return>passphrase</return>, which is used with HTTPS
                                    Client Certificate authentication.
  <info></info>             <strong>$local_cert</strong>          Path to a client certificate for use with HTTPS authentication.
                                    It must be a PEM encoded file which contains your certificate
                                    and private key.
                                    
                                    The file can also include a chain of issuers, which must come
                                    after the client certificate.
                                    
                                    Can also be set via <strong>$stream_context</strong>, which also supports
                                    specifying a separate private key file.
  <info></info>             <strong>$passphrase</strong>          Passphrase for the client certificate specified in the
                                    <return>local_cert</return> option.
                                    
                                    Not to be confused with <return>password</return>, which is used for Basic or
                                    Digest Authentication.
                                    
                                    Can also be set via <strong>$stream_context</strong>.
  <info></info>             <strong>$proxy_host</strong>          Hostname to use as a proxy server for HTTP requests.
                                    
                                    The <return>proxy_port</return> option must also be specified.
  <info></info>             <strong>$proxy_port</strong>          TCP port to use when connecting to the proxy server specified in
                                    <return>proxy_host</return>.
  <info></info>             <strong>$proxy_login</strong>         Optional username to authenticate with the proxy server
                                    specified in <return>proxy_host</return>, using HTTP Basic Authentication.
  <info></info>             <strong>$proxy_password</strong>      Optional password to authenticate with the proxy server
                                    specified in <return>proxy_host</return>, using HTTP Basic Authentication.
  <info></info>             <strong>$compression</strong>         Enables compression of HTTP SOAP requests and responses.
                                    
                                    The value should be the bitwise OR of three parts: an optional
                                    <info>SOAP_COMPRESSION_ACCEPT</info>, to send an "Accept-Encoding" header;
                                    either <info>SOAP_COMPRESSION_GZIP</info> or <info>SOAP_COMPRESSION_DEFLATE</info> to
                                    indicate the compression algorithm to use; and a number between
                                    1 and 9 to indicate the level of compression to use in the
                                    request. For example, to enable two-way gzip compression with
                                    the maximum compression level, use <return>SOAP_COMPRESSION_ACCEPT |
                                    SOAP_COMPRESSION_GZIP | 9</return>.
  <info></info>             <strong>$encoding</strong>            Defines the internal character encoding. Requests are always
                                    sent in UTF-8, and converted to and from this encoding.
  <info></info>             <strong>$trace</strong>               Captures request and response information, which can then be
                                    accessed with the methods SoapClient::__getLastRequest,
                                    SoapClient::__getLastRequestHeaders,
                                    SoapClient::__getLastResponse, and
                                    SoapClient::__getLastResponseHeaders.
                                    
                                    If omitted, defaults to <info>false</info>
  <info></info>             <strong>$classmap</strong>            Used to map types defined in the WSDL to PHP classes. It should
                                    be specified as an associative <info>array</info> with type names from the
                                    WSDL as keys and names of PHP classes as values. Note that the
                                    type names of an element is not necessarily the same as the
                                    element (tag) name.
                                    
                                    The provided class names should always be fully qualified with
                                    any namespaces, and never start with a leading <return>\</return>. The correct
                                    form can be generated by using ::class.
                                    
                                    Note that when creating a class, the constructor will not be
                                    called, but magic __set() and __get() methods for individual
                                    properties will be.
  <info></info>             <strong>$typemap</strong>             Used to define type mappings using user-defined callback
                                    functions. Each type mapping should be an array with keys
                                    <return>type_name</return> (<info>string</info> specifying the XML element type); <return>type_ns</return>
                                    (<info>string</info> containing namespace URI); <return>from_xml</return> (<info>callable</info> accepting
                                    one string parameter and returning an object) and <return>to_xml</return>
                                    (<info>callable</info> accepting one object parameter and returning a
                                    string).
  <info></info>             <strong>$exceptions</strong>          Defines whether errors throw exceptions of type <class>SoapFault</class>.
                                    
                                    Defaults to <info>true</info>
  <info></info>             <strong>$connection_timeout</strong>  Defines a timeout in seconds for the connection to the SOAP
                                    service. This option does not define a timeout for services with
                                    slow responses. To limit the time to wait for calls to finish
                                    the default_socket_timeout configuration option is available.
  <info></info>             <strong>$cache_wsdl</strong>          If the <strong>$wsdl</strong> parameter is provided, and the
                                    soap.wsdl_cache_enabled configuration option is on, this option
                                    determines the type of caching. One of <info>WSDL_CACHE_NONE</info>,
                                    <info>WSDL_CACHE_DISK</info>, <info>WSDL_CACHE_MEMORY</info> or <info>WSDL_CACHE_BOTH</info>.
                                    
                                    Two types of cache are available: in-memory caching, which
                                    caches the WSDL in the memory of the current process; and disk
                                    caching, which caches the WSDL in a file on disk, shared between
                                    all processes. The directory to use for the disk cache is
                                    determined by the soap.wsdl_cache_dir configuration option. Both
                                    caches use the same lifetime, determined by the
                                    soap.wsdl_cache_ttl configuration option. The in-memory cache
                                    also has a maximum number of entries determined by the
                                    soap.wsdl_cache_limit configuration option.
                                    
                                    If not specified, the  soap.wsdl_cache configuration option will
                                    be used.
  <info></info>             <strong>$user_agent</strong>          The value to use in the <return>User-Agent</return> HTTP header when making
                                    requests.
                                    
                                    Can also be set via <strong>$stream_context</strong>.
                                    
                                    If not specified, the user agent will be <return>"PHP-SOAP/"</return> followed by
                                    the value of <info>PHP_VERSION</info>.
  <info></info>             <strong>$stream_context</strong>      A stream context created by <strong>stream_context_create()</strong>, which
                                    allows additional options to be set.
                                    
                                    The context may include socket context options, SSL context
                                    options, plus selected HTTP context options: <return>content_type</return>,
                                    <return>header</return>, <return>max_redirects</return>, <return>protocol_version</return>, and <return>user_agent</return>.
                                    
                                    Note that the following HTTP headers are generated automatically
                                    or from other options, and will be ignored if specified in the
                                    <return>'header'</return> context option: <return>host</return>, <return>connection</return>, <return>user-agent</return>,
                                    <return>content-length</return>, <return>content-type</return>, <return>cookie</return>, <return>authorization</return>, and
                                    <return>proxy-authorization</return>
  <info></info>             <strong>$features</strong>            A bitmask to enable one or more of the following features:
                                    <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> When decoding a response to an array,
                                    the default behaviour is to detect whether an element name
                                    appears once or multiple times in a particular parent element.
                                    For elements which appear only once, an object property allows
                                    direct access to the content; for elements which appear more
                                    than once, the property contains an array with the content of
                                    each matching element.  If the <info>SOAP_SINGLE_ELEMENT_ARRAYS</info>
                                    feature is enabled, elements which appear only once are placed
                                    in a single-element array, so that access is consistent for all
                                    elements. This only has an effect when using a WSDL containing a
                                    schema for the response. See Examples section for an
                                    illustration. <info>SOAP_USE_XSI_ARRAY_TYPE</info> When the <return>use</return> option or
                                    WSDL property is set to <return>encoded</return>, force arrays to use a type of
                                    <return>SOAP-ENC:Array</return>, rather than a schema-specific type.
                                    <info>SOAP_WAIT_ONE_WAY_CALLS</info> Wait for a response even if the WSDL
                                    indicates a one-way request.
                                    
                                    When decoding a response to an array, the default behaviour is
                                    to detect whether an element name appears once or multiple times
                                    in a particular parent element. For elements which appear only
                                    once, an object property allows direct access to the content;
                                    for elements which appear more than once, the property contains
                                    an array with the content of each matching element.
                                    
                                    If the <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> feature is enabled, elements
                                    which appear only once are placed in a single-element array, so
                                    that access is consistent for all elements. This only has an
                                    effect when using a WSDL containing a schema for the response.
                                    See Examples section for an illustration.
                                    
                                    When the <return>use</return> option or WSDL property is set to <return>encoded</return>, force
                                    arrays to use a type of <return>SOAP-ENC:Array</return>, rather than a
                                    schema-specific type.
                                    
                                    Wait for a response even if the WSDL indicates a one-way
                                    request.
  <info></info>             <strong>$keep_alive</strong>          a boolean value defining whether to send the <return>Connection:
                                    Keep-Alive</return> header or <return>Connection: close</return>.
                                    
                                    Defaults to <info>true</info>
  <info></info>             <strong>$ssl_method</strong>          Specifies the SSL or TLS protocol version to use with secure
                                    HTTP connections, instead of the default negotiation. Specifying
                                    <info>SOAP_SSL_METHOD_SSLv2</info> or <info>SOAP_SSL_METHOD_SSLv3</info> will force use of
                                    SSL 2 or SSL 3, respectively. Specifying <info>SOAP_SSL_METHOD_SSLv23</info>
                                    has no effect; the constant exists only for backwards
                                    compatibility. As of PHP 7.2, specifying <info>SOAP_SSL_METHOD_TLS</info>
                                    also has no effect; in earlier versions, it forced use of TLS
                                    1.0.
                                    
                                    Note that SSL versions 2 and 3 are considered insecure, and may
                                    not be supported by the installed OpenSSL library.
                                    
                                    This option is DEPRECATED as of PHP 8.1.0. A more flexible
                                    alternative, which allows specifying individual versions of TLS,
                                    is to use the <strong>$stream_context</strong> option with the 'crypto_method'
                                    context parameter. Specifying use of TLS 1.3 only [
                                    'crypto_method' => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT ]
                                    ]);
                                    $client = new SoapClient("some.wsdl", ['context' => $context]);
                                    ]]>


id: SoapClient::__doRequest
type: function
doc:
<comment>Description:</comment>
  Performs a SOAP request
  
  Performs SOAP request over HTTP.
  
  This method can be overridden in subclasses to implement different transport layers, perform
  additional XML processing or other purpose.

<comment>Param:</comment>
  <info>string</info>  <strong>$request</strong>   The XML SOAP request.
  <info>string</info>  <strong>$location</strong>  The URL to request.
  <info>string</info>  <strong>$action</strong>    The SOAP action.
  <info>int</info>     <strong>$version</strong>   The SOAP version.
  <info>bool</info>    <strong>$oneWay</strong>    If <strong>$oneWay</strong> is set to <info>true</info>, this method returns nothing. Use this where a
                     response is not expected.

<comment>Return:</comment>
  <info>string|null</info>  The XML SOAP response.


id: SoapClient::__getCookies
type: function
doc:
<comment>Description:</comment>
  Get list of cookies
  
  This function is
  currently not documented; only its argument list is available.

<comment>Return:</comment>
  <info>array</info>  


id: SoapClient::__getFunctions
type: function
doc:
<comment>Description:</comment>
  Returns list of available SOAP functions
  
  Returns an array of functions described in the WSDL for the Web service.
  
  This function only works in WSDL mode.

<comment>Return:</comment>
  <info>array|null</info>  The <info>array</info> of SOAP function prototypes, detailing the return type, the function name
              and parameter types.

<comment>See Also:</comment>
   * SoapClient::__construct


id: SoapClient::__getLastRequest
type: function
doc:
<comment>Description:</comment>
  Returns last SOAP request
  
  Returns the XML sent in the last SOAP request.
  
  This method works only if the <class>SoapClient</class> object was created with the <return>trace</return> option set to <info>true</info>.

<comment>Return:</comment>
  <info>string|null</info>  The last SOAP request, as an XML string.

<comment>See Also:</comment>
   * SoapClient::__getLastRequestHeaders
   * SoapClient::__getLastResponse
   * SoapClient::__getLastResponseHeaders


id: SoapClient::__getLastRequestHeaders
type: function
doc:
<comment>Description:</comment>
  Returns the SOAP headers from the last request
  
  Returns the SOAP headers from the last request.
  
  This function only works if the <class>SoapClient</class> object was created with the <return>trace</return> option set to <info>true</info>.

<comment>Return:</comment>
  <info>string|null</info>  The last SOAP request headers.

<comment>See Also:</comment>
   * SoapClient::__getLastResponseHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastResponse


id: SoapClient::__getLastResponse
type: function
doc:
<comment>Description:</comment>
  Returns last SOAP response
  
  Returns the XML received in the last SOAP response.
  
  This method works only if the <class>SoapClient</class> object was created with the <return>trace</return> option set to <info>true</info>.

<comment>Return:</comment>
  <info>string|null</info>  The last SOAP response, as an XML string.

<comment>See Also:</comment>
   * SoapClient::__getLastResponseHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastRequestHeaders


id: SoapClient::__getLastResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Returns the SOAP headers from the last response
  
  Returns the SOAP headers from the last response.
  
  This function only works if the <class>SoapClient</class> object was created with the <return>trace</return> option set to <info>true</info>.

<comment>Return:</comment>
  <info>string|null</info>  The last SOAP response headers.

<comment>See Also:</comment>
   * SoapClient::__getLastRequestHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastResponse


id: SoapClient::__getTypes
type: function
doc:
<comment>Description:</comment>
  Returns a list of SOAP types
  
  Returns an array of types described in the WSDL for the Web service.
  
  This function only works in WSDL mode.

<comment>Return:</comment>
  <info>array|null</info>  The <info>array</info> of SOAP types, detailing all structures and types.

<comment>See Also:</comment>
   * SoapClient::__construct


id: SoapClient::__setCookie
type: function
doc:
<comment>Description:</comment>
  Defines a cookie for SOAP requests
  
  Defines a cookie to be sent along with the SOAP requests.
  
  Calling this method will affect all following calls to  <class>SoapClient</class> methods.

<comment>Param:</comment>
  <info>string</info>       <strong>$name</strong>   The name of the cookie.
  <info>string|null</info>  <strong>$value</strong>  The value of the cookie. If not specified, the cookie will be deleted.

<comment>Return:</comment>
  <info>void</info>  No value is returned.


id: SoapClient::__setLocation
type: function
doc:
<comment>Description:</comment>
  Sets the location of the Web service to use
  
  Sets the endpoint URL that will be touched by following SOAP requests. This is equivalent to
  specifying the <return>location</return> option when constructing the SoapClient.
  
  Calling this method is optional.  The SoapClient uses the endpoint from the WSDL file by default.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$location</strong>  The new endpoint URL.

<comment>Return:</comment>
  <info>string|null</info>  The old endpoint URL.

<comment>See Also:</comment>
   * SoapClient::__construct


id: SoapClient::__setSoapHeaders
type: function
doc:
<comment>Description:</comment>
  Sets SOAP headers for subsequent calls
  
  Defines headers to be sent along with the SOAP requests.
  
  Calling this method will replace any previous values.

<comment>Param:</comment>
  <info>SoapHeader|array|null</info>  <strong>$headers</strong>  The headers to be set. It could be <class>SoapHeader</class> object or array of
                                   <class>SoapHeader</class> objects. If not specified or set to <info>null</info>, the headers
                                   will be deleted.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.


