# php_manual

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
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<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.
  
  Esta função funciona apenas no modo WSDL.

<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.
  
  Esta função funciona apenas no modo WSDL.

<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>  Nenhum valor é retornado.


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>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SoapClient::__soapCall
type: function
doc:
<comment>Description:</comment>
  Calls a SOAP function
  
  This is a low level API function that is used to make a SOAP call. Usually, in WSDL mode, SOAP
  functions can be called as methods of the <class>SoapClient</class> object. This method is useful in non-WSDL
  mode when <return>soapaction</return> is unknown, <return>uri</return> differs from the default or when sending and/or receiving
  SOAP Headers.
  
  On error, a call to a SOAP function can cause PHP to throw exceptions or return a <class>SoapFault</class> object
  if exceptions are disabled. To check if the function call failed to catch the SoapFault
  exceptions, check the result with <strong>is_soap_fault()</strong>.

<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.
  <info>array|null</info>             <strong>$options</strong>        An associative array of options to pass to the client.
                                         
                                         The <return>location</return> option is the URL of the remote Web service.
                                         
                                         The <return>uri</return> option is the target namespace of the SOAP service.
                                         
                                         The <return>soapaction</return> option is the action to call.
  <info>SoapHeader|array|null</info>  <strong>$inputHeaders</strong>   An array of headers to be sent along with the SOAP request.
  <info>array</info>                  <strong>$outputHeaders</strong>  If supplied, this array will be filled with the headers
                                         from the SOAP response.

<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.

<comment>See Also:</comment>
   * SoapClient::__construct
   * SoapParam::__construct
   * SoapVar::__construct
   * SoapHeader::__construct
   * SoapFault::__construct
   * <strong>is_soap_fault()</strong>


id: SoapFault::__construct
type: function
doc:
<comment>Description:</comment>
  SoapFault constructor
  
  This class is used to send SOAP fault responses from the PHP handler. <strong>$faultcode</strong>, <strong>$faultstring</strong>,
  <strong>$faultactor</strong> and <strong>$detail</strong> are standard elements of a SOAP Fault.

<comment>Param:</comment>
  <info></info>  <strong>$faultcode</strong>    The error code of the <class>SoapFault</class>.
  <info></info>  <strong>$faultstring</strong>  The error message of the <class>SoapFault</class>.
  <info></info>  <strong>$faultactor</strong>   A string identifying the actor that caused the error.
  <info></info>  <strong>$detail</strong>       More details about the cause of the error.
  <info></info>  <strong>$faultname</strong>    Can be used to select the proper fault encoding from WSDL.
  <info></info>  <strong>$headerfault</strong>  Can be used during SOAP header handling to report an error in the response header.

<comment>See Also:</comment>
   * SoapServer::fault
   * <strong>is_soap_fault()</strong>


id: SoapFault::__toString
type: function
doc:
<comment>Description:</comment>
  Obtain a string representation of a SoapFault
  
  Returns a string representation of the SoapFault.

<comment>Return:</comment>
  <info>string</info>  A string describing the SoapFault.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>       The namespace of the SOAP header element.
  <info>string</info>  <strong>$name</strong>            The name of the SoapHeader object.
  <info>mixed</info>   <strong>$data</strong>            A SOAP header's content. It can be a PHP value or a <class>SoapVar</class> object.
  <info></info>        <strong>$mustUnderstand</strong>  Value of the <return>mustUnderstand</return> attribute of the SOAP header element.
  <info>string</info>  <strong>$actor</strong>           Value of the <return>actor</return> attribute of the SOAP header element.

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapVar::__construct
   * SoapParam::__construct
   * SoapServer::addSoapHeader


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

<comment>Param:</comment>
  <info>mixed</info>   <strong>$data</strong>  The data to pass or return. This parameter can be passed directly as PHP value, but
                 in this case it will be named as <return>paramN</return> and the SOAP service may not understand it.
  <info>string</info>  <strong>$name</strong>  The parameter name.

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapVar::__construct


id: SoapServer
type: class
doc:
<comment>Description:</comment>
  The SoapServer class provides a server for the SOAP 1.1 and SOAP 1.2 protocols. It can be used
  with or without a WSDL service description.


id: SoapServer::__construct
type: function
doc:
<comment>Description:</comment>
  SoapServer constructor
  
  This constructor allows the creation of <class>SoapServer</class> objects in WSDL or non-WSDL mode.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$wsdl</strong>     To use the SoapServer in WSDL mode, pass the URI of a WSDL file. Otherwise,
                         pass <info>null</info> and set the <return>uri</return> option to the target namespace for the server.
  <info>array</info>        <strong>$options</strong>  Allow setting a default SOAP version (<return>soap_version</return>), internal character
                         encoding (<return>encoding</return>), and actor URI (<return>actor</return>).
                         
                         The <return>classmap</return> option can be used to map some WSDL types to PHP classes. This
                         option must be an array with WSDL types as keys and names of PHP classes as
                         values.
                         
                         The <return>typemap</return> option is an array of type mappings. Type mapping is an array
                         with keys <return>type_name</return>, <return>type_ns</return> (namespace URI), <return>from_xml</return> (callback accepting
                         one string parameter) and <return>to_xml</return> (callback accepting one object parameter).
                         
                         The <return>cache_wsdl</return> option is one of <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>,
                         <info>WSDL_CACHE_MEMORY</info> or <info>WSDL_CACHE_BOTH</info>.
                         
                         There is also a <return>features</return> option which can be set to
                         <info>SOAP_WAIT_ONE_WAY_CALLS</info>, <info>SOAP_SINGLE_ELEMENT_ARRAYS</info>,
                         <info>SOAP_USE_XSI_ARRAY_TYPE</info>.
                         
                         The <return>send_errors</return> option can be set to <info>false</info> to sent a generic error message
                         ("Internal error") instead of the specific error message sent otherwise.

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


id: SoapServer::addFunction
type: function
doc:
<comment>Description:</comment>
  Adds one or more functions to handle SOAP requests
  
  Exports one or more functions for remote clients

<comment>Param:</comment>
  <info>array|string|int</info>  <strong>$functions</strong>  To export one function, pass the function name into this parameter
                                as a string.
                                
                                To export several functions, pass an array of function names.
                                
                                To export all the functions, pass a special constant
                                <info>SOAP_FUNCTIONS_ALL</info>.
                                
                                <strong>$functions</strong> must receive all input arguments in the same order as
                                defined in the WSDL file (They should not receive any output
                                parameters as arguments) and return one or more values. To return
                                several values they must return an array with named output
                                parameters.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SoapServer::__construct
   * SoapServer::setClass


id: SoapServer::addSoapHeader
type: function
doc:
<comment>Description:</comment>
  Add a SOAP header to the response
  
  Adds a SOAP header to be returned with the response to the current request.

<comment>Param:</comment>
  <info>SoapHeader</info>  <strong>$header</strong>  The header to be returned.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SoapServer::fault
type: function
doc:
<comment>Description:</comment>
  Issue SoapServer fault indicating an error
  
  Sends a response to the client of the current request indicating an error.
  
  This can only be called when handling a request.

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>     The error code to return
  <info>string</info>  <strong>$string</strong>   A brief description of the error
  <info>string</info>  <strong>$actor</strong>    A string identifying the actor that caused the fault.
  <info>mixed</info>   <strong>$details</strong>  More details of the fault
  <info>string</info>  <strong>$name</strong>     The name of the fault. This can be used to select a name from a WSDL file.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: SoapServer::getFunctions
type: function
doc:
<comment>Description:</comment>
  Returns list of defined functions
  
  Returns a list of the defined functions in the SoapServer object. This method returns the list of
  all functions added by SoapServer::addFunction or SoapServer::setClass.

<comment>Return:</comment>
  <info>array</info>  An <return>array</return> of the defined functions.

<comment>See Also:</comment>
   * SoapServer::__construct
   * SoapServer::addFunction
   * SoapServer::setClass


id: SoapServer::handle
type: function
doc:
<comment>Description:</comment>
  Handles a SOAP request
  
  Processes a SOAP request, calls necessary functions, and sends a response back.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$request</strong>  The SOAP request. If this argument is omitted, the request is assumed to be
                         in the raw POST data of the HTTP request.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: SoapServer::setClass
type: function
doc:
<comment>Description:</comment>
  Sets the class which handles SOAP requests
  
  Exports all methods from specified class.
  
  The object can be made persistent across request for a given PHP session with the
  SoapServer::setPersistence method.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  The name of the exported class.
  <info>mixed</info>   <strong>$args</strong>   These optional parameters will be passed to the default class constructor during
                  object creation.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SoapServer::__construct
   * SoapServer::addFunction
   * SoapServer::setPersistence


id: SoapServer::setObject
type: function
doc:
<comment>Description:</comment>
  Sets the object which will be used to handle SOAP requests
  
  This sets a specific object as the handler for SOAP requests, rather than just a class as in
  SoapServer::setClass.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The object to handle the requests.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SoapServer::setClass


id: SoapServer::setPersistence
type: function
doc:
<comment>Description:</comment>
  Sets SoapServer persistence mode
  
  This function allows changing the persistence state of a SoapServer object between requests. This
  function allows saving data between requests utilizing PHP sessions.  This method only has an
  affect on a SoapServer after it has exported functions utilizing SoapServer::setClass.
  
  The persistence of <info>SOAP_PERSISTENCE_SESSION</info> makes only objects of the given class persistent, but
  not the class static data. In this  case, use $this-&gt;bar instead of self::$bar.
  
  <info>SOAP_PERSISTENCE_SESSION</info> serializes data on the class object between requests. In order to
  properly utilize resources (e.g. <class>PDO</class>), __wakeup() and __sleep() magic methods should be utilized.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  One of the <return>SOAP_PERSISTENCE_XXX</return> constants.
              
              <info>SOAP_PERSISTENCE_REQUEST</info> - SoapServer data does not persist between requests. This is
              the default behavior of any SoapServer object after setClass is called.
              
              <info>SOAP_PERSISTENCE_SESSION</info> - SoapServer data persists between requests. This is
              accomplished by serializing the SoapServer class data into
              $_SESSION['_bogus_session_name'], because of this  <strong>session_start()</strong> must be called
              before this persistence mode is set.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SoapServer::setClass


id: SoapVar
type: class
doc:
<comment>Description:</comment>
  A class representing a variable or object for use with SOAP services.


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

<comment>Param:</comment>
  <info>mixed</info>     <strong>$data</strong>            The data to pass or return.
  <info>int|null</info>  <strong>$encoding</strong>        The encoding ID, one of the <return>XSD_...</return> constants.
  <info></info>          <strong>$type_name</strong>       The type name.
  <info></info>          <strong>$type_namespace</strong>  The type namespace.
  <info></info>          <strong>$node_name</strong>       The XML node name.
  <info></info>          <strong>$node_namespace</strong>  The XML node namespace.

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapParam::__construct


id: Socket
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces <return>Socket</return> resources as of PHP 8.0.0.


id: SolrClient
type: class
doc:
<comment>Description:</comment>
  Used to send requests to a Solr server. Currently, cloning and serialization of SolrClient
  instances is not supported.


id: SolrClient::DEFAULT_SYSTEM_SERVLET
type: constant
doc:
<comment>Description:</comment>
  This is the initial value for the system servlet used to obtain Solr Server information


id: SolrClient::DEFAULT_TERMS_SERVLET
type: constant
doc:
<comment>Description:</comment>
  This is the initial value for the terms servlet used for the TermsComponent


id: SolrClient::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor for the SolrClient object
  
  Constructor for the SolrClient object

<comment>Param:</comment>
  <info>array</info>  <strong>$clientOptions</strong>  This is an array containing one of the following keys :
                         
                         

<comment>See Also:</comment>
   * SolrClient::getOptions


id: SolrClient::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor for SolrClient
  
  Destructor

<comment>Return:</comment>
  <info>unknown</info>  Destructor for SolrClient

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


id: SolrClient::addDocument
type: function
doc:
<comment>Description:</comment>
  Adds a document to the index
  
  This method adds a document to the index.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$doc</strong>           The SolrInputDocument instance.
  <info>bool</info>               <strong>$overwrite</strong>     Whether to overwrite existing document or not. If <info>false</info> there
                                    will be duplicates (several documents with the same ID).
                                    
                                    PECL Solr
                                    \< 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag.
                                    
                                    $allowDups = false is the same as $overwrite = true
  <info>int</info>                <strong>$commitWithin</strong>  Number of milliseconds within which to auto commit this
                                    document. Available since Solr 1.4 . Default (0) means disabled.
                                    
                                    When this value specified, it leaves the control of when to do
                                    the commit to Solr itself, optimizing number of commits to a
                                    minimum while still fulfilling the update latency requirements,
                                    and Solr will automatically do a commit when the oldest add in
                                    the buffer is due.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> object or throws an Exception on failure.

<comment>See Also:</comment>
   * SolrClient::addDocuments
   * SolrClient::commit


id: SolrClient::addDocuments
type: function
doc:
<comment>Description:</comment>
  Adds a collection of SolrInputDocument instances to the index
  
  Adds a collection of documents to the index.

<comment>Param:</comment>
  <info>array</info>  <strong>$docs</strong>          An array containing the collection of SolrInputDocument instances. This
                        array must be an actual variable.
  <info>bool</info>   <strong>$overwrite</strong>     Whether to overwrite existing documents or not. If <info>false</info> there will be
                        duplicates (several documents with the same ID).
                        
                        PECL Solr
                        \< 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag.
                        
                        $allowDups = false is the same as $overwrite = true
  <info>int</info>    <strong>$commitWithin</strong>  Number of milliseconds within which to auto commit this document. Available
                        since Solr 1.4 . Default (0) means disabled.
                        
                        When this value specified, it leaves the control of when to do the commit to
                        Solr itself, optimizing number of commits to a minimum while still
                        fulfilling the update latency requirements, and Solr will automatically do a
                        commit when the oldest add in the buffer is due.

<comment>Return:</comment>
  <info>void</info>  Returns a <info>SolrUpdateResponse</info> object or throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::addDocument
   * SolrClient::commit


id: SolrClient::commit
type: function
doc:
<comment>Description:</comment>
  Finalizes all add/deletes made to the index
  
  This method finalizes all add/deletes made to the index.

<comment>Param:</comment>
  <info>bool</info>  <strong>$softCommit</strong>      This will refresh the 'view' of the index in a more performant manner, but
                         without "on-disk" guarantees. (Solr4.0+)
                         
                         A soft commit is much faster since it only makes index changes visible and
                         does not fsync index files or write a new index descriptor.  If the JVM
                         crashes or there is a loss of power, changes that occurred after the last
                         hard commit will be lost.  Search collections that have near-real-time
                         requirements (that want index changes to be quickly visible to searches)
                         will want to soft commit often but hard commit less frequently.
  <info>bool</info>  <strong>$waitSearcher</strong>    block until a new searcher is opened and registered as the main query
                         searcher, making the changes visible.
  <info>bool</info>  <strong>$expungeDeletes</strong>  Merge segments with deletes away. (Solr1.4+)

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <class>SolrUpdateResponse</class> object on success or throws an exception on
                      failure.

<comment>See Also:</comment>
   * SolrClient::optimize
   * SolrClient::rollback


id: SolrClient::deleteById
type: function
doc:
<comment>Description:</comment>
  Delete by Id
  
  Deletes the document with the specified ID. Where ID is the value of the uniqueKey field declared
  in the schema

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The value of the uniqueKey field declared in the schema

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success and throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::deleteByIds
   * SolrClient::deleteByQuery
   * SolrClient::deleteByQueries


id: SolrClient::deleteByIds
type: function
doc:
<comment>Description:</comment>
  Deletes by Ids
  
  Deletes a collection of documents with the specified set of ids.

<comment>Param:</comment>
  <info>array</info>  <strong>$ids</strong>  An array of IDs representing the uniqueKey field declared in the schema for each
               document to be deleted. This must be an actual php variable.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success and throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByQuery
   * SolrClient::deleteByQueries


id: SolrClient::deleteByQueries
type: function
doc:
<comment>Description:</comment>
  Removes all documents matching any of the queries
  
  Removes all documents matching any of the queries

<comment>Param:</comment>
  <info>array</info>  <strong>$queries</strong>  The array of queries. This must be an actual php variable.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a SolrUpdateResponse on success and throws a SolrClientException on
                      failure.

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByIds
   * SolrClient::deleteByQuery


id: SolrClient::deleteByQuery
type: function
doc:
<comment>Description:</comment>
  Deletes all documents matching the given query
  
  Deletes all documents matching the given query.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The query

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success and throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByIds
   * SolrClient::deleteByQueries


id: SolrClient::getById
type: function
doc:
<comment>Description:</comment>
  Get Document By Id. Utilizes Solr Realtime Get (RTG)
  
  Get Document By Id. Utilizes Solr Realtime Get (RTG).

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Document ID

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  <info>SolrQueryResponse</info>

<comment>See Also:</comment>
   * SolrClient::getByIds


id: SolrClient::getByIds
type: function
doc:
<comment>Description:</comment>
  Get Documents by their Ids. Utilizes Solr Realtime Get (RTG)
  
  Get Documents by their Ids. Utilizes Solr Realtime Get (RTG).

<comment>Param:</comment>
  <info>array</info>  <strong>$ids</strong>  Document ids

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  <info>SolrQueryResponse</info>

<comment>See Also:</comment>
   * SolrClient::getById


id: SolrClient::getDebug
type: function
doc:
<comment>Description:</comment>
  Returns the debug data for the last connection attempt
  
  Returns the debug data for the last connection attempt

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and null if there is nothing to return.


id: SolrClient::getOptions
type: function
doc:
<comment>Description:</comment>
  Returns the client options set internally
  
  Returns the client options set internally. Very useful for debugging. The values returned are
  readonly and can only be set when the object is instantiated.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing all the options for the SolrClient object set internally.

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


id: SolrClient::optimize
type: function
doc:
<comment>Description:</comment>
  Defragments the index
  
  Defragments the index for faster search performance.

<comment>Param:</comment>
  <info>int</info>   <strong>$maxSegments</strong>   Optimizes down to at most this number of segments. Since Solr 1.3
  <info>bool</info>  <strong>$softCommit</strong>    This will refresh the 'view' of the index in a more performant manner, but
                       without "on-disk" guarantees. (Solr4.0+)
  <info>bool</info>  <strong>$waitSearcher</strong>  Block until a new searcher is opened and registered as the main query
                       searcher, making the changes visible.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a SolrUpdateResponse on success or throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::commit
   * SolrClient::rollback


id: SolrClient::ping
type: function
doc:
<comment>Description:</comment>
  Checks if Solr server is still up
  
  Checks if the Solr server is still alive. Sends a HEAD request to the Apache Solr server.

<comment>Return:</comment>
  <info>SolrPingResponse</info>  Returns a <info>SolrPingResponse</info> object on success and throws an exception on failure.


id: SolrClient::query
type: function
doc:
<comment>Description:</comment>
  Sends a query to the server
  
  Sends a query to the server.

<comment>Param:</comment>
  <info>SolrParams</info>  <strong>$query</strong>  A <info>SolrParams</info> object. It is recommended to use <info>SolrQuery</info> for advanced queries.

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  Returns a <info>SolrQueryResponse</info> object on success and throws an exception on
                     failure.


id: SolrClient::request
type: function
doc:
<comment>Description:</comment>
  Sends a raw update request
  
  Sends a raw XML update request to the server

<comment>Param:</comment>
  <info>string</info>  <strong>$raw_request</strong>  An XML string with the raw request to the server.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success. Throws an exception on failure.


id: SolrClient::rollback
type: function
doc:
<comment>Description:</comment>
  Rollbacks all add/deletes made to the index since the last commit
  
  Rollbacks all add/deletes made to the index since the last commit. It neither calls any event
  listeners nor creates a new searcher.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a SolrUpdateResponse on success or throws a SolrClientException on
                      failure.

<comment>See Also:</comment>
   * SolrClient::commit
   * SolrClient::optimize


id: SolrClient::setResponseWriter
type: function
doc:
<comment>Description:</comment>
  Sets the response writer used to prepare the response from Solr
  
  Sets the response writer used to prepare the response from Solr

<comment>Param:</comment>
  <info>string</info>  <strong>$responseWriter</strong>  One of the following:

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SolrClient::setServlet
type: function
doc:
<comment>Description:</comment>
  Changes the specified servlet type to a new value
  
  Changes the specified servlet type to a new value

<comment>Param:</comment>
  <info>int</info>     <strong>$type</strong>   One of the following :
                  
                  
  <info>string</info>  <strong>$value</strong>  The new value for the servlet

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrClient::system
type: function
doc:
<comment>Description:</comment>
  Retrieve Solr Server information
  
  Retrieve Solr Server information

<comment>Return:</comment>
  <info>void</info>  Returns a <info>SolrGenericResponse</info> object on success.


id: SolrClient::threads
type: function
doc:
<comment>Description:</comment>
  Checks the threads status
  
  Checks the threads status

<comment>Return:</comment>
  <info>void</info>  Returns a SolrGenericResponse object.


id: SolrClientException
type: class
doc:
<comment>Description:</comment>
  An exception thrown when there is an error while making a request to the server from the client.


id: SolrClientException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  Returns internal information where the Exception was thrown
  
  Returns internal information where the Exception was thrown.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing internal information where the error was thrown. Used only for
         debugging by extension developers.


id: SolrCollapseFunction::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Collapse Function constructor

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The field name to collapse on.
                  
                  In order to collapse a result. The field type must be a single valued String, Int
                  or Float.

<comment>See Also:</comment>
   * SolrQuery::collapse


id: SolrCollapseFunction::__toString
type: function
doc:
<comment>Description:</comment>
  Returns a string representing the constructed collapse function
  
  Returns a string representing the constructed collapse function

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


id: SolrCollapseFunction::getField
type: function
doc:
<comment>Description:</comment>
  Returns the field that is being collapsed on
  
  Returns the field that is being collapsed on.

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setField


id: SolrCollapseFunction::getHint
type: function
doc:
<comment>Description:</comment>
  Returns collapse hint
  
  Returns collapse hint

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setHint


id: SolrCollapseFunction::getMax
type: function
doc:
<comment>Description:</comment>
  Returns max parameter
  
  Returns max parameter

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setMax


id: SolrCollapseFunction::getMin
type: function
doc:
<comment>Description:</comment>
  Returns min parameter
  
  Returns min parameter

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setMin


id: SolrCollapseFunction::getNullPolicy
type: function
doc:
<comment>Description:</comment>
  Returns null policy
  
  Returns null policy used or null

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setNullPolicy


id: SolrCollapseFunction::getSize
type: function
doc:
<comment>Description:</comment>
  Returns size parameter
  
  Gets the initial size of the collapse data structures when collapsing on a numeric field only

<comment>Return:</comment>
  <info>int</info>  

<comment>See Also:</comment>
   * SolrCollapseFunction::setSize


id: SolrCollapseFunction::setField
type: function
doc:
<comment>Description:</comment>
  Sets the field to collapse on
  
  The field name to collapse on.  In order to collapse a result. The field type must be a single
  valued String, Int or Float.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setHint
type: function
doc:
<comment>Description:</comment>
  Sets collapse hint
  
  Sets collapse hint

<comment>Param:</comment>
  <info>string</info>  <strong>$hint</strong>  Currently there is only one hint available "top_fc", which stands for top level
                 FieldCache

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setMax
type: function
doc:
<comment>Description:</comment>
  Selects the group heads by the max value of a numeric field or function query
  
  Selects the group heads by the max value of a numeric field or function query.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setMin
type: function
doc:
<comment>Description:</comment>
  Sets the initial size of the collapse data structures when collapsing on a numeric field only
  
  Sets the initial size of the collapse data structures when collapsing on a numeric field only

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setNullPolicy
type: function
doc:
<comment>Description:</comment>
  Sets the NULL Policy
  
  Sets the NULL Policy. One of the 3 policies defined as class constants shall be passed. Accepts
  ignore, expand, or collapse policies.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setSize
type: function
doc:
<comment>Description:</comment>
  Sets the initial size of the collapse data structures when collapsing on a numeric field only
  
  Sets the initial size of the collapse data structures when collapsing on a numeric field only.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrDisMaxQuery::FACET_SORT_COUNT
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the facet should sort by count (Duplicated for easier migration)


id: SolrDisMaxQuery::FACET_SORT_INDEX
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the facet should sort by index (Duplicated for easier migration)


id: SolrDisMaxQuery::ORDER_ASC
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the sorting should be in acending order (Duplicated for easier migration)


id: SolrDisMaxQuery::ORDER_DESC
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the sorting should be in descending order (Duplicated for easier migration)


id: SolrDisMaxQuery::__construct
type: function
doc:
<comment>Description:</comment>
  Class Constructor
  
  Class constructor initializes the object and sets the q parameter if passed

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Search Query (q parameter)


id: SolrDisMaxQuery::addBigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Adds a Phrase Bigram Field (pf2 parameter)
  
  Adds a Phrase Bigram Field (pf2 parameter) output format: field~slop^boost OR field^boost Slop is
  optional

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  
  <info>string</info>  <strong>$boost</strong>  
  <info>string</info>  <strong>$slop</strong>   

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeBigramPhraseField
   * SolrDisMaxQuery::setBigramPhraseFields
   * SolrDisMaxQuery::setBigramPhraseSlop


id: SolrDisMaxQuery::addBoostQuery
type: function
doc:
<comment>Description:</comment>
  Adds a boost query field with value and optional boost (bq parameter)
  
  Adds a Boost Query field with value [and boost] (bq parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  
  <info>string</info>  <strong>$value</strong>  
  <info>string</info>  <strong>$boost</strong>  

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeBoostQuery
   * SolrDisMaxQuery::setBoostQuery


id: SolrDisMaxQuery::addPhraseField
type: function
doc:
<comment>Description:</comment>
  Adds a Phrase Field (pf parameter)
  
  Adds a Phrase Field (pf parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$boost</strong>  
  <info>string</info>  <strong>$slop</strong>   

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removePhraseField
   * SolrDisMaxQuery::setPhraseFields


id: SolrDisMaxQuery::addQueryField
type: function
doc:
<comment>Description:</comment>
  Add a query field with optional boost (qf parameter)
  
  Add a query field with optional boost (qf parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$boost</strong>  Boost value. Boosts documents with matching terms.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeQueryField


id: SolrDisMaxQuery::addTrigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Adds a Trigram Phrase Field (pf3 parameter)
  
  Adds a Trigram Phrase Field (pf3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name
  <info>string</info>  <strong>$boost</strong>  Field Boost
  <info>string</info>  <strong>$slop</strong>   Field Slop

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::addUserField
type: function
doc:
<comment>Description:</comment>
  Adds a field to User Fields Parameter (uf)
  
  Adds a field to The User Fields Parameter (uf)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeUserField
   * SolrDisMaxQuery::setUserFields


id: SolrDisMaxQuery::removeBigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Removes phrase bigram field (pf2 parameter)
  
  Removes a Bigram Phrase Field (pf2 parameter) that was previously added using
  SolrDisMaxQuery::addBigramPhraseField

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBigramPhraseField
   * SolrDisMaxQuery::setBigramPhraseFields
   * SolrDisMaxQuery::setBigramPhraseSlop


id: SolrDisMaxQuery::removeBoostQuery
type: function
doc:
<comment>Description:</comment>
  Removes a boost query partial by field name (bq)
  
  Removes a boost query partial from the existing query, only if SolrDisMaxQuery::addBoostQuery was
  used.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBoostQuery
   * SolrDisMaxQuery::setBoostQuery


id: SolrDisMaxQuery::removePhraseField
type: function
doc:
<comment>Description:</comment>
  Removes a Phrase Field (pf parameter)
  
  Removes a Phrase Field (pf parameter) that was previously added using
  SolrDisMaxQuery::addPhraseField

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addPhraseField
   * SolrDisMaxQuery::setPhraseFields


id: SolrDisMaxQuery::removeQueryField
type: function
doc:
<comment>Description:</comment>
  Removes a Query Field (qf parameter)
  
  Removes a Query Field (qf parameter) from the field list added by SolrDisMaxQuery::addQueryField
  
  qf: When building DisjunctionMaxQueries from the user's query it specifies the fields to search
  in, and boosts for those fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addQueryField


id: SolrDisMaxQuery::removeTrigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Removes a Trigram Phrase Field (pf3 parameter)
  
  Removes a Trigram Phrase Field (pf3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::removeUserField
type: function
doc:
<comment>Description:</comment>
  Removes a field from The User Fields Parameter (uf)
  
  Removes a field from The User Fields Parameter (uf)
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addUserField
   * SolrDisMaxQuery::setUserFields


id: SolrDisMaxQuery::setBigramPhraseFields
type: function
doc:
<comment>Description:</comment>
  Sets Bigram Phrase Fields and their boosts (and slops) using pf2 parameter
  
  Sets Bigram Phrase Fields (pf2) and their boosts (and slops)

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Fields boosts (slops)

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::setBigramPhraseSlop
   * SolrDisMaxQuery::addBigramPhraseFields
   * SolrDisMaxQuery::removeBigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields


id: SolrDisMaxQuery::setBigramPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Sets Bigram Phrase Slop (ps2 parameter)
  
  Sets Bigram Phrase Slop (ps2 parameter). A default slop for Bigram phrase fields.

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setBoostFunction
type: function
doc:
<comment>Description:</comment>
  Sets a Boost Function (bf parameter)
  
  Sets Boost Function (bf parameter).
  
  Functions (with optional boosts) that will be included in the user's query to influence the score.
  Any function supported natively by Solr can be used, along with a boost value. e.g.:
  
  recip(rord(myfield),1,2,3)^1.5

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setBoostQuery
type: function
doc:
<comment>Description:</comment>
  Directly Sets Boost Query Parameter (bq)
  
  Sets Boost Query Parameter (bq)

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  query

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBoostQuery
   * SolrDisMaxQuery::removeBoostQuery


id: SolrDisMaxQuery::setMinimumMatch
type: function
doc:
<comment>Description:</comment>
  Set Minimum "Should" Match (mm)
  
  Set Minimum "Should" Match parameter (mm). If the default query operator is AND then mm=100%, if
  the default query operator (q.op) is OR, then mm=0%.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Minimum match value/expression

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setPhraseFields
type: function
doc:
<comment>Description:</comment>
  Sets  Phrase Fields and their boosts (and slops) using pf2 parameter
  
  Sets  Phrase Fields (pf) and their boosts (and slops)

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Fields, boosts [, slops]

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addPhraseFields
   * SolrDisMaxQuery::removePhraseField


id: SolrDisMaxQuery::setPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Sets the default slop on phrase queries (ps parameter)
  
  Sets the default amount of slop on phrase queries built with "pf", "pf2" and/or "pf3" fields
  (affects boosting). "ps" parameter

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setQueryAlt
type: function
doc:
<comment>Description:</comment>
  Set Query Alternate (q.alt parameter)
  
  Set Query Alternate (q.alt parameter)
  
  When the main q parameter is not specified or is blank. The q.alt parameter is used

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Query String

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setQueryPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Specifies the amount of slop permitted on phrase queries explicitly included in the user's query
  string (qf parameter)
  
  The Query Phrase Slop is the amount of slop permitted on phrase queries explicitly included in the
  user's query string with the qf parameter.
  
  slop refers to the number of positions one token needs to be moved in relation to another token in
  order to match a phrase specified in a query.

<comment>Param:</comment>
  <info>string</info>  <strong>$slop</strong>  Amount of slop

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setTieBreaker
type: function
doc:
<comment>Description:</comment>
  Sets Tie Breaker parameter (tie parameter)
  
  Sets Tie Breaker parameter (tie parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$tieBreaker</strong>  The tie parameter specifies a float value (which should be something much
                       less than 1) to use as tiebreaker in DisMax queries.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setTrigramPhraseFields
type: function
doc:
<comment>Description:</comment>
  Directly Sets Trigram Phrase Fields (pf3 parameter)
  
  Directly Sets Trigram Phrase Fields (pf3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Trigram Phrase Fields

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::setTrigramPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Sets Trigram Phrase Slop (ps3 parameter)
  
  Sets Trigram Phrase Slop (ps3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$slop</strong>  Phrase slop

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields


id: SolrDisMaxQuery::setUserFields
type: function
doc:
<comment>Description:</comment>
  Sets User Fields parameter (uf)
  
  Sets User Fields parameter (uf)
  
  User Fields: Specifies which schema fields the end user shall be allowed to query.

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Fields names separated by space
                   
                   This parameter supports wildcards.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addUserField
   * SolrDisMaxQuery::removeUserField


id: SolrDisMaxQuery::useDisMaxQueryParser
type: function
doc:
<comment>Description:</comment>
  Switch QueryParser to be DisMax Query Parser
  
  Switch QueryParser to be DisMax Query Parser

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::useDisMaxQueryParser


id: SolrDisMaxQuery::useEDisMaxQueryParser
type: function
doc:
<comment>Description:</comment>
  Switch QueryParser to be EDisMax
  
  Switch QueryParser to be EDisMax. By default the query builder uses edismax, if it was switched
  using SolrDisMaxQuery::useDisMaxQueryParser, it can be switched back using this method.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDocument::__clone
type: function
doc:
<comment>Description:</comment>
  Creates a copy of a SolrDocument object
  
  Creates a copy of a SolrDocument object. Not to be called directly.

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


id: SolrDocument::__get
type: function
doc:
<comment>Description:</comment>
  Access the field as a property
  
  Magic method for accessing the field as a property.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Returns a SolrDocumentField instance.


id: SolrDocument::__isset
type: function
doc:
<comment>Description:</comment>
  Checks if a field exists
  
  Checks if a field exists

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Name of the field.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrDocument::__set
type: function
doc:
<comment>Description:</comment>
  Adds another field to the document
  
  Adds another field to the document. Used to set the fields as new properties.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>   Name of the field.
  <info>string</info>  <strong>$fieldValue</strong>  Field value.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrDocument::__unset
type: function
doc:
<comment>Description:</comment>
  Removes a field from the document
  
  Removes a field from the document when the field is access as an object property.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrDocument::addField
type: function
doc:
<comment>Description:</comment>
  Adds a field to the document
  
  This method adds a field to the SolrDocument instance.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>   The name of the field
  <info>string</info>  <strong>$fieldValue</strong>  The value of the field.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrDocument::clear
type: function
doc:
<comment>Description:</comment>
  Drops all the fields in the document
  
  Resets the current object. Discards all the fields and resets the document boost to zero.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrDocument::current
type: function
doc:
<comment>Description:</comment>
  Retrieves the current field
  
  Retrieves the current field

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Returns the field


id: SolrDocument::deleteField
type: function
doc:
<comment>Description:</comment>
  Removes a field from the document
  
  Removes a field from the document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Name of the field

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrDocument::fieldExists
type: function
doc:
<comment>Description:</comment>
  Checks if a field exists in the document
  
  Checks if the requested field as a valid fieldname in the document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the field is present and <info>false</info> if it does not.


id: SolrDocument::getChildDocuments
type: function
doc:
<comment>Description:</comment>
  Returns an array of child documents (SolrDocument)
  
  Returns an array of child documents (SolrDocument)

<comment>Return:</comment>
  <info>array</info>  

<comment>See Also:</comment>
   * SolrDocument::hasChildDocuments
   * SolrDocument::getChildDocumentsCount


id: SolrDocument::getChildDocumentsCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of child documents
  
  Returns the number of child documents

<comment>Return:</comment>
  <info>int</info>  

<comment>See Also:</comment>
   * SolrDocument::hasChildDocuments
   * SolrDocument::getChildDocuments


id: SolrDocument::getField
type: function
doc:
<comment>Description:</comment>
  Retrieves a field by name
  
  Retrieves a field by name.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Name of the field.

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Returns a SolrDocumentField on success and <info>false</info> on failure.


id: SolrDocument::getFieldCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of fields in this document
  
  Returns the number of fields in this document. Multi-value fields are only counted once.

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>false</info> on failure.


id: SolrDocument::getFieldNames
type: function
doc:
<comment>Description:</comment>
  Returns an array of fields names in the document
  
  Returns an array of fields names in the document.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the names of the fields in this document.


id: SolrDocument::getInputDocument
type: function
doc:
<comment>Description:</comment>
  Returns a SolrInputDocument equivalent of the object
  
  Returns a SolrInputDocument equivalent of the object. This is useful if one wishes to
  resubmit/update a document retrieved from a query.

<comment>Return:</comment>
  <info>SolrInputDocument</info>  Returns a SolrInputDocument on success and <info>null</info> on failure.


id: SolrDocument::hasChildDocuments
type: function
doc:
<comment>Description:</comment>
  Checks whether the document has any child documents
  
  Checks whether the document has any child documents

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * SolrDocument::getChildDocuments
   * SolrDocument::getChildDocumentsCount


id: SolrDocument::key
type: function
doc:
<comment>Description:</comment>
  Retrieves the current key
  
  Retrieves the current key.

<comment>Return:</comment>
  <info>string</info>  Returns the current key.


id: SolrDocument::merge
type: function
doc:
<comment>Description:</comment>
  Merges source to the current SolrDocument
  
  Merges source to the current SolrDocument.

<comment>Param:</comment>
  <info>SolrDocument</info>  <strong>$sourceDoc</strong>  The source document.
  <info>bool</info>          <strong>$overwrite</strong>  If this is <info>true</info> then fields with the same name in the destination
                            document will be overwritten.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrDocument::next
type: function
doc:
<comment>Description:</comment>
  Moves the internal pointer to the next field
  
  Moves the internal pointer to the next field.

<comment>Return:</comment>
  <info>void</info>  This method has no return value.


id: SolrDocument::offsetExists
type: function
doc:
<comment>Description:</comment>
  Checks if a particular field exists
  
  Checks if a particular field exists. This is used when the object is treated as an array.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrDocument::offsetGet
type: function
doc:
<comment>Description:</comment>
  Retrieves a field
  
  This is used to retrieve the field when the object is treated as an array.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Returns a SolrDocumentField object.


id: SolrDocument::offsetSet
type: function
doc:
<comment>Description:</comment>
  Adds a field to the document
  
  Used when the object is treated as an array to add a field to the document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>   The name of the field.
  <info>string</info>  <strong>$fieldValue</strong>  The value for this field.

<comment>Return:</comment>
  <info>void</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrDocument::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Removes a field
  
  Removes a field from the document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>void</info>  No return value.


id: SolrDocument::reset
type: function
doc:
<comment>Description:</comment>
  Sinônimo de SolrDocument::clear
  
  This is an alias to SolrDocument::clear()

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrDocument::rewind
type: function
doc:
<comment>Description:</comment>
  Resets the internal pointer to the beginning
  
  Resets the internal pointer to the beginning.

<comment>Return:</comment>
  <info>void</info>  This method has no return value.


id: SolrDocument::serialize
type: function
doc:
<comment>Description:</comment>
  Used for custom serialization
  
  Used for custom serialization.

<comment>Return:</comment>
  <info>string</info>  Returns a string representing the serialized Solr document.


id: SolrDocument::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the fields in the document
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$sortOrderBy</strong>    The sort criteria.
  <info>int</info>  <strong>$sortDirection</strong>  The sort direction.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrDocument::toArray
type: function
doc:
<comment>Description:</comment>
  Returns an array representation of the document
  
  Returns an array representation of the document.

<comment>Return:</comment>
  <info>array</info>  Returns an array representation of the document.


id: SolrDocument::unserialize
type: function
doc:
<comment>Description:</comment>
  Custom serialization of SolrDocument objects
  
  Custom serialization of SolrDocument objects

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  An XML representation of the document.

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


id: SolrDocument::valid
type: function
doc:
<comment>Description:</comment>
  Checks if the current position internally is still valid
  
  Checks if the current position internally is still valid. It is used during foreach operations.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success and <info>false</info> if the current position is no longer valid.


id: SolrDocumentField
type: class
doc:
<comment>Description:</comment>
  This represents a field in a Solr document. All its properties are read-only.


id: SolrDocumentField::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Constructor.

<comment>Return:</comment>
  <info>unknown</info>  None.


id: SolrDocumentField::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  Destructor.

<comment>Return:</comment>
  <info>unknown</info>  None.


id: SolrException
type: class
doc:
<comment>Description:</comment>
  This is the base class for all exception thrown by the Solr extension classes.


id: SolrGenericResponse::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Constructor

<comment>Return:</comment>
  <info>unknown</info>  None


id: SolrGenericResponse::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  Destructor.

<comment>Return:</comment>
  <info>unknown</info>  None


id: SolrIllegalArgumentException
type: class
doc:
<comment>Description:</comment>
  This object is thrown when an illegal or invalid argument is passed to a method.


id: SolrIllegalArgumentException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  Returns internal information where the Exception was thrown
  
  Returns internal information where the Exception was thrown.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing internal information where the error was thrown. Used only for
         debugging by extension developers.


id: SolrIllegalOperationException
type: class
doc:
<comment>Description:</comment>
  This object is thrown when an illegal or unsupported operation is performed on an object.


id: SolrInputDocument
type: class
doc:
<comment>Description:</comment>
  This class represents a Solr document that is about to be submitted to the Solr index.


id: SolrInputDocument::__clone
type: function
doc:
<comment>Description:</comment>
  Creates a copy of a SolrDocument
  
  Should not be called directly. It is used to create a deep copy of a SolrInputDocument.

<comment>Return:</comment>
  <info>void</info>  Creates a new SolrInputDocument instance.


id: SolrInputDocument::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  Destructor

<comment>Return:</comment>
  <info>unknown</info>  None.


id: SolrInputDocument::addChildDocument
type: function
doc:
<comment>Description:</comment>
  Adds a child document for block indexing
  
  Adds a child document to construct a document block with nested documents.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$child</strong>  A <info>SolrInputDocument</info> object.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::addChildDocuments
type: function
doc:
<comment>Description:</comment>
  Adds an array of child documents
  
  Adds an array of child documents to the current input document.

<comment>Param:</comment>
  <info>array</info>  <strong>$docs</strong>  An <info>array</info> of <info>SolrInputDocument</info> objects.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::addField
type: function
doc:
<comment>Description:</comment>
  Adds a field to the document
  
  For multi-value fields, if a valid boost value is specified, the specified value will be
  multiplied by the current boost value for this field.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>        The name of the field
  <info>string</info>  <strong>$fieldValue</strong>       The value for the field.
  <info>float</info>   <strong>$fieldBoostValue</strong>  The index time boost for the field. Though this cannot be negative, you
                            can still pass values less than 1.0 but they must be greater than zero.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrInputDocument::clear
type: function
doc:
<comment>Description:</comment>
  Resets the input document
  
  Resets the document by dropping all the fields and resets the document boost to zero.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrInputDocument::deleteField
type: function
doc:
<comment>Description:</comment>
  Removes a field from the document
  
  Removes a field from the document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrInputDocument::fieldExists
type: function
doc:
<comment>Description:</comment>
  Checks if a field exists
  
  Checks if a field exists

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Name of the field.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the field was found and <info>false</info> if it was not found.


id: SolrInputDocument::getBoost
type: function
doc:
<comment>Description:</comment>
  Retrieves the current boost value for the document
  
  Retrieves the current boost value for the document.

<comment>Return:</comment>
  <info>float</info>  Returns the boost value on success and <info>false</info> on failure.


id: SolrInputDocument::getChildDocuments
type: function
doc:
<comment>Description:</comment>
  Returns an array of child documents (SolrInputDocument)
  
  Returns an array of child documents (SolrInputDocument)

<comment>Return:</comment>
  <info>array</info>  

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::getChildDocumentsCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of child documents
  
  Returns the number of child documents

<comment>Return:</comment>
  <info>int</info>  

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments


id: SolrInputDocument::getField
type: function
doc:
<comment>Description:</comment>
  Retrieves a field by name
  
  Retrieves a field in the document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Returns a SolrDocumentField object on success and <info>false</info> on failure.


id: SolrInputDocument::getFieldBoost
type: function
doc:
<comment>Description:</comment>
  Retrieves the boost value for a particular field
  
  Retrieves the boost value for a particular field.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>float</info>  Returns the boost value for the field or <info>false</info> if there was an error.


id: SolrInputDocument::getFieldCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of fields in the document
  
  Returns the number of fields in the document.

<comment>Return:</comment>
  <info>int|false</info>  Returns an integer on success ou <info>false</info> em caso de falha.


id: SolrInputDocument::getFieldNames
type: function
doc:
<comment>Description:</comment>
  Returns an array containing all the fields in the document
  
  Returns an array containing all the fields in the document.

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>false</info> on failure.


id: SolrInputDocument::hasChildDocuments
type: function
doc:
<comment>Description:</comment>
  Returns true if the document has any child documents
  
  Checks whether the document has any child documents

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::merge
type: function
doc:
<comment>Description:</comment>
  Merges one input document into another
  
  Merges one input document into another.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$sourceDoc</strong>  The source document.
  <info>bool</info>               <strong>$overwrite</strong>  If this is <info>true</info> it will replace matching fields in the destination
                                 document.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. In the future, this will be
        modified to return the number of fields in the new document.


id: SolrInputDocument::reset
type: function
doc:
<comment>Description:</comment>
  Sinônimo de SolrInputDocument::clear
  
  This is an alias of SolrInputDocument::clear

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrInputDocument::setBoost
type: function
doc:
<comment>Description:</comment>
  Sets the boost value for this document
  
  Sets the boost value for this document.

<comment>Param:</comment>
  <info>float</info>  <strong>$documentBoostValue</strong>  The index-time boost value for this document.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrInputDocument::setFieldBoost
type: function
doc:
<comment>Description:</comment>
  Sets the index-time boost value for a field
  
  Sets the index-time boost value for a field. This replaces the current boost value for this field.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>        The name of the field.
  <info>float</info>   <strong>$fieldBoostValue</strong>  The index time boost value.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrInputDocument::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the fields within the document
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$sortOrderBy</strong>    The sort criteria
  <info>int</info>  <strong>$sortDirection</strong>  The sort direction

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrInputDocument::toArray
type: function
doc:
<comment>Description:</comment>
  Returns an array representation of the input document
  
  Returns an array representation of the input document.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the fields. It returns <info>false</info> on failure.


id: SolrModifiableParams
type: class
doc:
<comment>Description:</comment>
  Represents a collection of name-value pairs sent to the Solr server during a request.


id: SolrModifiableParams::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  Destructor

<comment>Return:</comment>
  <info>unknown</info>  None


id: SolrObject
type: class
doc:
<comment>Description:</comment>
  This is an object whose properties can also by accessed using the array syntax. All its properties
  are read-only.


id: SolrObject::__construct
type: function
doc:
<comment>Description:</comment>
  Creates Solr object
  
  Creates Solr object.

<comment>Return:</comment>
  <info>unknown</info>  None


id: SolrObject::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  The destructor

<comment>Return:</comment>
  <info>unknown</info>  None.


id: SolrObject::getPropertyNames
type: function
doc:
<comment>Description:</comment>
  Returns an array of all the names of the properties
  
  Returns an array of all the names of the properties

<comment>Return:</comment>
  <info>array</info>  Returns an array.


id: SolrObject::offsetExists
type: function
doc:
<comment>Description:</comment>
  Checks if the property exists
  
  Checks if the property exists. This is used when the object is treated as an array.

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

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrObject::offsetGet
type: function
doc:
<comment>Description:</comment>
  Used to retrieve a property
  
  Used to get the value of a property. This is used when the object is treated as an array.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  Name of the property.

<comment>Return:</comment>
  <info>mixed</info>  Returns the property value.


id: SolrObject::offsetSet
type: function
doc:
<comment>Description:</comment>
  Sets the value for a property
  
  Sets the value for a property. This is used when the object is treated as an array. This object is
  read-only. This should never be attempted.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>   The name of the property.
  <info>string</info>  <strong>$property_value</strong>  The new value.

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


id: SolrObject::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Unsets the value for the property
  
  Unsets the value for the property. This is used when the object is treated as an array. This
  object is read-only. This should never be attempted.

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

<comment>Return:</comment>
  <info>void</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrParams::add
type: function
doc:
<comment>Description:</comment>
  Sinônimo de SolrParams::addParam
  
  This is an alias for SolrParams::addParam

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   The name of the parameter
  <info>string</info>  <strong>$value</strong>  The value of the parameter

<comment>Return:</comment>
  <info>SolrParams</info>  Returns a SolrParams instance on success


id: SolrParams::addParam
type: function
doc:
<comment>Description:</comment>
  Adds a parameter to the object
  
  Adds a parameter to the object. This is used for parameters that can be specified multiple times.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Name of parameter
  <info>string</info>  <strong>$value</strong>  Value of parameter

<comment>Return:</comment>
  <info>SolrParams</info>  Returns a SolrParam object on success and <info>false</info> on failure.


id: SolrParams::get
type: function
doc:
<comment>Description:</comment>
  Sinônimo de SolrParams::getParam
  
  This is an alias for SolrParams::getParam

<comment>Param:</comment>
  <info>string</info>  <strong>$param_name</strong>  Then name of the parameter

<comment>Return:</comment>
  <info>mixed</info>  Returns an array or string depending on the type of parameter


id: SolrParams::getParam
type: function
doc:
<comment>Description:</comment>
  Returns a parameter value
  
  Returns a parameter with name param_name

<comment>Param:</comment>
  <info>string</info>  <strong>$param_name</strong>  The name of the parameter

<comment>Return:</comment>
  <info>mixed</info>  Returns a string or an array depending on the type of the parameter


id: SolrParams::getParams
type: function
doc:
<comment>Description:</comment>
  Returns an array of non URL-encoded parameters
  
  Returns an array of non URL-encoded parameters

<comment>Return:</comment>
  <info>array</info>  Returns an array of non URL-encoded parameters


id: SolrParams::getPreparedParams
type: function
doc:
<comment>Description:</comment>
  Returns an array of URL-encoded parameters
  
  Returns an array on URL-encoded parameters

<comment>Return:</comment>
  <info>array</info>  Returns an array on URL-encoded parameters


id: SolrParams::serialize
type: function
doc:
<comment>Description:</comment>
  Used for custom serialization
  
  Used for custom serialization

<comment>Return:</comment>
  <info>string</info>  Used for custom serialization


id: SolrParams::set
type: function
doc:
<comment>Description:</comment>
  Sinônimo de SolrParams::setParam
  
  An alias of SolrParams::setParam

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Then name of the parameter
  <info>string</info>  <strong>$value</strong>  The parameter value

<comment>Return:</comment>
  <info>void</info>  Returns an instance of the SolrParams object on success


id: SolrParams::setParam
type: function
doc:
<comment>Description:</comment>
  Sets the parameter to the specified value
  
  Sets the query parameter to the specified value. This is used for parameters that can only be
  specified once. Subsequent calls with the same parameter name will override the existing value

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Name of the parameter
  <info>string</info>  <strong>$value</strong>  Value of the parameter

<comment>Return:</comment>
  <info>SolrParams</info>  Returns a SolrParam object on success and <info>false</info> on value.


id: SolrParams::toString
type: function
doc:
<comment>Description:</comment>
  Returns all the name-value pair parameters in the object
  
  Returns all the name-value pair parameters in the object

<comment>Param:</comment>
  <info>bool</info>  <strong>$url_encode</strong>  Whether to return URL-encoded values

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>false</info> on failure.


id: SolrParams::unserialize
type: function
doc:
<comment>Description:</comment>
  Used for custom serialization
  
  Used for custom serialization

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  The serialized representation of the object

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


id: SolrPingResponse::getResponse
type: function
doc:
<comment>Description:</comment>
  Returns the response from the server
  
  Returns the response from the server. This should be empty because the request as a HEAD request.

<comment>Return:</comment>
  <info>string</info>  Returns an empty string.


id: SolrQuery::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Constructor.

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Optional search query

<comment>Return:</comment>
  <info>unknown</info>  None


id: SolrQuery::addExpandFilterQuery
type: function
doc:
<comment>Description:</comment>
  Overrides main filter query, determines which documents to include in the main group
  
  Overrides main filter query, determines which documents to include in the main group.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::addExpandSortField
type: function
doc:
<comment>Description:</comment>
  Orders the documents within the expanded groups (expand.sort parameter)
  
  Orders the documents within the expanded groups (expand.sort parameter).

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$order</strong>  Order ASC/DESC, utilizes SolrQuery::ORDER_* constants.
                  
                  Default: <info>SolrQuery::ORDER_DESC</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::addFacetDateField
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date
  
  This method allows you to specify a field which should be treated as a facet.
  
  It can be used multiple times with different field names to indicate multiple facet fields

<comment>Param:</comment>
  <info>string</info>  <strong>$dateField</strong>  The name of the date field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns a SolrQuery object.


id: SolrQuery::addFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Adds another facet.date.other parameter
  
  Sets the facet.date.other parameter. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           The value to use.
  <info>string</info>  <strong>$field_override</strong>  The field name for the override.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addFacetField
type: function
doc:
<comment>Description:</comment>
  Adds another field to the facet
  
  Adds another field to the facet

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addFacetQuery
type: function
doc:
<comment>Description:</comment>
  Adds a facet query
  
  Adds a facet query

<comment>Param:</comment>
  <info>string</info>  <strong>$facetQuery</strong>  The facet query

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addField
type: function
doc:
<comment>Description:</comment>
  Specifies which fields to return in the result
  
  This method is used to used to specify a set of fields to return, thereby restricting the amount
  of data returned in the response.
  
  It should be called multiple time, once for each field name.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object


id: SolrQuery::addFilterQuery
type: function
doc:
<comment>Description:</comment>
  Specifies a filter query
  
  Specifies a filter query

<comment>Param:</comment>
  <info>string</info>  <strong>$fq</strong>  The filter query

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object.


id: SolrQuery::addGroupField
type: function
doc:
<comment>Description:</comment>
  Add a field to be used to group results
  
  The name of the field by which to group results. The field must be single-valued, and either be
  indexed or a field type that has a value source and works in a function query, such as
  ExternalFileField. It must also be a string-based field, such as StrField or TextField Uses
  group.field parameter

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupFunction
type: function
doc:
<comment>Description:</comment>
  Allows grouping results based on the unique values of a function query (group.func parameter)
  
  Adds a group function (group.func parameter) Allows grouping results based on the unique values of
  a function query.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupQuery
type: function
doc:
<comment>Description:</comment>
  Allows grouping of documents that match the given query
  
  Allows grouping of documents that match the given query. Adds query to the group.query parameter

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupSortField
type: function
doc:
<comment>Description:</comment>
  Add a group sort field (group.sort parameter)
  
  Allow sorting group documents, using group sort field (group.sort parameter).

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field name
  <info>int</info>     <strong>$order</strong>  Order ASC/DESC, utilizes SolrQuery::ORDER_* constants

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addHighlightField
type: function
doc:
<comment>Description:</comment>
  Maps to hl.fl
  
  Maps to hl.fl. This is used to specify that highlighted snippets should be generated for a
  particular field

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addMltField
type: function
doc:
<comment>Description:</comment>
  Sets a field to use for similarity
  
  Maps to mlt.fl. It specifies that a field should be used for similarity.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addMltQueryField
type: function
doc:
<comment>Description:</comment>
  Maps to mlt.qf
  
  Maps to mlt.qf. It is used to specify query fields and their boosts

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field
  <info>float</info>   <strong>$boost</strong>  Its boost value

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addSortField
type: function
doc:
<comment>Description:</comment>
  Used to control how the results should be sorted
  
  Used to control how the results should be sorted.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field
  <info>int</info>     <strong>$order</strong>  The sort direction. This should be either SolrQuery::ORDER_ASC or
                  SolrQuery::ORDER_DESC.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object.


id: SolrQuery::addStatsFacet
type: function
doc:
<comment>Description:</comment>
  Requests a return of sub results for values within the given facet 
  
  Requests a return of sub results for values within the given facet. Maps to the stats.facet field

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addStatsField
type: function
doc:
<comment>Description:</comment>
  Maps to stats.field parameter
  
  Maps to stats.field parameter This methods adds another stats.field parameter.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::collapse
type: function
doc:
<comment>Description:</comment>
  Collapses the result set to a single document per group
  
  Collapses the result set to a single document per group before it forwards the result set to the
  rest of the search components.
  
  So all downstream components (faceting, highlighting, etc...) will work with the collapsed result
  set.

<comment>Param:</comment>
  <info>SolrCollapseFunction</info>  <strong>$collapseFunction</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current <info>SolrQuery</info> object


id: SolrQuery::getExpand
type: function
doc:
<comment>Description:</comment>
  Returns true if group expanding is enabled
  
  Returns <info>true</info> if group expanding is enabled

<comment>Return:</comment>
  <info>bool</info>  Returns whether group expanding is enabled.


id: SolrQuery::getExpandFilterQueries
type: function
doc:
<comment>Description:</comment>
  Returns the expand filter queries
  
  Returns the expand filter queries

<comment>Return:</comment>
  <info>array</info>  Returns the expand filter queries.


id: SolrQuery::getExpandQuery
type: function
doc:
<comment>Description:</comment>
  Returns the expand query expand.q parameter
  
  Returns the expand query expand.q parameter

<comment>Return:</comment>
  <info>array</info>  Returns the expand query.


id: SolrQuery::getExpandRows
type: function
doc:
<comment>Description:</comment>
  Returns The number of rows to display in each group (expand.rows)
  
  Returns The number of rows to display in each group (expand.rows)

<comment>Return:</comment>
  <info>int</info>  Returns the number of rows.


id: SolrQuery::getExpandSortFields
type: function
doc:
<comment>Description:</comment>
  Returns an array of fields
  
  Returns an array of fields

<comment>Return:</comment>
  <info>array</info>  Returns an array of fields.


id: SolrQuery::getFacet
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet parameter
  
  Returns the value of the facet parameter.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set


id: SolrQuery::getFacetDateEnd
type: function
doc:
<comment>Description:</comment>
  Returns the value for the facet.date.end parameter
  
  Returns the value for the facet.date.end parameter. This method accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetDateFields
type: function
doc:
<comment>Description:</comment>
  Returns all the facet.date fields
  
  Returns all the facet.date fields

<comment>Return:</comment>
  <info>array</info>  Returns all the facet.date fields as an array or <info>null</info> if none was set


id: SolrQuery::getFacetDateGap
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet.date.gap parameter
  
  Returns the value of the facet.date.gap parameter. It accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetDateHardEnd
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet.date.hardend parameter
  
  Returns the value of the facet.date.hardend parameter. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Returns the value for the facet.date.other parameter
  
  Returns the value for the facet.date.other parameter. This method accepts an optional field
  override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> on success and <info>null</info> if not set.


id: SolrQuery::getFacetDateStart
type: function
doc:
<comment>Description:</comment>
  Returns the  lower bound for the first date range for all date faceting on this field
  
  Returns the  lower bound for the first date range for all date faceting on this field. Accepts an
  optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetFields
type: function
doc:
<comment>Description:</comment>
  Returns all the facet fields
  
  Returns all the facet fields

<comment>Return:</comment>
  <info>array</info>  Returns an array of all the fields and <info>null</info> if none was set


id: SolrQuery::getFacetLimit
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of constraint counts that should be returned for the facet fields
  
  Returns the maximum number of constraint counts that should be returned for the facet fields. This
  method accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field to override for

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set


id: SolrQuery::getFacetMethod
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet.method parameter
  
  Returns the value of the facet.method parameter. This accepts an optional field override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetMinCount
type: function
doc:
<comment>Description:</comment>
  Returns the minimum counts for facet fields should be included in the response
  
  Returns the minimum counts for facet fields should be included in the response. It accepts an
  optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set


id: SolrQuery::getFacetMissing
type: function
doc:
<comment>Description:</comment>
  Returns the current state of the facet.missing parameter
  
  Returns the current state of the facet.missing parameter. This accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set


id: SolrQuery::getFacetOffset
type: function
doc:
<comment>Description:</comment>
  Returns an offset into the list of constraints to be used for pagination
  
  Returns an offset into the list of constraints to be used for pagination. Accepts an optional
  field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field to override for.

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set


id: SolrQuery::getFacetPrefix
type: function
doc:
<comment>Description:</comment>
  Returns the facet prefix
  
  Returns the facet prefix

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getFacetQueries
type: function
doc:
<comment>Description:</comment>
  Returns all the facet queries
  
  Returns all the facet queries

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getFacetSort
type: function
doc:
<comment>Description:</comment>
  Returns the facet sort type
  
  Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT)

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) on success or
       <info>null</info> if not set.


id: SolrQuery::getFields
type: function
doc:
<comment>Description:</comment>
  Returns the list of fields that will be returned in the response
  
  Returns the list of fields that will be returned in the response

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getFilterQueries
type: function
doc:
<comment>Description:</comment>
  Returns an array of filter queries
  
  Returns an array of filter queries. These are queries that can be used to restrict the super set
  of documents that can be returned, without influencing score

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getGroup
type: function
doc:
<comment>Description:</comment>
  Returns true if grouping is enabled
  
  Returns true if grouping is enabled

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup


id: SolrQuery::getGroupCachePercent
type: function
doc:
<comment>Description:</comment>
  Returns group cache percent value
  
  Returns group cache percent value

<comment>Return:</comment>
  <info>int</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroupCachePercent


id: SolrQuery::getGroupFacet
type: function
doc:
<comment>Description:</comment>
  Returns the group.facet parameter value
  
  Returns the group.facet parameter value

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroupFacet


id: SolrQuery::getGroupFields
type: function
doc:
<comment>Description:</comment>
  Returns group fields (group.field parameter values)
  
  Returns group fields (group.field parameter values)

<comment>Return:</comment>
  <info>array</info>  

<comment>See Also:</comment>
   * SolrQuery::addGroupField


id: SolrQuery::getGroupFormat
type: function
doc:
<comment>Description:</comment>
  Returns the group.format value
  
  Returns the group.format value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupFormat


id: SolrQuery::getGroupFunctions
type: function
doc:
<comment>Description:</comment>
  Returns group functions (group.func parameter values)
  
  Returns group functions (group.func parameter values)

<comment>Return:</comment>
  <info>array</info>  

<comment>See Also:</comment>
   * SolrQuery::addGroupFunction


id: SolrQuery::getGroupLimit
type: function
doc:
<comment>Description:</comment>
  Returns the group.limit value
  
  Returns the group.limit value

<comment>Return:</comment>
  <info>int</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroupLimit


id: SolrQuery::getGroupMain
type: function
doc:
<comment>Description:</comment>
  Returns the group.main value
  
  Returns the group.main value

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroupMain


id: SolrQuery::getGroupNGroups
type: function
doc:
<comment>Description:</comment>
  Returns the group.ngroups value
  
  Returns the group.ngroups value

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroupNGroups


id: SolrQuery::getGroupOffset
type: function
doc:
<comment>Description:</comment>
  Returns the group.offset value
  
  Returns the group.offset value

<comment>Return:</comment>
  <info>int</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroupOffset


id: SolrQuery::getGroupQueries
type: function
doc:
<comment>Description:</comment>
  Returns all the group.query parameter values
  
  Returns all the group.query parameter values

<comment>Return:</comment>
  <info>array</info>  <info>array</info>

<comment>See Also:</comment>
   * SolrQuery::addGroupQuery


id: SolrQuery::getGroupSortFields
type: function
doc:
<comment>Description:</comment>
  Returns the group.sort value
  
  Returns the group.sort value

<comment>Return:</comment>
  <info>array</info>  

<comment>See Also:</comment>
   * SolrQuery::addGroupSortField


id: SolrQuery::getGroupTruncate
type: function
doc:
<comment>Description:</comment>
  Returns the group.truncate value
  
  Returns the group.truncate value

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroupTruncate


id: SolrQuery::getHighlight
type: function
doc:
<comment>Description:</comment>
  Returns the state of the hl parameter
  
  Returns a boolean indicating whether or not to enable highlighted snippets to be generated in the
  query response.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightAlternateField
type: function
doc:
<comment>Description:</comment>
  Returns the highlight field to use as backup or default
  
  Returns the highlight field to use as backup or default. It accepts an optional override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFields
type: function
doc:
<comment>Description:</comment>
  Returns all the fields that Solr should generate highlighted snippets for
  
  Returns all the fields that Solr should generate highlighted snippets for

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFormatter
type: function
doc:
<comment>Description:</comment>
  Returns the formatter for the highlighted output
  
  Returns the formatter for the highlighted output

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFragmenter
type: function
doc:
<comment>Description:</comment>
  Returns the text snippet generator for highlighted text
  
  Returns the text snippet generator for highlighted text. Accepts an optional field override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFragsize
type: function
doc:
<comment>Description:</comment>
  Returns the number of characters of fragments to consider for highlighting
  
  Returns the number of characters of fragments to consider for highlighting. Zero implies no
  fragmenting. The entire field should be used.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success or <info>null</info> if not set.


id: SolrQuery::getHighlightHighlightMultiTerm
type: function
doc:
<comment>Description:</comment>
  Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries
  
  Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightMaxAlternateFieldLength
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of characters of the field to return
  
  Returns the maximum number of characters of the field to return

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of characters into a document to look for suitable snippets
  
  Returns the maximum number of characters into a document to look for suitable snippets

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightMergeContiguous
type: function
doc:
<comment>Description:</comment>
  Returns whether or not the collapse contiguous fragments into a single fragment
  
  Returns whether or not the collapse contiguous fragments into a single fragment. Accepts an
  optional field override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRegexMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of characters from a field when using the regex fragmenter
  
  Returns the maximum number of characters from a field when using the regex fragmenter

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRegexPattern
type: function
doc:
<comment>Description:</comment>
  Returns the regular expression for fragmenting
  
  Returns the regular expression used for fragmenting

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRegexSlop
type: function
doc:
<comment>Description:</comment>
  Returns the deviation factor from the ideal fragment size
  
  Returns the factor by which the regex fragmenter can deviate from the ideal fragment size to
  accommodate the regular expression

<comment>Return:</comment>
  <info>float</info>  Returns a <info>float</info> on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRequireFieldMatch
type: function
doc:
<comment>Description:</comment>
  Returns if a field will only be highlighted if the query matched in this particular field
  
  Returns if a field will only be highlighted if the query matched in this particular field.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightSimplePost
type: function
doc:
<comment>Description:</comment>
  Returns the text which appears after a highlighted term
  
  Returns the text which appears after a highlighted term. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightSimplePre
type: function
doc:
<comment>Description:</comment>
  Returns the text which appears before a highlighted term
  
  Returns the text which appears before a highlighted term. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightSnippets
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of highlighted snippets to generate per field
  
  Returns the maximum number of highlighted snippets to generate per field. Accepts an optional
  field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightUsePhraseHighlighter
type: function
doc:
<comment>Description:</comment>
  Returns the state of the hl.usePhraseHighlighter parameter
  
  Returns whether or not to use SpanScorer to highlight phrase terms only when they appear within
  the query phrase in the document.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getMlt
type: function
doc:
<comment>Description:</comment>
  Returns whether or not MoreLikeThis results should be enabled
  
  Returns whether or not MoreLikeThis results should be enabled

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getMltBoost
type: function
doc:
<comment>Description:</comment>
  Returns whether or not the query will be boosted by the interesting term relevance
  
  Returns whether or not the query will be boosted by the interesting term relevance

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getMltCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of similar documents to return for each result
  
  Returns the number of similar documents to return for each result

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltFields
type: function
doc:
<comment>Description:</comment>
  Returns all the fields to use for similarity
  
  Returns all the fields to use for similarity

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getMltMaxNumQueryTerms
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of query terms that will be included in any generated query
  
  Returns the maximum number of query terms that will be included in any generated query

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMaxNumTokens
type: function
doc:
<comment>Description:</comment>
  Retorna o número máximo de tokens para analisar em cada campo do documento que não está armazenado
  com suporte a TermVector
  
  Retorna o número máximo de tokens para analisar em cada campo do documento que não está armazenado
  com suporte a TermVector

<comment>Return:</comment>
  <info>int</info>  Retorna um inteiro em caso de sucesso e <info>null</info> se não for definido.


id: SolrQuery::getMltMaxWordLength
type: function
doc:
<comment>Description:</comment>
  Returns the maximum word length above which words will be ignored
  
  Returns the maximum word length above which words will be ignored

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMinDocFrequency
type: function
doc:
<comment>Description:</comment>
  Returns the treshold frequency at which words will be ignored which do not occur in at least this
  many docs
  
  Returns the treshold frequency at which words will be ignored which do not occur in at least this
  many docs

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMinTermFrequency
type: function
doc:
<comment>Description:</comment>
  Returns the frequency below which terms will be ignored in the source document
  
  Returns the frequency below which terms will be ignored in the source document

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMinWordLength
type: function
doc:
<comment>Description:</comment>
  Returns the minimum word length below which words will be ignored
  
  Returns the minimum word length below which words will be ignored

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltQueryFields
type: function
doc:
<comment>Description:</comment>
  Returns the query fields and their boosts
  
  Returns the query fields and their boosts

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getQuery
type: function
doc:
<comment>Description:</comment>
  Returns the main query
  
  Returns the main search query

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getRows
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of documents
  
  Returns the maximum number of documents from the complete result set to return to the client for
  every request

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getSortFields
type: function
doc:
<comment>Description:</comment>
  Returns all the sort fields
  
  Returns all the sort fields

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if none of the parameters was set.


id: SolrQuery::getStart
type: function
doc:
<comment>Description:</comment>
  Returns the offset in the complete result set 
  
  Returns the offset in the complete result set for the queries where the set of returned documents
  should begin.

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getStats
type: function
doc:
<comment>Description:</comment>
  Returns whether or not stats is enabled
  
  Returns whether or not stats is enabled

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getStatsFacets
type: function
doc:
<comment>Description:</comment>
  Returns all the stats facets that were set
  
  Returns all the stats facets that were set

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getStatsFields
type: function
doc:
<comment>Description:</comment>
  Returns all the statistics fields
  
  Returns all the statistics fields

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getTerms
type: function
doc:
<comment>Description:</comment>
  Returns whether or not the TermsComponent is enabled
  
  Returns whether or not the TermsComponent is enabled

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsField
type: function
doc:
<comment>Description:</comment>
  Returns the field from which the terms are retrieved
  
  Returns the field from which the terms are retrieved

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTermsIncludeLowerBound
type: function
doc:
<comment>Description:</comment>
  Returns whether or not to include the lower bound in the result set
  
  Returns whether or not to include the lower bound in the result set

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsIncludeUpperBound
type: function
doc:
<comment>Description:</comment>
  Returns whether or not to include the upper bound term in the result set
  
  Returns whether or not to include the upper bound term in the result set

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsLimit
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of terms Solr should return
  
  Returns the maximum number of terms Solr should return

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsLowerBound
type: function
doc:
<comment>Description:</comment>
  Returns the term to start at
  
  Returns the term to start at

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTermsMaxCount
type: function
doc:
<comment>Description:</comment>
  Returns the maximum document frequency
  
  Returns the maximum document frequency

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsMinCount
type: function
doc:
<comment>Description:</comment>
  Returns the minimum document frequency to return in order to be included
  
  Returns the minimum document frequency to return in order to be included

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsPrefix
type: function
doc:
<comment>Description:</comment>
  Returns the term prefix
  
  Returns the prefix to which matching terms must be restricted. This will restrict matches to only
  terms that start with the prefix

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTermsReturnRaw
type: function
doc:
<comment>Description:</comment>
  Whether or not to return raw characters
  
  Returns a boolean indicating whether or not to return the raw characters of the indexed term,
  regardless of if it is human readable

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsSort
type: function
doc:
<comment>Description:</comment>
  Returns an integer indicating how terms are sorted
  
  SolrQuery::TERMS_SORT_INDEX indicates that the terms are returned by index order.
  SolrQuery::TERMS_SORT_COUNT implies that the terms are sorted by term frequency (highest count
  first)

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsUpperBound
type: function
doc:
<comment>Description:</comment>
  Returns the term to stop at
  
  Returns the term to stop at

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTimeAllowed
type: function
doc:
<comment>Description:</comment>
  Returns the time in milliseconds allowed for the query to finish
  
  Returns the time in milliseconds allowed for the query to finish.

<comment>Return:</comment>
  <info>int</info>  Returns and integer on success and <info>null</info> if it is not set.


id: SolrQuery::removeExpandFilterQuery
type: function
doc:
<comment>Description:</comment>
  Removes an expand filter query
  
  Removes an expand filter query.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery


id: SolrQuery::removeExpandSortField
type: function
doc:
<comment>Description:</comment>
  Removes an expand sort field from the expand.sort parameter
  
  Removes an expand sort field from the expand.sort parameter.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::removeFacetDateField
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet date fields
  
  The name of the field

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the date field to remove

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet.date.other parameters
  
  Removes one of the facet.date.other parameters

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           The value
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFacetField
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet.date parameters
  
  Removes one of the facet.date parameters

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFacetQuery
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet.query parameters
  
  Removes one of the facet.query parameters.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  The value

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeField
type: function
doc:
<comment>Description:</comment>
  Removes a field from the list of fields
  
  Removes a field from the list of fields

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFilterQuery
type: function
doc:
<comment>Description:</comment>
  Removes a filter query
  
  Removes a filter query.

<comment>Param:</comment>
  <info>string</info>  <strong>$fq</strong>  The filter query to remove

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeHighlightField
type: function
doc:
<comment>Description:</comment>
  Removes one of the fields used for highlighting
  
  Removes one of the fields used for highlighting.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeMltField
type: function
doc:
<comment>Description:</comment>
  Removes one of the moreLikeThis fields
  
  Removes one of the moreLikeThis fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeMltQueryField
type: function
doc:
<comment>Description:</comment>
  Removes one of the moreLikeThis query fields
  
  Removes one of the moreLikeThis query fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$queryField</strong>  The query field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeSortField
type: function
doc:
<comment>Description:</comment>
  Removes one of the sort fields
  
  Removes one of the sort fields

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeStatsFacet
type: function
doc:
<comment>Description:</comment>
  Removes one of the stats.facet parameters
  
  Removes one of the stats.facet parameters

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  The value

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeStatsField
type: function
doc:
<comment>Description:</comment>
  Removes one of the stats.field parameters
  
  Removes one of the stats.field parameters

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setEchoHandler
type: function
doc:
<comment>Description:</comment>
  Toggles the echoHandler parameter
  
  If set to true, Solr places the name of the handle used in the response to the client for
  debugging purposes.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setEchoParams
type: function
doc:
<comment>Description:</comment>
  Determines what kind of parameters to include in the response
  
  Instructs Solr what kinds of Request parameters should be included in the response for debugging
  purposes, legal values include:
  
  

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type of parameters to include

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setExpand
type: function
doc:
<comment>Description:</comment>
  Enables/Disables the Expand Component
  
  Enables/Disables the Expand Component.

<comment>Param:</comment>
  <info>bool</info>  <strong>$value</strong>  Bool flag

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExpandQuery
type: function
doc:
<comment>Description:</comment>
  Sets the expand.q parameter
  
  Sets the expand.q parameter.
  
  Overrides the main q parameter,  determines which documents to include in the main group.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExpandRows
type: function
doc:
<comment>Description:</comment>
  Sets the number of rows to display in each group (expand.rows). Server Default 5
  
  Sets the number of rows to display in each group (expand.rows). Server Default 5

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExplainOther
type: function
doc:
<comment>Description:</comment>
  Sets the explainOther common query parameter
  
  Sets the explainOther common query parameter

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The Lucene query to identify a set of documents

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacet
type: function
doc:
<comment>Description:</comment>
  Maps to the facet parameter. Enables or disables facetting
  
  Enables or disables faceting.

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  <info>true</info> enables faceting and <info>false</info> disables it.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateEnd
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.end
  
  Maps to facet.date.end

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           See facet.date.end
  <info>string</info>  <strong>$field_override</strong>  Name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateGap
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.gap
  
  Maps to facet.date.gap

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           See facet.date.gap
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateHardEnd
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.hardend
  
  Maps to facet.date.hardend

<comment>Param:</comment>
  <info>bool</info>    <strong>$value</strong>           See facet.date.hardend
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateStart
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.start
  
  Maps to facet.date.start

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           See facet.date.start
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetEnumCacheMinDefaultFrequency
type: function
doc:
<comment>Description:</comment>
  Sets the minimum document frequency used for determining term count
  
  Sets the minimum document frequency used for determining term count

<comment>Param:</comment>
  <info></info>        <strong>$value</strong>           The minimum frequency
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetLimit
type: function
doc:
<comment>Description:</comment>
  Maps to facet.limit
  
  Maps to facet.limit. Sets the maximum number of constraint counts that should be returned for the
  facet fields.

<comment>Param:</comment>
  <info>int</info>     <strong>$limit</strong>           The maximum number of constraint counts
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetMethod
type: function
doc:
<comment>Description:</comment>
  Specifies the type of algorithm to use when faceting a field
  
  Specifies the type of algorithm to use when faceting a field. This method accepts optional field
  override.

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>          The method to use.
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetMinCount
type: function
doc:
<comment>Description:</comment>
  Maps to facet.mincount
  
  Sets the minimum counts for facet fields that should be included in the response

<comment>Param:</comment>
  <info>int</info>     <strong>$mincount</strong>        The minimum count
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetMissing
type: function
doc:
<comment>Description:</comment>
  Maps to facet.missing
  
  Used to indicate that in addition to the Term-based constraints of a facet field, a count of all
  matching results which have no value for the field should be computed

<comment>Param:</comment>
  <info>bool</info>    <strong>$flag</strong>            <info>true</info> turns this feature on. <info>false</info> disables it.
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetOffset
type: function
doc:
<comment>Description:</comment>
  Sets the offset into the list of constraints to allow for pagination
  
  Sets the offset into the list of constraints to allow for pagination.

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>          The offset
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetPrefix
type: function
doc:
<comment>Description:</comment>
  Specifies a string prefix with which to limits the terms on which to facet
  
  Specifies a string prefix with which to limits the terms on which to facet.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>          The prefix string
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetSort
type: function
doc:
<comment>Description:</comment>
  Determines the ordering of the facet field constraints
  
  Determines the ordering of the facet field constraints

<comment>Param:</comment>
  <info>int</info>     <strong>$facetSort</strong>       Use SolrQuery::FACET_SORT_INDEX for sorting by index order or
                           SolrQuery::FACET_SORT_COUNT for sorting by count.
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setGroup
type: function
doc:
<comment>Description:</comment>
  Enable/Disable result grouping (group parameter)
  
  Enable/Disable result grouping (group parameter)

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::getGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupCachePercent
type: function
doc:
<comment>Description:</comment>
  Enables caching for result grouping
  
  Setting this parameter to a number greater than 0 enables caching for result grouping. Result
  Grouping executes two searches; this option caches the second search. The server default value is
  0.  Testing has shown that group caching only improves search time with Boolean, wildcard, and
  fuzzy queries. For simple queries like term or "match all" queries, group caching degrades
  performance. group.cache.percent parameter

<comment>Param:</comment>
  <info>int</info>  <strong>$percent</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat


id: SolrQuery::setGroupFacet
type: function
doc:
<comment>Description:</comment>
  Sets group.facet parameter
  
  Determines whether to compute grouped facets for the field facets specified in facet.field
  parameters. Grouped facets are computed based on the first specified group.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupFormat
type: function
doc:
<comment>Description:</comment>
  Sets the group format, result structure (group.format parameter)
  
  Sets the group.format parameter. If this parameter is set to simple, the grouped documents are
  presented in a single flat list, and the start and rows parameters affect the numbers of documents
  instead of groups. Accepts: grouped/simple

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupLimit
type: function
doc:
<comment>Description:</comment>
  Specifies the number of results to return for each group. The server default value is 1
  
  Specifies the number of results to return for each group. The server default value is 1.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupMain
type: function
doc:
<comment>Description:</comment>
  If true, the result of the first field grouping command is used as the main result list in the
  response, using group.format=simple
  
  If <info>true</info>, the result of the first field grouping command is used as the main result list in the
  response, using <return>group.format=simple</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  If <info>true</info>, the result of the first field grouping command is used as the main result
                  list in the response.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupNGroups
type: function
doc:
<comment>Description:</comment>
  If true, Solr includes the number of groups that have matched the query in the results
  
  If true, Solr includes the number of groups that have matched the query in the results.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupOffset
type: function
doc:
<comment>Description:</comment>
  Sets the group.offset parameter
  
  Sets the group.offset parameter.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupTruncate
type: function
doc:
<comment>Description:</comment>
  If true, facet counts are based on the most relevant document of each group matching the query
  
  If true, facet counts are based on the most relevant document of each group matching the query.
  The server default value is false. group.truncate parameter

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setHighlight
type: function
doc:
<comment>Description:</comment>
  Enables or disables highlighting
  
  Setting it to <info>true</info> enables highlighted snippets to be generated in the query response.
  
  Setting it to <info>false</info> disables highlighting

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Enable or disable highlighting

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightAlternateField
type: function
doc:
<comment>Description:</comment>
  Specifies the backup field to use
  
  If a snippet cannot be generated because there were no matching terms, one can specify a field to
  use as the backup or default summary

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>           The name of the backup field
  <info>string</info>  <strong>$field_override</strong>  The name of the field we are overriding this setting for.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightFormatter
type: function
doc:
<comment>Description:</comment>
  Specify a formatter for the highlight output
  
  Specify a formatter for the highlight output.

<comment>Param:</comment>
  <info>string</info>  <strong>$formatter</strong>       Currently the only legal value is "simple"
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.


id: SolrQuery::setHighlightFragmenter
type: function
doc:
<comment>Description:</comment>
  Sets a text snippet generator for highlighted text
  
  Specify a text snippet generator for highlighted text.

<comment>Param:</comment>
  <info>string</info>  <strong>$fragmenter</strong>      The standard fragmenter is gap. Another option is regex, which tries to
                           create fragments that resembles a certain regular expression
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightFragsize
type: function
doc:
<comment>Description:</comment>
  The size of fragments to consider for highlighting
  
  Sets the size, in characters, of fragments to consider for highlighting. "0" indicates that the
  whole field value should be used (no fragmenting).

<comment>Param:</comment>
  <info>int</info>     <strong>$size</strong>            The size, in characters, of fragments to consider for highlighting
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightHighlightMultiTerm
type: function
doc:
<comment>Description:</comment>
  Use SpanScorer to highlight phrase terms
  
  Use SpanScorer to highlight phrase terms only when they appear within the query phrase in the
  document.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Whether or not to use SpanScorer to highlight phrase terms only when they appear
               within the query phrase in the document.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightMaxAlternateFieldLength
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of characters of the field to return
  
  If SolrQuery::setHighlightAlternateField() was passed the value <info>true</info>, this parameter specifies the
  maximum number of characters of the field to return
  
  Any value less than or equal to 0 means unlimited.

<comment>Param:</comment>
  <info>int</info>     <strong>$fieldLength</strong>     The length of the field
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Specifies the number of characters into a document to look for suitable snippets
  
  Specifies the number of characters into a document to look for suitable snippets

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The number of characters into a document to look for suitable snippets

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightMergeContiguous
type: function
doc:
<comment>Description:</comment>
  Whether or not to collapse contiguous fragments into a single fragment
  
  Whether or not to collapse contiguous fragments into a single fragment

<comment>Param:</comment>
  <info></info>        <strong>$value</strong>           Whether or not to collapse contiguous fragments into a single fragment
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRegexMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Specify the maximum number of characters to analyze
  
  Specify the maximum number of characters to analyze from a field when using the regex fragmenter

<comment>Param:</comment>
  <info>int</info>  <strong>$maxAnalyzedChars</strong>  The maximum number of characters to analyze from a field when using the
                          regex fragmenter

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRegexPattern
type: function
doc:
<comment>Description:</comment>
  Specify the regular expression for fragmenting
  
  Specifies the regular expression for fragmenting. This could be used to extract sentences

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  The regular expression for fragmenting. This could be used to extract sentences

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRegexSlop
type: function
doc:
<comment>Description:</comment>
  Sets the factor by which the regex fragmenter can stray from the ideal fragment size
  
  The factor by which the regex fragmenter can stray from the ideal fragment size ( specfied by
  SolrQuery::setHighlightFragsize )to accommodate the regular expression

<comment>Param:</comment>
  <info>float</info>  <strong>$factor</strong>  The factor by which the regex fragmenter can stray from the ideal fragment size

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRequireFieldMatch
type: function
doc:
<comment>Description:</comment>
  Require field matching during highlighting
  
  If <info>true</info>, then a field will only be highlighted if the query matched in this particular field.
  
  This will only work if SolrQuery::setHighlightUsePhraseHighlighter() was set to <info>true</info>

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightSimplePost
type: function
doc:
<comment>Description:</comment>
  Sets the text which appears after a highlighted term
  
  Sets the text which appears before a highlighted term

<comment>Param:</comment>
  <info>string</info>  <strong>$simplePost</strong>      Sets the text which appears after a highlighted term
                           
                            ]]>
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.


id: SolrQuery::setHighlightSimplePre
type: function
doc:
<comment>Description:</comment>
  Sets the text which appears before a highlighted term
  
  Sets the text which appears before a highlighted term
  
   ]]>

<comment>Param:</comment>
  <info>string</info>  <strong>$simplePre</strong>       The text which appears before a highlighted term
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightSnippets
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of highlighted snippets to generate per field
  
  Sets the maximum number of highlighted snippets to generate per field

<comment>Param:</comment>
  <info>int</info>     <strong>$value</strong>           The maximum number of highlighted snippets to generate per field
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightUsePhraseHighlighter
type: function
doc:
<comment>Description:</comment>
  Whether to highlight phrase terms only when they appear within the query phrase
  
  Sets whether or not to use SpanScorer to highlight phrase terms only when they appear within the
  query phrase in the document

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  Whether or not to use SpanScorer to highlight phrase terms only when they appear within
            the query phrase in the document

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMlt
type: function
doc:
<comment>Description:</comment>
  Enables or disables moreLikeThis
  
  Enables or disables moreLikeThis

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> enables it and <info>false</info> turns it off.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltBoost
type: function
doc:
<comment>Description:</comment>
  Set if the query will be boosted by the interesting term relevance
  
  Set if the query will be boosted by the interesting term relevance

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  Sets to <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltCount
type: function
doc:
<comment>Description:</comment>
  Set the number of similar documents to return for each result
  
  Set the number of similar documents to return for each result

<comment>Param:</comment>
  <info>int</info>  <strong>$count</strong>  The number of similar documents to return for each result

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMaxNumQueryTerms
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of query terms included
  
  Sets the maximum number of query terms that will be included in any generated query.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The maximum number of query terms that will be included in any generated query

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMaxNumTokens
type: function
doc:
<comment>Description:</comment>
  Specifies the maximum number of tokens to parse
  
  Specifies the maximum number of tokens to parse in each example doc field that is not stored with
  TermVector support.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The maximum number of tokens to parse

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMaxWordLength
type: function
doc:
<comment>Description:</comment>
  Sets the maximum word length
  
  Sets the maximum word length above which words will be ignored.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxWordLength</strong>  The maximum word length above which words will be ignored

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMinDocFrequency
type: function
doc:
<comment>Description:</comment>
  Sets the mltMinDoc frequency
  
  The frequency at which words will be ignored which do not occur in at least this many docs.

<comment>Param:</comment>
  <info>int</info>  <strong>$minDocFrequency</strong>  Sets the frequency at which words will be ignored which do not occur in at
                         least this many docs.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMinTermFrequency
type: function
doc:
<comment>Description:</comment>
  Sets the frequency below which terms will be ignored in the source docs
  
  Sets the frequency below which terms will be ignored in the source docs

<comment>Param:</comment>
  <info>int</info>  <strong>$minTermFrequency</strong>  The frequency below which terms will be ignored in the source docs

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMinWordLength
type: function
doc:
<comment>Description:</comment>
  Sets the minimum word length
  
  Sets the minimum word length below which words will be ignored.

<comment>Param:</comment>
  <info>int</info>  <strong>$minWordLength</strong>  The minimum word length below which words will be ignored

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setOmitHeader
type: function
doc:
<comment>Description:</comment>
  Exclude the header from the returned results
  
  Exclude the header from the returned results.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> excludes the header from the result.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setQuery
type: function
doc:
<comment>Description:</comment>
  Sets the search query
  
  Sets the search query.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The search query

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object


id: SolrQuery::setRows
type: function
doc:
<comment>Description:</comment>
  Specifies the maximum number of rows to return in the result
  
  Specifies the maximum number of rows to return in the result

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of rows to return

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object.


id: SolrQuery::setShowDebugInfo
type: function
doc:
<comment>Description:</comment>
  Flag to show debug information
  
  Whether to show debug info

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Whether to show debug info. <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setStart
type: function
doc:
<comment>Description:</comment>
  Specifies the number of rows to skip
  
  Specifies the number of rows to skip. Useful in pagination of results.

<comment>Param:</comment>
  <info>int</info>  <strong>$start</strong>  The number of rows to skip.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object.


id: SolrQuery::setStats
type: function
doc:
<comment>Description:</comment>
  Enables or disables the Stats component
  
  Enables or disables the Stats component.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> turns on the stats component and <info>false</info> disables it.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTerms
type: function
doc:
<comment>Description:</comment>
  Enables or disables the TermsComponent
  
  Enables or disables the TermsComponent

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> enables it. <info>false</info> turns it off

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsField
type: function
doc:
<comment>Description:</comment>
  Sets the name of the field to get the Terms from
  
  Sets the name of the field to get the terms from

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldname</strong>  The field name

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsIncludeLowerBound
type: function
doc:
<comment>Description:</comment>
  Include the lower bound term in the result set
  
  Include the lower bound term in the result set.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Include the lower bound term in the result set

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsIncludeUpperBound
type: function
doc:
<comment>Description:</comment>
  Include the upper bound term in the result set
  
  Include the upper bound term in the result set.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsLimit
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of terms to return
  
  Sets the maximum number of terms to return

<comment>Param:</comment>
  <info>int</info>  <strong>$limit</strong>  The maximum number of terms to return. All the terms will be returned if the limit is
               negative.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsLowerBound
type: function
doc:
<comment>Description:</comment>
  Specifies the Term to start from
  
  Specifies the Term to start from

<comment>Param:</comment>
  <info>string</info>  <strong>$lowerBound</strong>  The lower bound Term

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsMaxCount
type: function
doc:
<comment>Description:</comment>
  Sets the maximum document frequency
  
  Sets the maximum document frequency.

<comment>Param:</comment>
  <info>int</info>  <strong>$frequency</strong>  The maximum document frequency.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsMinCount
type: function
doc:
<comment>Description:</comment>
  Sets the minimum document frequency
  
  Sets the minimum doc frequency to return in order to be included

<comment>Param:</comment>
  <info>int</info>  <strong>$frequency</strong>  The minimum frequency

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsPrefix
type: function
doc:
<comment>Description:</comment>
  Restrict matches to terms that start with the prefix
  
  Restrict matches to terms that start with the prefix

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  Restrict matches to terms that start with the prefix

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsReturnRaw
type: function
doc:
<comment>Description:</comment>
  Return the raw characters of the indexed term
  
  If true, return the raw characters of the indexed term, regardless of if it is human readable

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsSort
type: function
doc:
<comment>Description:</comment>
  Specifies how to sort the returned terms
  
  If SolrQuery::TERMS_SORT_COUNT, sorts the terms by the term frequency (highest count first). If
  SolrQuery::TERMS_SORT_INDEX, returns the terms in index order

<comment>Param:</comment>
  <info>int</info>  <strong>$sortType</strong>  SolrQuery::TERMS_SORT_INDEX or SolrQuery::TERMS_SORT_COUNT

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsUpperBound
type: function
doc:
<comment>Description:</comment>
  Sets the term to stop at
  
  Sets the term to stop at

<comment>Param:</comment>
  <info>string</info>  <strong>$upperBound</strong>  The term to stop at

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTimeAllowed
type: function
doc:
<comment>Description:</comment>
  The time allowed for search to finish
  
  The time allowed for a search to finish. This value only applies to the search and not to requests
  in general. Time is in milliseconds. Values less than or equal to zero implies no time
  restriction. Partial results may be returned, if there are any.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeAllowed</strong>  The time allowed for a search to finish.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrResponse::getDigestedResponse
type: function
doc:
<comment>Description:</comment>
  Returns the XML response as serialized PHP data
  
  Returns the XML response as serialized PHP data

<comment>Return:</comment>
  <info>string</info>  Returns the XML response as serialized PHP data


id: SolrResponse::getHttpStatus
type: function
doc:
<comment>Description:</comment>
  Returns the HTTP status of the response
  
  Returns the HTTP status of the response.

<comment>Return:</comment>
  <info>int</info>  Returns the HTTP status of the response.


id: SolrResponse::getHttpStatusMessage
type: function
doc:
<comment>Description:</comment>
  Returns more details on the HTTP status
  
  Returns more details on the HTTP status.

<comment>Return:</comment>
  <info>string</info>  Returns more details on the HTTP status


id: SolrResponse::getRawRequest
type: function
doc:
<comment>Description:</comment>
  Returns the raw request sent to the Solr server
  
  Returns the raw request sent to the Solr server.

<comment>Return:</comment>
  <info>string</info>  Returns the raw request sent to the Solr server


id: SolrResponse::getRawRequestHeaders
type: function
doc:
<comment>Description:</comment>
  Returns the raw request headers sent to the Solr server
  
  Returns the raw request headers sent to the Solr server.

<comment>Return:</comment>
  <info>string</info>  Returns the raw request headers sent to the Solr server


id: SolrResponse::getRawResponse
type: function
doc:
<comment>Description:</comment>
  Returns the raw response from the server
  
  Returns the raw response from the server.

<comment>Return:</comment>
  <info>string</info>  Returns the raw response from the server.


id: SolrResponse::getRawResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Returns the raw response headers from the server
  
  Returns the raw response headers from the server.

<comment>Return:</comment>
  <info>string</info>  Returns the raw response headers from the server.


id: SolrResponse::getRequestUrl
type: function
doc:
<comment>Description:</comment>
  Returns the full URL the request was sent to
  
  Returns the full URL the request was sent to.

<comment>Return:</comment>
  <info>string</info>  Returns the full URL the request was sent to


id: SolrResponse::getResponse
type: function
doc:
<comment>Description:</comment>
  Returns a SolrObject representing the XML response from the server
  
  Returns a SolrObject representing the XML response from the server.

<comment>Return:</comment>
  <info>SolrObject</info>  Returns a SolrObject representing the XML response from the server


id: SolrResponse::setParseMode
type: function
doc:
<comment>Description:</comment>
  Sets the parse mode
  
  Sets the parse mode.

<comment>Param:</comment>
  <info>int</info>  <strong>$parser_mode</strong>  SolrResponse::PARSE_SOLR_DOC parses documents in SolrDocument instances.
                     SolrResponse::PARSE_SOLR_OBJ parses document into SolrObjects.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SolrResponse::success
type: function
doc:
<comment>Description:</comment>
  Was the request a success
  
  Used to check if the request to the server was successful.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if it was successful and <info>false</info> if it was not.


id: SolrServerException
type: class
doc:
<comment>Description:</comment>
  An exception thrown when there is an error produced by the Solr Server itself.


id: SolrUtils
type: class
doc:
<comment>Description:</comment>
  Contains utility methods for retrieving the current extension version and preparing query phrases.
  
  Also contains method for escaping query strings and parsing XML responses.


id: SolrUtils::digestXmlResponse
type: function
doc:
<comment>Description:</comment>
  Parses an response XML string into a SolrObject
  
  This method parses an response XML string from the Apache Solr server into a SolrObject. It throws
  a SolrException if there was an error.

<comment>Param:</comment>
  <info>string</info>  <strong>$xmlresponse</strong>  The XML response string from the Solr server.
  <info>int</info>     <strong>$parse_mode</strong>   Use SolrResponse::PARSE_SOLR_OBJ or SolrResponse::PARSE_SOLR_DOC

<comment>Return:</comment>
  <info>SolrObject</info>  Returns the SolrObject representing the XML response.
              
              If the parse_mode parameter is set to SolrResponse::PARSE_SOLR_OBJ Solr documents will
              be parses as SolrObject instances.
              
              If it is set to SolrResponse::PARSE_SOLR_DOC, they will be parsed as SolrDocument
              instances.


id: SolrUtils::escapeQueryChars
type: function
doc:
<comment>Description:</comment>
  Escapes a lucene query string
  
  Lucene supports escaping special characters that are part of the query syntax.
  
  The current list special characters are:
  
  

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  This is the query string to be escaped.

<comment>Return:</comment>
  <info>string|false</info>  Returns the escaped string ou <info>false</info> em caso de falha.


id: SolrUtils::getSolrVersion
type: function
doc:
<comment>Description:</comment>
  Returns the current version of the Solr extension
  
  Returns the current Solr version.

<comment>Return:</comment>
  <info>string</info>  The current version of the Apache Solr extension.


id: SolrUtils::queryPhrase
type: function
doc:
<comment>Description:</comment>
  Prepares a phrase from an unescaped lucene string
  
  Prepares a phrase from an unescaped lucene string.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  The lucene phrase.

<comment>Return:</comment>
  <info>string</info>  Returns the phrase contained in double quotes.


id: SplDoublyLinkedList
type: class
doc:
<comment>Description:</comment>
  The SplDoublyLinkedList class provides the main functionalities of a doubly linked list.


id: SplDoublyLinkedList::IT_MODE_FIFO
type: constant
doc:
<comment>Description:</comment>
  The list will be iterated in a first in, first out order, like a queue.


id: SplDoublyLinkedList::IT_MODE_LIFO
type: constant
doc:
<comment>Description:</comment>
  The list will be iterated in a last in, first out order, like a stack.


id: SplDoublyLinkedList::add
type: function
doc:
<comment>Description:</comment>
  Add/insert a new value at the specified index
  
  Insert the value <strong>$value</strong> at the specified <strong>$index</strong>, shuffling the previous value at that index (and
  all subsequent values) up through the list.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>  The index where the new value is to be inserted.
  <info>mixed</info>  <strong>$value</strong>  The new value for the <strong>$index</strong>.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplDoublyLinkedList::bottom
type: function
doc:
<comment>Description:</comment>
  Peeks at the node from the beginning of the doubly linked list

<comment>Return:</comment>
  <info>mixed</info>  The value of the first node.


id: SplDoublyLinkedList::count
type: function
doc:
<comment>Description:</comment>
  Counts the number of elements in the doubly linked list

<comment>Return:</comment>
  <info>int</info>  Returns the number of elements in the doubly linked list.


id: SplDoublyLinkedList::current
type: function
doc:
<comment>Description:</comment>
  Return current array entry
  
  Get the current doubly linked list node.

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


id: SplDoublyLinkedList::getIteratorMode
type: function
doc:
<comment>Description:</comment>
  Returns the mode of iteration

<comment>Return:</comment>
  <info>int</info>  Returns the different modes and flags that affect the iteration.


id: SplDoublyLinkedList::isEmpty
type: function
doc:
<comment>Description:</comment>
  Checks whether the doubly linked list is empty

<comment>Return:</comment>
  <info>bool</info>  Returns whether the doubly linked list is empty.


id: SplDoublyLinkedList::key
type: function
doc:
<comment>Description:</comment>
  Return current node index
  
  This function returns the current node index

<comment>Return:</comment>
  <info>int</info>  The current node index.


id: SplDoublyLinkedList::next
type: function
doc:
<comment>Description:</comment>
  Move to next entry
  
  Move the iterator to the next node.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplDoublyLinkedList::offsetExists
type: function
doc:
<comment>Description:</comment>
  Returns whether the requested $index exists

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index being checked.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the requested <strong>$index</strong> exists, otherwise <info>false</info>


id: SplDoublyLinkedList::offsetGet
type: function
doc:
<comment>Description:</comment>
  Returns the value at the specified $index

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index with the value.

<comment>Return:</comment>
  <info>mixed</info>  The value at the specified <strong>$index</strong>.


id: SplDoublyLinkedList::offsetSet
type: function
doc:
<comment>Description:</comment>
  Sets the value at the specified $index to $value
  
  Sets the value at the specified <strong>$index</strong> to <strong>$value</strong>.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$index</strong>  The index being set. If <info>null</info>, the next value will be added after the last item.
  <info>mixed</info>     <strong>$value</strong>  The new value for the <strong>$index</strong>.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplDoublyLinkedList::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Unsets the value at the specified $index
  
  Unsets the value at the specified index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index being unset.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplDoublyLinkedList::pop
type: function
doc:
<comment>Description:</comment>
  Pops a node from the end of the doubly linked list

<comment>Return:</comment>
  <info>mixed</info>  The value of the popped node.


id: SplDoublyLinkedList::prev
type: function
doc:
<comment>Description:</comment>
  Move to previous entry
  
  Move the iterator to the previous node.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplDoublyLinkedList::push
type: function
doc:
<comment>Description:</comment>
  Pushes an element at the end of the doubly linked list
  
  Pushes <strong>$value</strong> at the end of the doubly linked list.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The value to push.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplDoublyLinkedList::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind iterator back to the start
  
  This rewinds the iterator to the beginning.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplDoublyLinkedList::serialize
type: function
doc:
<comment>Description:</comment>
  Serializes the storage
  
  Serializes the storage.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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

<comment>See Also:</comment>
   * SplDoublyLinkedList::unserialize


id: SplDoublyLinkedList::setIteratorMode
type: function
doc:
<comment>Description:</comment>
  Sets the mode of iteration

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  There are two orthogonal sets of modes that can be set:
              
              The direction of the iteration (either one or the other):
              
              <info>SplDoublyLinkedList::IT_MODE_LIFO</info> (Stack style)
              
              <info>SplDoublyLinkedList::IT_MODE_FIFO</info> (Queue style)
              
              The behavior of the iterator (either one or the other):
              
              <info>SplDoublyLinkedList::IT_MODE_DELETE</info> (Elements are deleted by the iterator)
              
              <info>SplDoublyLinkedList::IT_MODE_KEEP</info> (Elements are traversed by the iterator)
              
              The default mode is: <info>SplDoublyLinkedList::IT_MODE_FIFO</info> |
              <info>SplDoublyLinkedList::IT_MODE_KEEP</info>
              
              The direction of iteration can not be changed for <class>SplStack</class> and <class>SplQueue</class> classes, it is
              always <info>SplDoublyLinkedList::IT_MODE_FIFO</info>. Trying to modify it will result in a
              <class>RuntimeException</class> being thrown.

<comment>Return:</comment>
  <info>int</info>  Returns the different modes and flags that affect the iteration.


id: SplDoublyLinkedList::shift
type: function
doc:
<comment>Description:</comment>
  Shifts a node from the beginning of the doubly linked list

<comment>Return:</comment>
  <info>mixed</info>  The value of the shifted node.


id: SplDoublyLinkedList::top
type: function
doc:
<comment>Description:</comment>
  Peeks at the node from the end of the doubly linked list

<comment>Return:</comment>
  <info>mixed</info>  The value of the last node.


id: SplDoublyLinkedList::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserializes the storage
  
  Unserializes the storage, from SplDoublyLinkedList::serialize.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized string.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplDoublyLinkedList::serialize


id: SplDoublyLinkedList::unshift
type: function
doc:
<comment>Description:</comment>
  Prepends the doubly linked list with an element
  
  Prepends <strong>$value</strong> at the beginning of the doubly linked list.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The value to unshift.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplDoublyLinkedList::valid
type: function
doc:
<comment>Description:</comment>
  Check whether the doubly linked list contains more nodes
  
  Checks if the doubly linked list contains any more nodes.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the doubly linked list contains any more nodes, <info>false</info> otherwise.


id: SplFileInfo
type: class
doc:
<comment>Description:</comment>
  The SplFileInfo class offers a high-level object-oriented interface to information for an
  individual file.


id: SplFileInfo::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new SplFileInfo object
  
  Creates a new SplFileInfo object for the file_name specified. The file does not need to exist, or
  be readable.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Path to the file.


id: SplFileInfo::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the path to the file as a string
  
  This method will return the file name of the referenced file.

<comment>Return:</comment>
  <info>string</info>  Returns the path to the file.


id: SplFileInfo::getATime
type: function
doc:
<comment>Description:</comment>
  Gets last access time of the file
  
  Gets the last access time for the file.

<comment>Return:</comment>
  <info>int|false</info>  Returns the time the file was last accessed on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>fileatime()</strong>
   * SplFileInfo::getCTime
   * SplFileInfo::getMTime


id: SplFileInfo::getBasename
type: function
doc:
<comment>Description:</comment>
  Gets the base name of the file
  
  This method returns the base name of the file, directory, or link without path info.
  
  <strong>SplFileInfo::getBasename()</strong> is locale aware, so for it to see the  correct basename with multibyte
  character paths, the matching locale must  be set using the <strong>setlocale()</strong> function.

<comment>Param:</comment>
  <info>string</info>  <strong>$suffix</strong>  Optional suffix to omit from the base name returned.

<comment>Return:</comment>
  <info>string</info>  Returns the base name without path information.

<comment>See Also:</comment>
   * SplFileInfo::getFilename


id: SplFileInfo::getCTime
type: function
doc:
<comment>Description:</comment>
  Gets the inode change time
  
  Returns the inode change time for the file. The time returned is a Unix timestamp.

<comment>Return:</comment>
  <info>int|false</info>  The last change time, in a Unix timestamp on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>filectime()</strong>
   * SplFileInfo::getATime
   * SplFileInfo::getMTime


id: SplFileInfo::getExtension
type: function
doc:
<comment>Description:</comment>
  Gets the file extension
  
  Retrieves the file extension.

<comment>Return:</comment>
  <info>string</info>  Returns a <info>string</info> containing the file extension, or an empty <info>string</info> if the file has no
          extension.

<comment>See Also:</comment>
   * SplFileInfo::getFilename
   * SplFileInfo::getBasename
   * <strong>pathinfo()</strong>


id: SplFileInfo::getFileInfo
type: function
doc:
<comment>Description:</comment>
  Gets an SplFileInfo object for the file
  
  This method gets an <class>SplFileInfo</class> object for the referenced file.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$class</strong>  Name of an <class>SplFileInfo</class> derived class to use.

<comment>Return:</comment>
  <info>SplFileInfo</info>  An <class>SplFileInfo</class> object created for the file.

<comment>See Also:</comment>
   * SplFileInfo::setInfoClass


id: SplFileInfo::getFilename
type: function
doc:
<comment>Description:</comment>
  Gets the filename
  
  Gets the filename without any path information.

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

<comment>See Also:</comment>
   * SplFileInfo::getBasename


id: SplFileInfo::getGroup
type: function
doc:
<comment>Description:</comment>
  Gets the file group
  
  Gets the file group. The group ID is returned in numerical format.

<comment>Return:</comment>
  <info>int|false</info>  The group id in numerical format on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>filegroup()</strong>
   * <strong>posix_getgrgid()</strong>


id: SplFileInfo::getInode
type: function
doc:
<comment>Description:</comment>
  Gets the inode for the file
  
  Gets the inode number for the filesystem object.

<comment>Return:</comment>
  <info>int|false</info>  Returns the inode number for the filesystem object on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>fileinode()</strong>


id: SplFileInfo::getLinkTarget
type: function
doc:
<comment>Description:</comment>
  Gets the target of a link
  
  Gets the target of a filesystem link.
  
  The target may not be the real path on the filesystem. Use SplFileInfo::getRealPath to determine
  the true path on the filesystem.

<comment>Return:</comment>
  <info>string|false</info>  Returns the target of the filesystem link on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * SplFileInfo::isLink
   * SplFileInfo::getRealPath


id: SplFileInfo::getMTime
type: function
doc:
<comment>Description:</comment>
  Gets the last modified time
  
  Returns the time when the contents of the file were changed. The time returned is a Unix
  timestamp.

<comment>Return:</comment>
  <info>int|false</info>  Returns the last modified time for the file, in a Unix timestamp on success, or <info>false</info>
             on failure.

<comment>See Also:</comment>
   * <strong>filemtime()</strong>
   * SplFileInfo::getATime
   * SplFileInfo::getCTime


id: SplFileInfo::getOwner
type: function
doc:
<comment>Description:</comment>
  Gets the owner of the file
  
  Gets the file owner. The owner ID is returned in numerical format.

<comment>Return:</comment>
  <info>int|false</info>  The owner id in numerical format on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * SplFileInfo::getGroup


id: SplFileInfo::getPath
type: function
doc:
<comment>Description:</comment>
  Gets the path without filename
  
  Returns the path to the file, omitting the filename and any trailing slash.

<comment>Return:</comment>
  <info>string</info>  Returns the path to the file.

<comment>See Also:</comment>
   * SplFileInfo::getRealPath
   * SplFileInfo::getFilename
   * SplFileInfo::getPathInfo


id: SplFileInfo::getPathInfo
type: function
doc:
<comment>Description:</comment>
  Gets an SplFileInfo object for the path
  
  Gets an <class>SplFileInfo</class> object for the parent of the current file.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$class</strong>  Name of an <class>SplFileInfo</class> derived class to use, or itself if <info>null</info>.

<comment>Return:</comment>
  <info>SplFileInfo|null</info>  Returns an <class>SplFileInfo</class> object for the parent path of the file on success, or
                    <info>null</info> on failure.

<comment>See Also:</comment>
   * SplFileInfo::setInfoClass


id: SplFileInfo::getPathname
type: function
doc:
<comment>Description:</comment>
  Gets the path to the file
  
  Returns the path to the file.

<comment>Return:</comment>
  <info>string</info>  The path to the file.

<comment>See Also:</comment>
   * SplFileInfo::getRealPath


id: SplFileInfo::getPerms
type: function
doc:
<comment>Description:</comment>
  Gets file permissions
  
  Gets the file permissions for the file.

<comment>Return:</comment>
  <info>int|false</info>  Returns the file permissions on success, or <info>false</info> on failure.


id: SplFileInfo::getRealPath
type: function
doc:
<comment>Description:</comment>
  Gets absolute path to file
  
  This method expands all symbolic links, resolves relative references and returns the real path to
  the file.

<comment>Return:</comment>
  <info>string|false</info>  Returns the path to the file, or <info>false</info> if the file does not exist.

<comment>See Also:</comment>
   * SplFileInfo::isLink
   * realpath


id: SplFileInfo::getSize
type: function
doc:
<comment>Description:</comment>
  Gets file size
  
  Returns the filesize in bytes for the file referenced.

<comment>Return:</comment>
  <info>int|false</info>  The filesize in bytes on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>filesize()</strong>


id: SplFileInfo::getType
type: function
doc:
<comment>Description:</comment>
  Gets file type
  
  Returns the type of the file referenced.

<comment>Return:</comment>
  <info>string|false</info>  A <info>string</info> representing the type of the entry. May be one of <return>file</return>, <return>link</return>, <return>dir</return>, <return>block</return>,
                <return>fifo</return>, <return>char</return>, <return>socket</return>, or <return>unknown</return>, or <info>false</info> on failure.


id: SplFileInfo::isDir
type: function
doc:
<comment>Description:</comment>
  Tells if the file is a directory
  
  This method can be used to determine if the file is a directory.

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


id: SplFileInfo::isExecutable
type: function
doc:
<comment>Description:</comment>
  Tells if the file is executable
  
  Checks if the file is executable.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if executable, <info>false</info> otherwise.


id: SplFileInfo::isFile
type: function
doc:
<comment>Description:</comment>
  Tells if the object references a regular file
  
  Checks if the file referenced by this SplFileInfo object exists and is a regular file.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the file exists and is a regular file (not a link), <info>false</info> otherwise.


id: SplFileInfo::isLink
type: function
doc:
<comment>Description:</comment>
  Tells if the file is a link
  
  Use this method to check if the file referenced by the SplFileInfo object is a link.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the file is a link, <info>false</info> otherwise.

<comment>See Also:</comment>
   * SplFileInfo::getRealPath


id: SplFileInfo::isReadable
type: function
doc:
<comment>Description:</comment>
  Tells if file is readable
  
  Check if the file is readable.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if readable, <info>false</info> otherwise.


id: SplFileInfo::isWritable
type: function
doc:
<comment>Description:</comment>
  Tells if the entry is writable
  
  Checks if the current entry is writable.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if writable, <info>false</info> otherwise;


id: SplFileInfo::openFile
type: function
doc:
<comment>Description:</comment>
  Gets an SplFileObject object for the file
  
  Creates an <class>SplFileObject</class> <info>object</info> of the file. This is useful because <class>SplFileObject</class> contains
  additional methods for manipulating the file whereas <class>SplFileInfo</class> is only useful for gaining
  information, like whether the file is writable.

<comment>Param:</comment>
  <info>string</info>         <strong>$mode</strong>            The mode for opening the file. See the <strong>fopen()</strong> documentation for
                                  descriptions of possible modes. The default  is read only.
  <info>bool</info>           <strong>$useIncludePath</strong>  Quando definido como <info>true</info>, o nome do arquivo também
                                  é procurado no include_path
  <info>resource|null</info>  <strong>$context</strong>         Consulte a seção do manual sobre contexto
                                  para uma descrição dos <return>contextos</return>.

<comment>Return:</comment>
  <info>SplFileObject</info>  The opened file as an <class>SplFileObject</class> <info>object</info>.

<comment>See Also:</comment>
   * <class>SplFileObject</class>
   * <strong>stream_context_create()</strong>
   * <strong>fopen()</strong>


id: SplFileInfo::setFileClass
type: function
doc:
<comment>Description:</comment>
  Sets the class used with SplFileInfo::openFile
  
  Use this method to set a custom class which will be used when SplFileInfo::openFile is called. The
  class name passed to this method must be <class>SplFileObject</class> or a class derived from <class>SplFileObject</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  The class name to use when SplFileInfo::openFile is called.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplFileInfo::openFile


id: SplFileInfo::setInfoClass
type: function
doc:
<comment>Description:</comment>
  Sets the class used with SplFileInfo::getFileInfo and SplFileInfo::getPathInfo
  
  Use this method to set a custom class which will be used when SplFileInfo::getFileInfo and
  SplFileInfo::getPathInfo are called. The class name passed to this method must be <class>SplFileInfo</class> or a
  class derived from <class>SplFileInfo</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  The class name to use when SplFileInfo::getFileInfo and SplFileInfo::getPathInfo
                  are called.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplFileInfo::getFileInfo


id: SplFileObject
type: class
doc:
<comment>Description:</comment>
  The SplFileObject class offers an object-oriented interface for a file.


id: SplFileObject::SKIP_EMPTY
type: constant
doc:
<comment>Description:</comment>
  Skips empty lines in the file. This requires the <info>READ_AHEAD</info> flag be enabled, to work as expected.


id: SplFileObject::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new file object
  
  Construct a new file object.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>        The file to read.
                                  
                                  Uma URL pode ser usada como um
                                  nome de arquivo com esta função se os wrappers fopen estiverem
                                  habilitados.
                                  Consulte a função <strong>fopen()</strong> para mais detalhes sobre como
                                  especificar
                                  o nome do arquivo. Consulte os  para obter links para informações
                                  sobre as capacidades de cada wrapper, notas de uso
                                  e informações sobre quaisquer variáveis predefinidas que eles
                                  possam
                                  fornecer.
  <info>string</info>         <strong>$mode</strong>            The mode in which to open the file. See <strong>fopen()</strong> for a list of
                                  allowed modes.
  <info>bool</info>           <strong>$useIncludePath</strong>  Whether to search in the include_path for <strong>$filename</strong>.
  <info>resource|null</info>  <strong>$context</strong>         A valid context resource created with <strong>stream_context_create()</strong>.

<comment>See Also:</comment>
   * SplFileInfo::openFile
   * <strong>fopen()</strong>


id: SplFileObject::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the current line as a string
  
  This method will return the current line as a string.

<comment>Return:</comment>
  <info>string</info>  Returns the current line as a string.


id: SplFileObject::current
type: function
doc:
<comment>Description:</comment>
  Retrieve current line of file
  
  Retrieves the current line of the file.

<comment>Return:</comment>
  <info>string|array|false</info>  Retrieves the current line of the file. If the <info>SplFileObject::READ_CSV</info> flag is
                      set, this method returns an array containing the current line parsed as CSV
                      data. If the end of the file is reached, <info>false</info> is returned.

<comment>See Also:</comment>
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::eof
type: function
doc:
<comment>Description:</comment>
  Reached end of file
  
  Determine whether the end of file has been reached

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if file is at EOF, <info>false</info> otherwise.

<comment>See Also:</comment>
   * SplFileObject::valid
   * <strong>feof()</strong>


id: SplFileObject::fflush
type: function
doc:
<comment>Description:</comment>
  Flushes the output to the file
  
  Forces a write of all buffered output to the file.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * SplFileObject::fwrite


id: SplFileObject::fgetc
type: function
doc:
<comment>Description:</comment>
  Gets character from file
  
  Gets a character from the file.

<comment>Return:</comment>
  <info>string|false</info>  Returns a string containing a single character read from the file or <info>false</info> on EOF.
                
                Esta função pode
                retornar o valor booleano <info>false</info>, mas também pode retornar um valor não booleano que
                pode ser
                avaliado como <info>false</info>. Leia a seção sobre Booleanos para mais
                informações. Use o operador
                === para testar o valor retornado por esta
                função.

<comment>See Also:</comment>
   * SplFileObject::fgets


id: SplFileObject::fgetcsv
type: function
doc:
<comment>Description:</comment>
  Gets line from file and parse as CSV fields
  
  Gets a line from the file which is in CSV format and returns an array containing the fields read.
  
  The locale settings are taken into account by this function. If <return>LC_CTYPE</return> is e.g. <return>en_US.UTF-8</return>,
  files in one-byte encodings may be read wrongly by this function.

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  The field delimiter (one single-byte character only). Defaults as a comma or
                      the value set using SplFileObject::setCsvControl.
  <info>string</info>  <strong>$enclosure</strong>  The field enclosure character (one single-byte character only). Defaults as a
                      double quotation mark or the value set using SplFileObject::setCsvControl.
  <info>string</info>  <strong>$escape</strong>     The escape character (at most one single-byte character). Defaults as a
                      backslash (<return>\</return>) or the value set using SplFileObject::setCsvControl. An empty
                      string (<return>""</return>) disables the proprietary escape mechanism.
                      
                      Usually an <strong>$enclosure</strong> character is escaped inside a field by doubling it;
                      however, the <strong>$escape</strong> character can be used as an alternative. So for the
                      default parameter values <return>""</return> and <return>\"</return> have the same meaning. Other than allowing
                      to escape the <strong>$enclosure</strong> character the <strong>$escape</strong> character has no special
                      meaning; it isn't even meant to escape itself.

<comment>Return:</comment>
  <info>array|false</info>  Returns an indexed array containing the fields read, or <info>false</info> on error.
               
               A blank line in a CSV file will be returned as an array comprising a single <info>null</info>
               field unless using <info>SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE</info>,  in
               which case empty lines are skipped.

<comment>See Also:</comment>
   * SplFileObject::setCsvControl
   * SplFileObject::setFlags
   * SplFileObject::READ_CSV
   * SplFileObject::current


id: SplFileObject::fgets
type: function
doc:
<comment>Description:</comment>
  Gets line from file
  
  Gets a line from the file.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the next line from the file.

<comment>See Also:</comment>
   * <strong>fgets()</strong>
   * SplFileObject::fgetss
   * SplFileObject::fgetc
   * SplFileObject::current


id: SplFileObject::fgetss
type: function
doc:
<comment>Description:</comment>
  Gets line from file and strip HTML tags
  
  Identical to SplFileObject::fgets, except that SplFileObject::fgetss attempts to strip any HTML
  and PHP tags from the text it reads. The function retains the parsing state from call to call, and
  as such is not equivalent to calling <strong>strip_tags()</strong> on the return value of SplFileObject::fgets.

<comment>Param:</comment>
  <info>string</info>  <strong>$allowable_tags</strong>  Optional parameter to specify tags which should not be stripped.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the next line of the file with HTML and PHP code stripped, or
          <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fgetss()</strong>
   * SplFileObject::fgets
   * SplFileObject::fgetc
   * SplFileObject::current
   * The string.strip_tags filter


id: SplFileObject::flock
type: function
doc:
<comment>Description:</comment>
  Portable file locking
  
  Locks or unlocks the file in the same portable way as <strong>flock()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$operation</strong>   <strong>$operation</strong> is one of the following: <info>LOCK_SH</info> to acquire a shared lock (reader).
                    <info>LOCK_EX</info> to acquire an exclusive lock (writer). <info>LOCK_UN</info> to release a lock (shared
                    or exclusive).
                    
                    <info>LOCK_SH</info> to acquire a shared lock (reader).
                    
                    <info>LOCK_EX</info> to acquire an exclusive lock (writer).
                    
                    <info>LOCK_UN</info> to release a lock (shared or exclusive).
                    
                    It is also possible to add <info>LOCK_NB</info> as a bitmask to one  of the above operations,
                    if <strong>flock()</strong> should not block during the locking attempt.
  <info>int</info>  <strong>$wouldBlock</strong>  Set to <info>true</info> if the lock would block (EWOULDBLOCK errno condition).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>flock()</strong>


id: SplFileObject::fpassthru
type: function
doc:
<comment>Description:</comment>
  Output all remaining data on a file pointer
  
  Reads to EOF on the given file pointer from the current position and writes the results to the
  output buffer.
  
  You may need to call SplFileObject::rewind to reset the file pointer to the beginning of the file
  if you have already written data to the file.

<comment>Return:</comment>
  <info>int</info>  Returns the number of characters read from <strong>$handle</strong> and passed through to the output.

<comment>See Also:</comment>
   * <strong>fpassthru()</strong>


id: SplFileObject::fputcsv
type: function
doc:
<comment>Description:</comment>
  Write a field array as a CSV line
  
  Writes the <strong>$fields</strong> array to the file as a CSV line.

<comment>Param:</comment>
  <info>array</info>   <strong>$fields</strong>     An array of values.
  <info>string</info>  <strong>$separator</strong>  The optional <strong>$separator</strong> parameter sets the field delimiter (one single-byte
                      character only).
  <info>string</info>  <strong>$enclosure</strong>  The optional <strong>$enclosure</strong> parameter sets the field enclosure (one single-byte
                      character only).
  <info>string</info>  <strong>$escape</strong>     The optional <strong>$escape</strong> parameter sets the escape character (at most one
                      single-byte character). An empty string (<return>""</return>) disables the proprietary escape
                      mechanism.
  <info>string</info>  <strong>$eol</strong>        The optional <strong>$eol</strong> parameter sets a custom End of Line sequence.

<comment>Return:</comment>
  <info>int|false</info>  Returns the length of the written string ou <info>false</info> em caso de falha.
             
             Returns <info>false</info>, and does not write the CSV line to the file, if the <strong>$separator</strong> or
             <strong>$enclosure</strong> parameter is not a single character.

<comment>See Also:</comment>
   * <strong>fputcsv()</strong>
   * SplFileObject::fgetcsv


id: SplFileObject::fread
type: function
doc:
<comment>Description:</comment>
  Read from file
  
  Reads the given number of bytes from the file.

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  The number of bytes to read.

<comment>Return:</comment>
  <info>string|false</info>  Returns the string read from the file  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>fread()</strong>


id: SplFileObject::fscanf
type: function
doc:
<comment>Description:</comment>
  Parses input from file according to a format
  
  Reads a line from the file and interprets it according to the specified <strong>$format</strong>.
  
  Any whitespace in the <strong>$format</strong> string matches any whitespace in the line from the file. This means
  that even a tab (<return>\t</return>) in the format string can match a single space character in the input stream.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  O formato interpretado para <strong>$string</strong>, que é descrito na documentação para
                   <strong>sprintf()</strong> com as seguintes diferenças:  A função não reconhece a localidade. <return>F</return>,
                   <return>g</return>, <return>G</return> e <return>b</return> não são suportados. <return>D</return> significa número decimal. <return>i</return> significa inteiro com
                   detecção de base. <return>n</return> representa o número de caracteres processados até o momento.
                   <return>s</return> pára de ler em qualquer caractere de espaço em branco. <return>*</return> em vez de <return>argnum$</return>
                   suprime a atribuição desta especificação de conversão.
  <info>mixed</info>   <strong>$vars</strong>    The optional assigned values.

<comment>Return:</comment>
  <info>array|int|null</info>  If only one parameter is passed to this method, the values parsed will be returned
                  as an array. Otherwise, if optional parameters are passed, the function will
                  return the number of assigned values. The optional parameters must be passed by
                  reference.

<comment>See Also:</comment>
   * <strong>fscanf()</strong>
   * <strong>sscanf()</strong>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>


id: SplFileObject::fseek
type: function
doc:
<comment>Description:</comment>
  Seek to a position
  
  Seek to a position in the file measured in bytes from the beginning of the file, obtained by
  adding <strong>$offset</strong> to the position specified by <strong>$whence</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The offset. A negative value can be used to move backwards through the file which is
                useful when SEEK_END is used as the <strong>$whence</strong> value.
  <info>int</info>  <strong>$whence</strong>  <strong>$whence</strong> values are: <info>SEEK_SET</info> - Set position equal to <strong>$offset</strong> bytes.<info>SEEK_CUR</info> - Set
                position to current location plus <strong>$offset</strong>.<info>SEEK_END</info> - Set position to end-of-file
                plus <strong>$offset</strong>.
                
                If <strong>$whence</strong> is not specified, it is assumed to be <info>SEEK_SET</info>.

<comment>Return:</comment>
  <info>int</info>  Returns 0 if the seek was successful, -1 otherwise. Note that seeking past EOF is not
       considered an error.

<comment>See Also:</comment>
   * <strong>fseek()</strong>


id: SplFileObject::fstat
type: function
doc:
<comment>Description:</comment>
  Gets information about the file
  
  Gathers the statistics of the file. Behaves identically to <strong>fstat()</strong>.

<comment>Return:</comment>
  <info>array</info>  Returns an array with the statistics of the file; the format of the array is described in
         detail on the <strong>stat()</strong> manual page.

<comment>See Also:</comment>
   * <strong>fstat()</strong>
   * <strong>stat()</strong>


id: SplFileObject::ftell
type: function
doc:
<comment>Description:</comment>
  Return current file position
  
  Returns the position of the file pointer which represents the current offset in the file stream.

<comment>Return:</comment>
  <info>int|false</info>  Returns the position of the file pointer as an integer, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>ftell()</strong>


id: SplFileObject::ftruncate
type: function
doc:
<comment>Description:</comment>
  Truncates the file to a given length
  
  Truncates the file to <strong>$size</strong> bytes.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The size to truncate to.
              
              If <strong>$size</strong> is larger than the file it is extended with null bytes.
              
              If <strong>$size</strong> is smaller than the file, the extra data will be lost.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ftruncate()</strong>


id: SplFileObject::fwrite
type: function
doc:
<comment>Description:</comment>
  Write to file
  
  Writes the contents of <strong>$string</strong> to the file

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    The string to be written to the file.
  <info>int</info>     <strong>$length</strong>  If the <strong>$length</strong> argument is given, writing will stop after <strong>$length</strong> bytes have been
                   written or the end of <strong>$string</strong> is reached, whichever comes first.

<comment>Return:</comment>
  <info>int|false</info>  Returns the number of bytes written, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fwrite()</strong>


id: SplFileObject::getChildren
type: function
doc:
<comment>Description:</comment>
  No purpose
  
  An <class>SplFileObject</class> does not have children so this method returns <info>null</info>.

<comment>Return:</comment>
  <info>null</info>  Returns <info>null</info>.

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


id: SplFileObject::getCsvControl
type: function
doc:
<comment>Description:</comment>
  Get the delimiter, enclosure and escape character for CSV
  
  Gets the delimiter, enclosure and escape character used for parsing CSV fields.

<comment>Return:</comment>
  <info>array</info>  Returns an indexed array containing the delimiter, enclosure and escape character.

<comment>See Also:</comment>
   * SplFileObject::setCsvControl
   * SplFileObject::fgetcsv


id: SplFileObject::getCurrentLine
type: function
doc:
<comment>Description:</comment>
  Sinônimo de SplFileObject::fgets
  
  Este método é um apelido para:  SplFileObject::fgets.


id: SplFileObject::getFlags
type: function
doc:
<comment>Description:</comment>
  Gets flags for the SplFileObject
  
  Gets the flags set for an instance of SplFileObject as an <info>int</info>.

<comment>Return:</comment>
  <info>int</info>  Returns an <info>int</info> representing the flags.

<comment>See Also:</comment>
   * SplFileObject::setFlags


id: SplFileObject::getMaxLineLen
type: function
doc:
<comment>Description:</comment>
  Get maximum line length
  
  Gets the maximum line length as set by SplFileObject::setMaxLineLen.

<comment>Return:</comment>
  <info>int</info>  Returns the maximum line length if one has been set with SplFileObject::setMaxLineLen,
       default is <return>0</return>.

<comment>See Also:</comment>
   * SplFileObject::setMaxLineLen


id: SplFileObject::hasChildren
type: function
doc:
<comment>Description:</comment>
  SplFileObject does not have children
  
  An <class>SplFileObject</class> does not have children so this method always return <info>false</info>.

<comment>Return:</comment>
  <info>false</info>  Returns <info>false</info>

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


id: SplFileObject::key
type: function
doc:
<comment>Description:</comment>
  Get line number
  
  Gets the current line number.
  
  This number may not reflect the actual line number in the file  if SplFileObject::setMaxLineLen is
  used to  read fixed lengths of the file.

<comment>Return:</comment>
  <info>int</info>  Returns the current line number.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::next
type: function
doc:
<comment>Description:</comment>
  Read next line
  
  Moves ahead to the next line in the file.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the file to the first line
  
  Rewinds the file back to the first line.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::valid


id: SplFileObject::seek
type: function
doc:
<comment>Description:</comment>
  Seek to specified line
  
  Seek to specified line in the file.

<comment>Param:</comment>
  <info>int</info>  <strong>$line</strong>  The zero-based line number to seek to.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::setCsvControl
type: function
doc:
<comment>Description:</comment>
  Set the delimiter, enclosure and escape character for CSV
  
  Sets the delimiter, enclosure and escape character for parsing CSV fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  The field delimiter (one single-byte character only).
  <info>string</info>  <strong>$enclosure</strong>  The field enclosure character (one single-byte character only).
  <info>string</info>  <strong>$escape</strong>     The field escape character (at most one single-byte character). An empty
                      string (<return>""</return>) disables the proprietary escape mechanism.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplFileObject::getCsvControl
   * SplFileObject::fgetcsv


id: SplFileObject::setFlags
type: function
doc:
<comment>Description:</comment>
  Sets flags for the SplFileObject
  
  Sets the flags to be used by the <class>SplFileObject</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Bit mask of the flags to set. See  SplFileObject constants  for the available flags.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplFileObject::getFlags


id: SplFileObject::setMaxLineLen
type: function
doc:
<comment>Description:</comment>
  Set maximum line length
  
  Sets the maximum length of a line to be read.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxLength</strong>  The maximum length of a line.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplFileObject::getMaxLineLen


id: SplFileObject::valid
type: function
doc:
<comment>Description:</comment>
  Not at EOF
  
  Check whether EOF has been reached.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if not reached EOF, <info>false</info> otherwise.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind


id: SplFixedArray
type: class
doc:
<comment>Description:</comment>
  The SplFixedArray class provides the main functionalities of array. The  main difference between a
  SplFixedArray and a normal PHP array is that  the SplFixedArray must be resized manually and
  allows only integers within  the range as indexes. The advantage is that it uses less memory than
  a standard <info>array</info>.


id: SplFixedArray::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new fixed array
  
  Initializes a fixed array with a number of <info>null</info> values equal to <strong>$size</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The size of the fixed array.  This expects a number between <return>0</return> and <info>PHP_INT_MAX</info>.


id: SplFixedArray::__serialize
type: function
doc:
<comment>Description:</comment>
  Serializes the SplFixedArray object
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>array</info>  Nenhum valor é retornado.


id: SplFixedArray::__unserialize
type: function
doc:
<comment>Description:</comment>
  Deserializes the data parameter into an SplFixedArray object
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  The value being deserialized.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplFixedArray::__wakeup
type: function
doc:
<comment>Description:</comment>
  Reinitialises the array after being unserialised
  
  Reinitialises the array after being unserialised.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplFixedArray::count
type: function
doc:
<comment>Description:</comment>
  Returns the size of the array
  
  Returns the size of the array.

<comment>Return:</comment>
  <info>int</info>  Returns the size of the array.

<comment>See Also:</comment>
   * SplFixedArray::getSize


id: SplFixedArray::current
type: function
doc:
<comment>Description:</comment>
  Return current array entry
  
  Get the current array element.

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


id: SplFixedArray::fromArray
type: function
doc:
<comment>Description:</comment>
  Import a PHP array in a SplFixedArray instance
  
  Import the PHP array <strong>$array</strong>  in a new <class>SplFixedArray</class> instance

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>         The array to import.
  <info>bool</info>   <strong>$preserveKeys</strong>  Try to save the numeric indexes used in the original array.

<comment>Return:</comment>
  <info>SplFixedArray</info>  Returns an instance of <class>SplFixedArray</class>  containing the array content.


id: SplFixedArray::getIterator
type: function
doc:
<comment>Description:</comment>
  Retrieve the iterator to go through the array
  
  Returns the iterator to go through the array.

<comment>Return:</comment>
  <info>Iterator</info>  An instance of an object implementing <class>Iterator</class> to go through the array.


id: SplFixedArray::getSize
type: function
doc:
<comment>Description:</comment>
  Gets the size of the array
  
  Gets the size of the array.

<comment>Return:</comment>
  <info>int</info>  Returns the size of the array, as an <info>int</info>.

<comment>See Also:</comment>
   * SplFixedArray::count


id: SplFixedArray::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON
  
  Serializes the array to a value that can be serialized natively by <strong>json_encode()</strong>.

<comment>Return:</comment>
  <info>mixed</info>  Returns array data which can be serialized by <strong>json_encode()</strong>, which is a value of any type
         other than a resource.


id: SplFixedArray::key
type: function
doc:
<comment>Description:</comment>
  Return current array index
  
  Returns the current array index.

<comment>Return:</comment>
  <info>int</info>  The current array index.


id: SplFixedArray::next
type: function
doc:
<comment>Description:</comment>
  Move to next entry
  
  Move the iterator to the next array entry.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplFixedArray::offsetExists
type: function
doc:
<comment>Description:</comment>
  Returns whether the requested index exists
  
  Checks whether the requested index <strong>$index</strong>  exists.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index being checked.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the requested <strong>$index</strong> exists, otherwise <info>false</info>


id: SplFixedArray::offsetGet
type: function
doc:
<comment>Description:</comment>
  Returns the value at the specified index
  
  Returns the value at the index <strong>$index</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index with the value.

<comment>Return:</comment>
  <info>mixed</info>  The value at the specified <strong>$index</strong>.


id: SplFixedArray::offsetSet
type: function
doc:
<comment>Description:</comment>
  Sets a new value at a specified index
  
  Sets the value at the specified <strong>$index</strong> to <strong>$value</strong>.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>  The index being set.
  <info>mixed</info>  <strong>$value</strong>  The new value for the <strong>$index</strong>.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplFixedArray::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind iterator back to the start
  
  Rewinds the iterator to the beginning.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplFixedArray::setSize
type: function
doc:
<comment>Description:</comment>
  Change the size of an array
  
  Change the size of an array to the new size of <strong>$size</strong>. If  <strong>$size</strong> is less than the current array
  size, any values after the new size  will be discarded. If <strong>$size</strong> is greater than the current array
  size, the  array will be padded with <info>null</info> values.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The new array size. This should be a value between <return>0</return> and <info>PHP_INT_MAX</info>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: SplFixedArray::toArray
type: function
doc:
<comment>Description:</comment>
  Returns a PHP array from the fixed array
  
  Returns a PHP array from the fixed array.

<comment>Return:</comment>
  <info>array</info>  Returns a PHP <info>array</info>, similar to the fixed array.


id: SplFixedArray::valid
type: function
doc:
<comment>Description:</comment>
  Check whether the array contains more elements
  
  Checks if the array contains any more elements.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the array contains any more elements, <info>false</info> otherwise.


id: SplHeap::compare
type: function
doc:
<comment>Description:</comment>
  Compare elements in order to place them correctly in the heap while sifting up
  
  Compare <strong>$value1</strong> with <strong>$value2</strong>.
  
  Throwing exceptions in SplHeap::compare can corrupt the Heap and place it in a blocked state. You
  can unblock it by calling SplHeap::recoverFromCorruption.  However, some elements might not be
  placed correctly and it may hence break the heap-property.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  The value of the first node being compared.
  <info>mixed</info>  <strong>$value2</strong>  The value of the second node being compared.

<comment>Return:</comment>
  <info>int</info>  Result of the comparison, positive integer if <strong>$value1</strong> is greater than <strong>$value2</strong>, 0 if they are
       equal, negative integer otherwise.
       
       Having multiple elements with the same value in a Heap is not recommended. They will end up
       in an arbitrary relative position.


id: SplHeap::count
type: function
doc:
<comment>Description:</comment>
  Counts the number of elements in the heap

<comment>Return:</comment>
  <info>int</info>  Returns the number of elements in the heap.


id: SplHeap::current
type: function
doc:
<comment>Description:</comment>
  Return current node pointed by the iterator
  
  Get the current datastructure node.

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


id: SplHeap::extract
type: function
doc:
<comment>Description:</comment>
  Extracts a node from top of the heap and sift up

<comment>Return:</comment>
  <info>mixed</info>  The value of the extracted node.


id: SplHeap::insert
type: function
doc:
<comment>Description:</comment>
  Inserts an element in the heap by sifting it up
  
  Insert <strong>$value</strong> in the heap.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The value to insert.

<comment>Return:</comment>
  <info>true</info>  Sempre retorna <info>true</info>.


id: SplHeap::isCorrupted
type: function
doc:
<comment>Description:</comment>
  Tells if the heap is in a corrupted state

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


id: SplHeap::isEmpty
type: function
doc:
<comment>Description:</comment>
  Checks whether the heap is empty

<comment>Return:</comment>
  <info>bool</info>  Returns whether the heap is empty.


id: SplHeap::next
type: function
doc:
<comment>Description:</comment>
  Move to the next node
  
  Move to the next node. This will delete the top node of the heap.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplHeap::recoverFromCorruption
type: function
doc:
<comment>Description:</comment>
  Recover from the corrupted state and allow further actions on the heap

<comment>Return:</comment>
  <info>bool</info>  Always returns <info>true</info>.


id: SplHeap::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind iterator back to the start (no-op)
  
  This rewinds the iterator to the beginning. This is a no-op for heaps as the iterator is virtual
  and in fact never moves from the top of the  heap.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplHeap::top
type: function
doc:
<comment>Description:</comment>
  Peeks at the node from the top of the heap

<comment>Return:</comment>
  <info>mixed</info>  The value of the node on the top.


id: SplHeap::valid
type: function
doc:
<comment>Description:</comment>
  Check whether the heap contains more nodes
  
  Checks if the heap contains any more nodes.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the heap contains any more nodes, <info>false</info> otherwise.


id: SplMaxHeap
type: class
doc:
<comment>Description:</comment>
  The SplMaxHeap class provides the main functionalities of a heap, keeping the maximum on the top.


id: SplMaxHeap::compare
type: function
doc:
<comment>Description:</comment>
  Compare elements in order to place them correctly in the heap while sifting up
  
  Compare <strong>$value1</strong> with <strong>$value2</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  The value of the first node being compared.
  <info>mixed</info>  <strong>$value2</strong>  The value of the second node being compared.

<comment>Return:</comment>
  <info>int</info>  Result of the comparison, positive integer if <strong>$value1</strong> is greater than <strong>$value2</strong>, 0 if they are
       equal, negative integer otherwise.
       
       Having multiple elements with the same value in a Heap is not recommended. They will end up
       in an arbitrary relative position.


id: SplMinHeap
type: class
doc:
<comment>Description:</comment>
  The SplMinHeap class provides the main functionalities of a heap, keeping the minimum on the top.


id: SplMinHeap::compare
type: function
doc:
<comment>Description:</comment>
  Compare elements in order to place them correctly in the heap while sifting up
  
  Compare <strong>$value1</strong> with <strong>$value2</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  The value of the first node being compared.
  <info>mixed</info>  <strong>$value2</strong>  The value of the second node being compared.

<comment>Return:</comment>
  <info>int</info>  Result of the comparison, positive integer if <strong>$value1</strong> is lower than <strong>$value2</strong>, 0 if they are
       equal, negative integer otherwise.
       
       Having multiple elements with the same value in a Heap is not recommended. They will end up
       in an arbitrary relative position.


id: SplObjectStorage
type: class
doc:
<comment>Description:</comment>
  The SplObjectStorage class provides a map from objects to data or, by ignoring data, an object
  set. This dual purpose can be useful in many cases involving the need to uniquely identify
  objects.


id: SplObjectStorage::addAll
type: function
doc:
<comment>Description:</comment>
  Adds all objects from another storage
  
  Adds all objects-data pairs from a different storage in the current storage.

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  The storage you want to import.

<comment>Return:</comment>
  <info>int</info>  The number of objects in the storage.

<comment>See Also:</comment>
   * SplObjectStorage::removeAll


id: SplObjectStorage::attach
type: function
doc:
<comment>Description:</comment>
  Adds an object in the storage
  
  Adds an <info>object</info> inside the storage, and optionally associate it to some data.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The <info>object</info> to add.
  <info>mixed</info>   <strong>$info</strong>    The data to associate with the <info>object</info>.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplObjectStorage::detach
   * SplObjectStorage::offsetSet


id: SplObjectStorage::contains
type: function
doc:
<comment>Description:</comment>
  Checks if the storage contains a specific object
  
  Checks if the storage contains the <info>object</info> provided.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The <info>object</info> to look for.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the <info>object</info> is in the storage, <info>false</info> otherwise.

<comment>See Also:</comment>
   * SplObjectStorage::offsetExists


id: SplObjectStorage::count
type: function
doc:
<comment>Description:</comment>
  Returns the number of objects in the storage
  
  Counts the number of objects in the storage.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  If the optional <strong>$mode</strong> parameter is set to <info>COUNT_RECURSIVE</info> (or 1),
              <strong>SplObjectStorage::count()</strong> will recursively count the storage.

<comment>Return:</comment>
  <info>int</info>  The number of objects in the storage.

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::detach


id: SplObjectStorage::current
type: function
doc:
<comment>Description:</comment>
  Returns the current storage entry
  
  Returns the current storage entry.

<comment>Return:</comment>
  <info>object</info>  The <info>object</info> at the current iterator position.

<comment>See Also:</comment>
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::getInfo


id: SplObjectStorage::detach
type: function
doc:
<comment>Description:</comment>
  Removes an object from the storage
  
  Removes the <info>object</info> from the storage.

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

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::removeAll


id: SplObjectStorage::getHash
type: function
doc:
<comment>Description:</comment>
  Calculate a unique identifier for the contained objects
    
  
  This method calculates an identifier for the objects added to an <class>SplObjectStorage</class> object.
  
  The implementation in <class>SplObjectStorage</class> returns the same value as <strong>spl_object_hash()</strong>.
  
  The storage object will never contain more than one object with the same identifier. As such, it
  can be used to implement a set (a collection of unique values) where the quality of an object
  being unique is determined by the value returned by this function being unique.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The object whose identifier is to be calculated.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> with the calculated identifier.

<comment>See Also:</comment>
   * <strong>spl_object_hash()</strong>


id: SplObjectStorage::getInfo
type: function
doc:
<comment>Description:</comment>
  Returns the data associated with the current iterator entry
  
  Returns the data, or info, associated with the object pointed by the current iterator position.

<comment>Return:</comment>
  <info>mixed</info>  The data associated with the current iterator position.

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::setInfo


id: SplObjectStorage::key
type: function
doc:
<comment>Description:</comment>
  Returns the index at which the iterator currently is
  
  Returns the index at which the iterator currently is.

<comment>Return:</comment>
  <info>int</info>  The index corresponding to the position of the iterator.

<comment>See Also:</comment>
   * SplObjectStorage::rewind
   * SplObjectStorage::current
   * SplObjectStorage::next
   * SplObjectStorage::valid


id: SplObjectStorage::next
type: function
doc:
<comment>Description:</comment>
  Move to the next entry
  
  Moves the iterator to the next <info>object</info> in the storage.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SPLObjectStorage::rewind


id: SplObjectStorage::offsetExists
type: function
doc:
<comment>Description:</comment>
  Checks whether an object exists in the storage
  
  Checks whether an <info>object</info> exists in the storage.
  
  SplObjectStorage::offsetExists is an alias of SplObjectStorage::contains.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The <info>object</info> to look for.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the <info>object</info> exists in the storage, and <info>false</info> otherwise.

<comment>See Also:</comment>
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetGet
type: function
doc:
<comment>Description:</comment>
  Returns the data associated with an object
  
  Returns the data associated with an <info>object</info> in the storage.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The <info>object</info> to look for.

<comment>Return:</comment>
  <info>mixed</info>  The data previously associated with the <info>object</info> in the storage.

<comment>See Also:</comment>
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetExists
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetSet
type: function
doc:
<comment>Description:</comment>
  Associates data to an object in the storage
  
  Associate data to an <info>object</info> in the storage.
  
  SplObjectStorage::offsetSet is an alias of SplObjectStorage::attach.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The <info>object</info> to associate data with.
  <info>mixed</info>   <strong>$info</strong>    The data to associate with the <info>object</info>.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetExists
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Removes an object from the storage
  
  Removes an <info>object</info> from the storage.
  
  SplObjectStorage::offsetUnset is an alias of SplObjectStorage::detach.

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

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetExists


id: SplObjectStorage::removeAll
type: function
doc:
<comment>Description:</comment>
  Removes objects contained in another storage from the current storage
  
  Removes objects contained in another storage from the current storage.

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  The storage containing the elements to remove.

<comment>Return:</comment>
  <info>int</info>  Returns the number of remaining objects.

<comment>See Also:</comment>
   * SplObjectStorage::addAll


id: SplObjectStorage::removeAllExcept
type: function
doc:
<comment>Description:</comment>
  Removes all objects except for those contained in another storage from the current storage
  
  Removes all objects except for those contained in another storage from the current storage.

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  The storage containing the elements to retain in the current storage.

<comment>Return:</comment>
  <info>int</info>  Returns the number of remaining objects.


id: SplObjectStorage::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the iterator to the first storage element
  
  Rewind the iterator to the first storage element.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplObjectStorage::next


id: SplObjectStorage::serialize
type: function
doc:
<comment>Description:</comment>
  Serializes the storage
  
  Returns a string representation of the storage.

<comment>Return:</comment>
  <info>string</info>  A string representing the storage.

<comment>See Also:</comment>
   * SplObjectStorage::unserialize


id: SplObjectStorage::setInfo
type: function
doc:
<comment>Description:</comment>
  Sets the data associated with the current iterator entry
  
  Associates data, or info, with the object currently pointed to by the iterator.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$info</strong>  The data to associate with the current iterator entry.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::getInfo


id: SplObjectStorage::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserializes a storage from its string representation
  
  Unserializes storage entries and attach them to the current storage.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized representation of a storage.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * SplObjectStorage::serialize


id: SplObjectStorage::valid
type: function
doc:
<comment>Description:</comment>
  Returns if the current iterator entry is valid
  
  Returns if the current iterator entry is valid.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the iterator entry is valid, <info>false</info> otherwise.

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::getInfo


id: SplObserver
type: class
doc:
<comment>Description:</comment>
  The <class>SplObserver</class> interface is used alongside <class>SplSubject</class> to implement the Observer Design Pattern.


id: SplObserver::update
type: function
doc:
<comment>Description:</comment>
  Receive update from subject
  
  This method is called when any <class>SplSubject</class> to which the observer is attached calls
  SplSubject::notify.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>SplSubject</info>  <strong>$subject</strong>  The <class>SplSubject</class> notifying the observer of an update.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplPriorityQueue
type: class
doc:
<comment>Description:</comment>
  The SplPriorityQueue class provides the main functionalities of a  prioritized queue, implemented
  using a max heap.
  
  The order of elements with identical priority is undefined. It may differ from the order in which
  they have been inserted.


id: SplPriorityQueue::compare
type: function
doc:
<comment>Description:</comment>
  Compare priorities in order to place elements correctly in the heap while sifting up
  
  Compare <strong>$priority1</strong> with <strong>$priority2</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$priority1</strong>  The priority of the first node being compared.
  <info>mixed</info>  <strong>$priority2</strong>  The priority of the second node being compared.

<comment>Return:</comment>
  <info>int</info>  Result of the comparison, positive integer if <strong>$priority1</strong> is greater than <strong>$priority2</strong>, 0 if
       they are equal, negative integer otherwise.
       
       Multiple elements with the same priority will get dequeued in no particular order.


id: SplPriorityQueue::count
type: function
doc:
<comment>Description:</comment>
  Counts the number of elements in the queue

<comment>Return:</comment>
  <info>int</info>  Returns the number of elements in the queue.


id: SplPriorityQueue::current
type: function
doc:
<comment>Description:</comment>
  Return current node pointed by the iterator
  
  Get the current datastructure node.

<comment>Return:</comment>
  <info>mixed</info>  The value or priority (or both) of the current node, depending on the extract flag.


id: SplPriorityQueue::extract
type: function
doc:
<comment>Description:</comment>
  Extracts a node from top of the heap and sift up

<comment>Return:</comment>
  <info>mixed</info>  The value or priority (or both) of the extracted node, depending on the extract flag.


id: SplPriorityQueue::getExtractFlags
type: function
doc:
<comment>Description:</comment>
  Get the flags of extraction
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  Returns the flags of extraction.


id: SplPriorityQueue::insert
type: function
doc:
<comment>Description:</comment>
  Inserts an element in the queue by sifting it up
  
  Insert <strong>$value</strong> with the priority <strong>$priority</strong> in the queue.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>     The value to insert.
  <info>mixed</info>  <strong>$priority</strong>  The associated priority.

<comment>Return:</comment>
  <info>true</info>  Sempre retorna <info>true</info>.


id: SplPriorityQueue::isCorrupted
type: function
doc:
<comment>Description:</comment>
  Tells if the priority queue is in a corrupted state

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the priority queue is corrupted, <info>false</info> otherwise.


id: SplPriorityQueue::isEmpty
type: function
doc:
<comment>Description:</comment>
  Checks whether the queue is empty

<comment>Return:</comment>
  <info>bool</info>  Returns whether the queue is empty.


id: SplPriorityQueue::next
type: function
doc:
<comment>Description:</comment>
  Move to the next node
  
  Extracts the top node from the queue.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplPriorityQueue::recoverFromCorruption
type: function
doc:
<comment>Description:</comment>
  Recover from the corrupted state and allow further actions on the queue

<comment>Return:</comment>
  <info>bool</info>  Always returns <info>true</info>.


id: SplPriorityQueue::setExtractFlags
type: function
doc:
<comment>Description:</comment>
  Sets the mode of extraction

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Defines what is extracted by SplPriorityQueue::current, SplPriorityQueue::top and
               SplPriorityQueue::extract.
               
               <info>SplPriorityQueue::EXTR_DATA</info> (0x00000001): Extract the data
               
               <info>SplPriorityQueue::EXTR_PRIORITY</info> (0x00000002): Extract the priority
               
               <info>SplPriorityQueue::EXTR_BOTH</info> (0x00000003): Extract an array containing both
               
               The default mode is <info>SplPriorityQueue::EXTR_DATA</info>.

<comment>Return:</comment>
  <info>int</info>  Returns the flags of extraction.


id: SplPriorityQueue::top
type: function
doc:
<comment>Description:</comment>
  Peeks at the node from the top of the queue

<comment>Return:</comment>
  <info>mixed</info>  The value or priority (or both) of the top node, depending on the extract flag.


id: SplPriorityQueue::valid
type: function
doc:
<comment>Description:</comment>
  Check whether the queue contains more nodes
  
  Checks if the queue contains any more nodes.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the queue contains any more nodes, <info>false</info> otherwise.


id: SplQueue
type: class
doc:
<comment>Description:</comment>
  The SplQueue class provides the main functionalities of a queue implemented using a doubly linked
  list by setting the iterator mode to <info>SplDoublyLinkedList::IT_MODE_FIFO</info>.


id: SplQueue::dequeue
type: function
doc:
<comment>Description:</comment>
  Dequeues a node from the queue
  
  Dequeues <strong>$value</strong> from the top of the queue.
  
  SplQueue::dequeue is an alias of SplDoublyLinkedList::shift.

<comment>Return:</comment>
  <info>mixed</info>  The value of the dequeued node.


id: SplQueue::enqueue
type: function
doc:
<comment>Description:</comment>
  Adds an element to the queue
  
  Enqueues <strong>$value</strong> at the end of the queue.
  
  SplQueue::enqueue is an alias of SplDoublyLinkedList::push.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The value to enqueue.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplStack
type: class
doc:
<comment>Description:</comment>
  The SplStack class provides the main functionalities of a stack implemented using a doubly linked
  list by setting the iterator mode to <info>SplDoublyLinkedList::IT_MODE_LIFO</info>.


id: SplSubject
type: class
doc:
<comment>Description:</comment>
  The <class>SplSubject</class> interface is used alongside <class>SplObserver</class> to implement the Observer Design Pattern.


id: SplSubject::attach
type: function
doc:
<comment>Description:</comment>
  Attach an SplObserver
  
  Attaches an <class>SplObserver</class> so that it can be notified of updates.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>SplObserver</info>  <strong>$observer</strong>  The <class>SplObserver</class> to attach.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplSubject::detach
type: function
doc:
<comment>Description:</comment>
  Detach an observer
  
  Detaches an observer from the subject to no longer notify it of updates.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>SplObserver</info>  <strong>$observer</strong>  The <class>SplObserver</class> to detach.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplSubject::notify
type: function
doc:
<comment>Description:</comment>
  Notify an observer
  
  Notifies all attached observers.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SplTempFileObject
type: class
doc:
<comment>Description:</comment>
  The SplTempFileObject class offers an object-oriented interface for a temporary file.


id: SplTempFileObject::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new temporary file object
  
  Construct a new temporary file object.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxMemory</strong>  The maximum amount of memory (in bytes, default is 2 MB) for  the temporary file
                   to use. If the temporary file exceeds this  size, it will be moved to a file in
                   the system's temp directory.
                   
                   If <strong>$maxMemory</strong> is negative, only memory will be used. If <strong>$maxMemory</strong> is zero,  no
                   memory will be used.

<comment>See Also:</comment>
   * <class>SplFileObject</class>
   * PHP input/output streams 
     (for <return>php://temp</return> and <return>php://memory</return>)
    


id: Spoofchecker
type: class
doc:
<comment>Description:</comment>
  This class is provided because Unicode contains large number of characters and incorporates the
  varied writing systems of the world and their incorrect usage can expose programs or systems to
  possible security attacks using characters similarity.
  
  Provided methods allow to check whether an individual string is likely an attempt at confusing the
  reader (<return>spoof detection</return>), such as  "pаypаl" spelled with Cyrillic 'а' characters.


id: Spoofchecker::areConfusable
type: function
doc:
<comment>Description:</comment>
  Checks if given strings can be confused
  
  Checks whether two given strings can easily be mistaken.

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>    First string to check.
  <info>string</info>  <strong>$string2</strong>    Second string to check.
  <info>int</info>     <strong>$errorCode</strong>  This variable is set by-reference to <info>int</info> containing an error, if there was
                      any.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if two given strings can be confused, <info>false</info> otherwise.


id: Spoofchecker::isSuspicious
type: function
doc:
<comment>Description:</comment>
  Checks if a given text contains any suspicious characters
  
  Checks if given string contains any suspicious characters like letters which are almost identical
  visually, but are Unicode characters from different sets.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>     String to test.
  <info>int</info>     <strong>$errorCode</strong>  This variable is set by-reference to <info>int</info> containing an error, if there was
                      any.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if there are suspicious characters, <info>false</info> otherwise.


id: Spoofchecker::setAllowedLocales
type: function
doc:
<comment>Description:</comment>
  Locales to use when running checks
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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

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


id: Spoofchecker::setChecks
type: function
doc:
<comment>Description:</comment>
  Set the checks to run
  
  Sets the checks that will be performed by SpoofChecker::isSuspicious.

<comment>Param:</comment>
  <info>int</info>  <strong>$checks</strong>  The checks that will be performed by SpoofChecker::isSuspicious. A bitmask of
                <info>Spoofchecker::SINGLE_SCRIPT_CONFUSABLE</info>, <info>Spoofchecker::MIXED_SCRIPT_CONFUSABLE</info>,
                <info>Spoofchecker::WHOLE_SCRIPT_CONFUSABLE</info>, <info>Spoofchecker::ANY_CASE</info>,
                <info>Spoofchecker::SINGLE_SCRIPT</info>, <info>Spoofchecker::INVISIBLE</info>, or <info>Spoofchecker::CHAR_LIMIT</info>.
                Defaults to all checks as of ICU 58; prior to that version,
                <info>Spoofchecker::SINGLE_SCRIPT</info> was excluded.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: Spoofchecker::setRestrictionLevel
type: function
doc:
<comment>Description:</comment>
  Set the restriction level
  
  Sets the restriction level of SpoofChecker::isSuspicious.

<comment>Param:</comment>
  <info>int</info>  <strong>$level</strong>  The restriction level of SpoofChecker::isSuspicious. One of <info>Spoofchecker::ASCII</info>,
               <info>Spoofchecker::SINGLE_SCRIPT_RESTRICTIVE</info>, <info>Spoofchecker::HIGHLY_RESTRICTIVE</info>,
               <info>Spoofchecker::MODERATELY_RESTRICTIVE</info>, <info>Spoofchecker::MINIMALLY_RESTRICTIVE</info>, or
               <info>Spoofchecker::UNRESTRICTIVE</info>. Defaults to <info>Spoofchecker::HIGHLY_RESTRICTIVE</info>.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: SqlStatement::__construct
type: function
doc:
<comment>Description:</comment>
  Description constructor
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.


id: SqlStatement::bind
type: function
doc:
<comment>Description:</comment>
  Bind statement parameters
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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

<comment>Return:</comment>
  <info>mysql_xdevapi\SqlStatement</info>  


id: SqlStatement::execute
type: function
doc:
<comment>Description:</comment>
  Execute the operation
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


id: SqlStatement::getNextResult
type: function
doc:
<comment>Description:</comment>
  Get next result
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


id: SqlStatement::getResult
type: function
doc:
<comment>Description:</comment>
  Get result
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


id: SqlStatement::hasMoreResults
type: function
doc:
<comment>Description:</comment>
  Check for more results
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the result set has more objects to fetch.


id: SqlStatementResult::fetchAll
type: function
doc:
<comment>Description:</comment>
  Get all rows from result
  
  Fetch all the rows from the result set.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<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: SqlStatementResult::fetchOne
type: function
doc:
<comment>Description:</comment>
  Get single row
  
  Fetch one row from the result set.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>array</info>  The result, as an associative array. In case there is not any result, null will be
         returned.


id: SqlStatementResult::getAffectedItemsCount
type: function
doc:
<comment>Description:</comment>
  Get affected row count
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  


id: SqlStatementResult::getColumnNames
type: function
doc:
<comment>Description:</comment>
  Get column names
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>array</info>  


id: SqlStatementResult::getColumns
type: function
doc:
<comment>Description:</comment>
  Get columns
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>Array</info>  


id: SqlStatementResult::getColumnsCount
type: function
doc:
<comment>Description:</comment>
  Get column count
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  The number of columns; 0 if there are none.


id: SqlStatementResult::getGeneratedIds
type: function
doc:
<comment>Description:</comment>
  Get generated ids
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<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: SqlStatementResult::getLastInsertId
type: function
doc:
<comment>Description:</comment>
  Get last insert id
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>String</info>  The ID for the last insert operation.


id: SqlStatementResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  Get warnings from last operation
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<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: SqlStatementResult::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  Get warning count from last operation
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  The number of warnings raised during the last CRUD operation.


id: SqlStatementResult::hasData
type: function
doc:
<comment>Description:</comment>
  Check if result has data
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the result set has data.


id: SqlStatementResult::nextResult
type: function
doc:
<comment>Description:</comment>
  Get next result
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  The next Result object from the result set.


id: Statement::hasMoreResults
type: function
doc:
<comment>Description:</comment>
  Check if more results
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>bool</info>  


id: Stomp
type: class
doc:
<comment>Description:</comment>
  Represents a connection between PHP and a Stomp compliant Message Broker.


id: Stomp::__construct
type: function
doc:
<comment>Description:</comment>
  Opens a connection
  
  Estilo orientado a objetos (constructor):
  
  Estilo procedural:
  
  Opens a connection to a stomp compliant Message Broker.

<comment>Param:</comment>
  <info>string</info>  <strong>$broker</strong>    The broker URI
  <info>string</info>  <strong>$username</strong>  The username.
  <info>string</info>  <strong>$password</strong>  The password.
  <info>array</info>   <strong>$headers</strong>   Um array associativo contendo os cabeçalhos adicionais (exemplo: receipt).

<comment>Return:</comment>
  <info>resource</info>  Um cabeçalho de transação pode ser especificado, indicando que a confirmação da mensagem
            deve fazer parte da transação nomeada.


id: Stomp::__destruct
type: function
doc:
<comment>Description:</comment>
  Closes stomp connection
  
  Estilo orientado a objetos (destructor):
  
  Estilo procedural:
  
  Closes a previously opened connection.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Somente no estilo procedural: O identificador do link stomp retornado por
                   <strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Stomp::abort
type: function
doc:
<comment>Description:</comment>
  Rolls back a transaction in progress
  
  Estilo orientado a objetos (method):
  
  Estilo procedural:
  
  Rolls back a transaction in progress.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            Somente no estilo procedural: O identificador do link stomp retornado
                             por <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$transaction_id</strong>  The transaction to abort.
  <info>array</info>     <strong>$headers</strong>         Um array associativo contendo os cabeçalhos adicionais (exemplo:
                             receipt).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Stomp::ack
type: function
doc:
<comment>Description:</comment>
  Acknowledges consumption of a message
  
  Estilo orientado a objetos (method):
  
  Estilo procedural:
  
  Acknowledges consumption of a message from a subscription using client acknowledgment.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>     Somente no estilo procedural: O identificador do link stomp retornado por
                      <strong>stomp_connect()</strong>.
  <info>mixed</info>     <strong>$msg</strong>      The message/messageId to be acknowledged.
  <info>array</info>     <strong>$headers</strong>  Um array associativo contendo os cabeçalhos adicionais (exemplo: receipt).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Stomp::begin
type: function
doc:
<comment>Description:</comment>
  Starts a transaction
  
  Estilo orientado a objetos (method):
  
  Estilo procedural:
  
  Starts a transaction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            Somente no estilo procedural: O identificador do link stomp retornado
                             por <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$transaction_id</strong>  The transaction id.
  <info>array</info>     <strong>$headers</strong>         Um array associativo contendo os cabeçalhos adicionais (exemplo:
                             receipt).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Stomp::commit
type: function
doc:
<comment>Description:</comment>
  Commits a transaction in progress
  
  Estilo orientado a objetos (method):
  
  Estilo procedural:
  
  Commits a transaction in progress.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            Somente no estilo procedural: O identificador do link stomp retornado
                             por <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$transaction_id</strong>  The transaction id.
  <info>array</info>     <strong>$headers</strong>         Um array associativo contendo os cabeçalhos adicionais (exemplo:
                             receipt).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Stomp::error
type: function
doc:
<comment>Description:</comment>
  Gets the last stomp error
  
  Estilo orientado a objetos (method):
  
  Estilo procedural:
  
  Gets the last stomp error.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Somente no estilo procedural: O identificador do link stomp retornado por
                   <strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>string</info>  Returns an error string or <info>false</info> if no error occurred.


id: Stomp::getReadTimeout
type: function
doc:
<comment>Description:</comment>
  Gets read timeout
  
  Estilo orientado a objetos (method):
  
  Estilo procedural:
  
  Gets read timeout

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Somente no estilo procedural: O identificador do link stomp retornado por
                   <strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>array</info>  Returns an array with 2 elements: sec and usec.


id: Stomp::getSessionId
type: function
doc:
<comment>Description:</comment>
  Gets the current stomp session ID
  
  Estilo orientado a objetos (method):
  
  Estilo procedural:
  
  Gets the current stomp session ID.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Somente no estilo procedural: O identificador do link stomp retornado por
                   <strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>string|false</info>  <info>string</info> session id on success ou <info>false</info> em caso de falha.


id: Stomp::hasFrame
type: function
doc:
<comment>Description:</comment>
  Indicates whether or not there is a frame ready to read
  
  Estilo orientado a objetos (method):
  
  Estilo procedural:
  
  Indicates whether or not there is a frame ready to read.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Somente no estilo procedural: O identificador do link stomp retornado por
                   <strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if a frame is ready to read, or <info>false</info> otherwise.


id: Stomp::readFrame
type: function
doc:
<comment>Description:</comment>
  Reads the next frame
  
  Estilo orientado a objetos (method):
  
  Estilo procedural:
  
  Reads the next frame. It is possible to instantiate an object of a specific class, and pass
  parameters to that class's constructor.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>        Somente no estilo procedural: O identificador do link stomp retornado por
                         <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$class_name</strong>  The name of the class to instantiate. If not specified, a stompFrame object
                         is returned.

<comment>Return:</comment>
  <info>stompframe</info>  Um cabeçalho de transação pode ser especificado, indicando que a confirmação da
              mensagem deve fazer parte da transação nomeada.


id: Stomp::send
type: function
doc:
<comment>Description:</comment>
  Sends a message
  
  Estilo orientado a objetos (method):
  
  Estilo procedural:
  
  Sends a message to the Message Broker.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         Somente no estilo procedural: O identificador do link stomp retornado por
                          <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$destination</strong>  Where to send the message
  <info>mixed</info>     <strong>$msg</strong>          Message to send.
  <info>array</info>     <strong>$headers</strong>      Um array associativo contendo os cabeçalhos adicionais (exemplo: receipt).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Stomp::setReadTimeout
type: function
doc:
<comment>Description:</comment>
  Sets read timeout
  
  Estilo orientado a objetos (method):
  
  Estilo procedural:
  
  Sets read timeout.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>          Somente no estilo procedural: O identificador do link stomp retornado por
                           <strong>stomp_connect()</strong>.
  <info>int</info>       <strong>$seconds</strong>       The seconds part of the timeout to be set.
  <info>int</info>       <strong>$microseconds</strong>  The microseconds part of the timeout to be set.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: Stomp::subscribe
type: function
doc:
<comment>Description:</comment>
  Registers to listen to a given destination
  
  Estilo orientado a objetos (method):
  
  Estilo procedural:
  
  Registers to listen to a given destination.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         Somente no estilo procedural: O identificador do link stomp retornado por
                          <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$destination</strong>  Destination to subscribe to.
  <info>array</info>     <strong>$headers</strong>      Um array associativo contendo os cabeçalhos adicionais (exemplo: receipt).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Stomp::unsubscribe
type: function
doc:
<comment>Description:</comment>
  Removes an existing subscription
  
  Estilo orientado a objetos (method):
  
  Estilo procedural:
  
  Removes an existing subscription.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         Somente no estilo procedural: O identificador do link stomp retornado por
                          <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$destination</strong>  Subscription to remove.
  <info>array</info>     <strong>$headers</strong>      Um array associativo contendo os cabeçalhos adicionais (exemplo: receipt).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: StompException
type: class
doc:
<comment>Description:</comment>
  Represents an error raised by the stomp extension. See Exceptions for more information about
  Exceptions in PHP.


id: StompException::getDetails
type: function
doc:
<comment>Description:</comment>
  Get exception details
  
  Get exception details.

<comment>Return:</comment>
  <info>string</info>  <info>string</info> containing the error details.


id: StompFrame
type: class
doc:
<comment>Description:</comment>
  Represents a message which was sent or received from a Stomp compliant Message Broker.


id: StompFrame::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Constructor.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  Frame command
  <info>array</info>   <strong>$headers</strong>  Frame headers (<info>array</info>).
  <info>string</info>  <strong>$body</strong>     Frame body.


id: Stringable
type: class
doc:
<comment>Description:</comment>
  A interface Stringable denota uma classe que tenha um método __toString(). Diferentemente da
  maioria das interfaces, Stringable está implicitamente presente em qualquer classe que possua o
  método mágico __toString() definido, embora ela possa e deveria ser declarada explicitamente.
  
  Seu principal valor é permitir que funções façam verificações de tipo em uniões <return>string|Stringable</return>
  para aceitar tanto uma string primitiva quanto um objeto que possa ser convertido para uma string.


id: Stringable::__toString
type: function
doc:
<comment>Description:</comment>
  Obtém a representação em string do objeto

<comment>Return:</comment>
  <info>string</info>  Retorna a representação em <info>string</info> do objeto.

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


id: Superglobais
type: function
doc:
<comment>Description:</comment>
  Variáveis nativas que estão sempre disponíveis em todos escopos
  
  Várias variáveis pré-definidas no PHP são "superglobais", que significa que elas estão disponíveis
  em todos os escopos para todo o script. Não há necessidade de fazer global $variable; para
  acessá-lo dentro de funções ou métodos.
  
  Estas variáveis superglobais são:
  $GLOBALS$_SERVER$_GET$_POST$_FILES$_COOKIE$_SESSION$_REQUEST$_ENV

<comment>See Also:</comment>
   * escopo de variável
   * A diretiva variables_order
   * A extensão filter


id: Swoole\Async::dnsLookup
type: function
doc:
<comment>Description:</comment>
  Async and non-blocking hostname to IP lookup.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>    <strong>$hostname</strong>  The host name.
  <info>callable</info>  <strong>$callback</strong>  The host name.
                       
                       The IP address.
  <info>string</info>    <strong>$hostname</strong>  The host name.
  <info></info>          <strong>$IP</strong>        The IP address.

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


id: Swoole\Async::read
type: function
doc:
<comment>Description:</comment>
  Read file stream asynchronously.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>    The name of the file.
  <info>callable</info>  <strong>$callback</strong>    The name of the file.
                         
                         The content readed from the file stream.
  <info>string</info>    <strong>$filename</strong>    The name of the file.
  <info>string</info>    <strong>$content</strong>     The content readed from the file stream.
  <info>int</info>       <strong>$chunk_size</strong>  The chunk length.
  <info>int</info>       <strong>$offset</strong>      The offset.

<comment>Return:</comment>
  <info>bool</info>  Whether the read is succeed.


id: Swoole\Async::readFile
type: function
doc:
<comment>Description:</comment>
  Read a file asynchronously.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  The filename of the file being read.
  <info>callable</info>  <strong>$callback</strong>  The name of the file.
                       
                       The content readed from the file.
  <info>string</info>    <strong>$filename</strong>  The name of the file.
  <info>string</info>    <strong>$content</strong>   The content readed from the file.

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


id: Swoole\Async::set
type: function
doc:
<comment>Description:</comment>
  Update the async I/O options.

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  

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


id: Swoole\Async::write
type: function
doc:
<comment>Description:</comment>
  Write data to a file stream asynchronously.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  The filename being written.
  <info>string</info>    <strong>$content</strong>   The content writing to the file.
  <info>int</info>       <strong>$offset</strong>    The offset.
  <info>callable</info>  <strong>$callback</strong>  

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


id: Swoole\Async::writeFile
type: function
doc:
<comment>Description:</comment>
  Description
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  The filename being written.
  <info>string</info>    <strong>$content</strong>   The content writing to the file.
  <info>callable</info>  <strong>$callback</strong>  
  <info>string</info>    <strong>$flags</strong>     

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


id: Swoole\Atomic::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a swoole atomic object.
  
  Swoole atomic object is a integer variable allows any processor to atomically test and modify.  It
  is implemented based on CPU atomic instructions. The Swoole atomic variables have to  defined
  before swoole_server-&gt;start.
  
  Compare-and-swap (CAS) is an atomic instruction used in multithreading to achieve synchronization.
  It compares the content of a memory location with a given value and, only if they are the same,
  modifies the content of that memory location to a new given value.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The value of the atomic object.


id: Swoole\Atomic::add
type: function
doc:
<comment>Description:</comment>
  Add a number to the value to the atomic object.
  
  Add a number to the value to the atomic object.

<comment>Param:</comment>
  <info>int</info>  <strong>$add_value</strong>  The value which will be added to the current value.

<comment>Return:</comment>
  <info>int</info>  The new value of the atomic object.


id: Swoole\Atomic::cmpset
type: function
doc:
<comment>Description:</comment>
  Compare and set the value of the atomic object.

<comment>Param:</comment>
  <info>int</info>  <strong>$cmp_value</strong>  The value to compare with the current value of the atomic object.
  <info>int</info>  <strong>$new_value</strong>  The value to set to the atomic object if the cmp_value is the same as the current
                   value of the atomic object.

<comment>Return:</comment>
  <info>int</info>  The new value of the atomic object.


id: Swoole\Atomic::get
type: function
doc:
<comment>Description:</comment>
  Get the current value of the atomic object.
  
  Get the current value of the atomic object.

<comment>Return:</comment>
  <info>int</info>  The current value of the atomic object.


id: Swoole\Atomic::set
type: function
doc:
<comment>Description:</comment>
  Set a new value to the atomic object.
  
  Set a new value to the atomic object.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The value to set to the atomic object.

<comment>Return:</comment>
  <info>int</info>  The current value of the atomic object.


id: Swoole\Atomic::sub
type: function
doc:
<comment>Description:</comment>
  Subtract a number to the value of the atomic object.
  
  Subtract a number to the value of the atomic object.

<comment>Param:</comment>
  <info>int</info>  <strong>$sub_value</strong>  The value which will be subtracted to the current value.

<comment>Return:</comment>
  <info>int</info>  The current value of the atomic object.


id: Swoole\Buffer::__construct
type: function
doc:
<comment>Description:</comment>
  Fixed size memory blocks allocation.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The size of the memory to allocate.


id: Swoole\Buffer::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the Swoole memory buffer.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: Swoole\Buffer::__toString
type: function
doc:
<comment>Description:</comment>
  Get the string value of the memory buffer.

<comment>Return:</comment>
  <info>string</info>  The string value of the memory buffer.


id: Swoole\Buffer::append
type: function
doc:
<comment>Description:</comment>
  Append the string or binary data at the end of the memory buffer and return the new size of memory
  allocated.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The string or binary data to append at the end of the memory buffer.

<comment>Return:</comment>
  <info>int</info>  The new size of the memory buffer.


id: Swoole\Buffer::clear
type: function
doc:
<comment>Description:</comment>
  Reset the memory buffer.

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


id: Swoole\Buffer::expand
type: function
doc:
<comment>Description:</comment>
  Expand the size of memory buffer.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The new size of the memory buffer.

<comment>Return:</comment>
  <info>int</info>  The new size of the memory buffer.


id: Swoole\Buffer::read
type: function
doc:
<comment>Description:</comment>
  Read data from the memory buffer based on offset and length.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The offset.
  <info>int</info>  <strong>$length</strong>  The length.

<comment>Return:</comment>
  <info>string</info>  The data readed from the memory buffer.


id: Swoole\Buffer::recycle
type: function
doc:
<comment>Description:</comment>
  Release the memory to OS which is not used by the memory buffer.

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


id: Swoole\Buffer::substr
type: function
doc:
<comment>Description:</comment>
  Read data from the memory buffer based on offset and length. Or remove data from the memory
  buffer.
  
  If $remove is set to be true and $offset is set to be 0, the data will be removed from the buffer.
  The memory for storing the data will be released when the buffer object is deconstructed.

<comment>Param:</comment>
  <info>int</info>   <strong>$offset</strong>  The offset.
  <info>int</info>   <strong>$length</strong>  The length.
  <info>bool</info>  <strong>$remove</strong>  Whether to remove the data from the memory buffer.

<comment>Return:</comment>
  <info>string</info>  The data or string readed from the memory buffer.


id: Swoole\Buffer::write
type: function
doc:
<comment>Description:</comment>
  Write data to the memory buffer. The memory allocated for the buffer will not be changed.

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>  The offset.
  <info>string</info>  <strong>$data</strong>    The data to write to the memory buffer.

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


id: Swoole\Channel::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Swoole Channel
  
  Swoole channel is memory data structure works like Chan in Golang, implemented based on  shared
  memory and mutex locks. It can be used as high performance message queue in memory. Construct a
  swoole channel with a fixed size. The minimum size of a swoole channel is 64KB. Exceptions will be
  thrown if there is not enough memory.

<comment>Param:</comment>
  <info>string</info>  <strong>$size</strong>  The size of the Swoole channel.


id: Swoole\Channel::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct a Swoole channel.

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


id: Swoole\Channel::pop
type: function
doc:
<comment>Description:</comment>
  Read and pop data from swoole channel.

<comment>Return:</comment>
  <info>mixed</info>  If the channel is empty, the function will return false, or return the unserialized data.


id: Swoole\Channel::push
type: function
doc:
<comment>Description:</comment>
  Write and push data into Swoole channel.
  
  Data can be any non-empty PHP variable, the variable will be serialized if it is not string type.
  
  If size of the data is more than 8KB, swoole channel will use temp files storage.
  
  The function will return true if the write operation is succeeded, or return false if there is not
  enough space.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The data to push into the Swoole channel.

<comment>Return:</comment>
  <info>bool</info>  Wheter the data is pushed into he Swoole channel.


id: Swoole\Channel::stats
type: function
doc:
<comment>Description:</comment>
  Get stats of swoole channel.
  
  Get the numbers of queued elements and total size of the memory used by the queue.

<comment>Return:</comment>
  <info>array</info>  The stats of the Swoole channel.


id: Swoole\Client::__construct
type: function
doc:
<comment>Description:</comment>
  Create Swoole sync or async TCP/UDP client, with or without SSL.

<comment>Param:</comment>
  <info>int</info>  <strong>$sock_type</strong>  The type of socket: SWOOLE_TCP, SWOOLE_UDP, SWOOLE_ASYNC, SWOOLE_SSL,
                   SWOOLE_KEEP.
  <info>int</info>  <strong>$is_async</strong>   Synchronous or asynchronous client.


id: Swoole\Client::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the Swoole client.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: Swoole\Client::close
type: function
doc:
<comment>Description:</comment>
  Close the connection established.

<comment>Param:</comment>
  <info>bool</info>  <strong>$force</strong>  Whether force to close the connection.

<comment>Return:</comment>
  <info>bool</info>  Whether the connection is closed.


id: Swoole\Client::connect
type: function
doc:
<comment>Description:</comment>
  Connect to the remote TCP or UDP port.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>     The host name of the remote address.
  <info>int</info>     <strong>$port</strong>     The port number of the remote address.
  <info>int</info>     <strong>$timeout</strong>  The timeout(second) of connect/send/recv, the dafault value is 0.1s
  <info>int</info>     <strong>$flag</strong>     If the type of client is UDP, the $flag means if to enable the configuration
                    udp_connect.  If the configuration udp_connect is enabled, the client will only
                    receive the data from specified ip:port. If the type of client is TCP and the
                    $flag is set to 1, it must use swoole_client_select to check the connection
                    status before send/recv.

<comment>Return:</comment>
  <info>bool</info>  Whether the connection is established.


id: Swoole\Client::getpeername
type: function
doc:
<comment>Description:</comment>
  Get the remote socket name of the connection.

<comment>Return:</comment>
  <info>array</info>  The host and port of the remote socket.


id: Swoole\Client::getsockname
type: function
doc:
<comment>Description:</comment>
  Get the local socket name of the connection.

<comment>Return:</comment>
  <info>array</info>  The host and port of the local socket.


id: Swoole\Client::isConnected
type: function
doc:
<comment>Description:</comment>
  Check if the connection is established.
  
  This method returns the connection status of application layer.

<comment>Return:</comment>
  <info>bool</info>  Whether the connection is established.


id: Swoole\Client::on
type: function
doc:
<comment>Description:</comment>
  Add callback functions triggered by events.

<comment>Param:</comment>
  <info>string</info>    <strong>$event</strong>     
  <info>callable</info>  <strong>$callback</strong>  

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


id: Swoole\Client::pause
type: function
doc:
<comment>Description:</comment>
  Pause receiving data.

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


id: Swoole\Client::pipe
type: function
doc:
<comment>Description:</comment>
  Redirect the data to another file descriptor.

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

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


id: Swoole\Client::recv
type: function
doc:
<comment>Description:</comment>
  Receive data from the remote socket.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$size</strong>  
  <info>string</info>  <strong>$flag</strong>  

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


id: Swoole\Client::resume
type: function
doc:
<comment>Description:</comment>
  Resume receiving data.

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


id: Swoole\Client::send
type: function
doc:
<comment>Description:</comment>
  Send data to the remote TCP socket.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The data to send which can be string or binary
  <info>string</info>  <strong>$flag</strong>  

<comment>Return:</comment>
  <info>int</info>  If the client sends data successfully, it returns the length of data sent.  Or it returns
       false and sets $swoole_client-&gt;errCode. For sync client,  there is no limit for the data
       to send. For async client, The limit  for the data to send is socket_buffer_size.


id: Swoole\Client::sendfile
type: function
doc:
<comment>Description:</comment>
  Send file to the remote TCP socket.
  
  This is a wrapper of the Linux sendfile system call.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  File path of the file to send.
  <info>int</info>     <strong>$offset</strong>    Offset of the file to send

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Client::sendto
type: function
doc:
<comment>Description:</comment>
  Send data to the remote UDP address.
  
  The swoole client should be type of SWOOLE_SOCK_UDP or SWOOLE_SOCK_UDP6.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>    The IP address of remote host, IPv4 or IPv6.
  <info>int</info>     <strong>$port</strong>  The port number of remote host.
  <info>string</info>  <strong>$data</strong>  The data to send which should be less-than 64K.

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Client::set
type: function
doc:
<comment>Description:</comment>
  Set the Swoole client parameters before the connection is established.

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  

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


id: Swoole\Client::sleep
type: function
doc:
<comment>Description:</comment>
  Remove the TCP client from system event loop.
  
  Remove the TCP client from system event loop.

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


id: Swoole\Client::wakeup
type: function
doc:
<comment>Description:</comment>
  Add the TCP client back into the system event loop.

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


id: Swoole\Connection\Iterator::count
type: function
doc:
<comment>Description:</comment>
  Count connections.
  
  Gets the number of connections.

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


id: Swoole\Connection\Iterator::current
type: function
doc:
<comment>Description:</comment>
  Return current connection entry.
  
  Get current connection entry.

<comment>Return:</comment>
  <info>Connection</info>  The current connection entry.


id: Swoole\Connection\Iterator::key
type: function
doc:
<comment>Description:</comment>
  Return key of the current connection.
  
  This function returns key of the current connection.

<comment>Return:</comment>
  <info>int</info>  Key of the current connection.


id: Swoole\Connection\Iterator::next
type: function
doc:
<comment>Description:</comment>
  Move to the next connection.
  
  The iterator to the next connection.

<comment>Return:</comment>
  <info>Connection</info>  


id: Swoole\Connection\Iterator::offsetExists
type: function
doc:
<comment>Description:</comment>
  Check if offet exists.
  
  Check if offset exists.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The offset being checked.

<comment>Return:</comment>
  <info>bool</info>  Returns TRUE if the offset exists, otherwise FALSE.


id: Swoole\Connection\Iterator::offsetGet
type: function
doc:
<comment>Description:</comment>
  Offset to retrieve.
  
  Return the connection at specified offset.

<comment>Param:</comment>
  <info>string</info>  <strong>$index</strong>  The offset to retrieve.

<comment>Return:</comment>
  <info>Connection</info>  


id: Swoole\Connection\Iterator::offsetSet
type: function
doc:
<comment>Description:</comment>
  Assign a Connection to the specified offset.
  
  Assign a Connection to the specified offset.

<comment>Param:</comment>
  <info>int</info>    <strong>$offset</strong>      The offset to assign the Connection to.
  <info>mixed</info>  <strong>$connection</strong>  The connection to set.

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


id: Swoole\Connection\Iterator::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Unset an offset.
  
  Unsets an offset.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The offset to unset.

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


id: Swoole\Connection\Iterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewinds iterator

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


id: Swoole\Connection\Iterator::valid
type: function
doc:
<comment>Description:</comment>
  Check if current position is valid.
  
  Checks if the current position is valid.

<comment>Return:</comment>
  <info>bool</info>  Returns TRUE if the current iterator position is valid, otherwise FALSE.


id: Swoole\Coroutine::call_user_func
type: function
doc:
<comment>Description:</comment>
  Call a callback given by the first parameter
  
  Calls the <strong>$callback</strong> given by the first parameter and passes the remaining parameters as arguments.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The <info>callable</info> to be called.
  <info>mixed</info>     <strong>$args</strong>      Zero or more parameters to be passed to the callback.

<comment>Return:</comment>
  <info>mixed</info>  


id: Swoole\Coroutine::call_user_func_array
type: function
doc:
<comment>Description:</comment>
  Call a callback with an array of parameters
  
  Calls the callback given by the first parameter with the parameters in param_array.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>     The <info>callable</info> to be called.
  <info>array</info>     <strong>$param_array</strong>  Zero or more parameters in the array to be passed to the callback.

<comment>Return:</comment>
  <info>mixed</info>  


id: Swoole\Coroutine::cli_wait
type: function
doc:
<comment>Description:</comment>
  Description

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Coroutine::create
type: function
doc:
<comment>Description:</comment>
  Description
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Event::add
type: function
doc:
<comment>Description:</comment>
  Add new callback functions of a socket into the EventLoop.

<comment>Param:</comment>
  <info>int</info>       <strong>$fd</strong>              
  <info>callable</info>  <strong>$read_callback</strong>   
  <info>callable</info>  <strong>$write_callback</strong>  
  <info>string</info>    <strong>$events</strong>          

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Event::defer
type: function
doc:
<comment>Description:</comment>
  Add a callback function to the next event loop.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$callback</strong>  

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


id: Swoole\Event::del
type: function
doc:
<comment>Description:</comment>
  Remove all event callback functions of a socket.

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

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Event::exit
type: function
doc:
<comment>Description:</comment>
  Exit the eventloop, only available at client side.

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


id: Swoole\Event::set
type: function
doc:
<comment>Description:</comment>
  Update the event callback functions of a socket.

<comment>Param:</comment>
  <info>int</info>     <strong>$fd</strong>              
  <info>string</info>  <strong>$read_callback</strong>   
  <info>string</info>  <strong>$write_callback</strong>  
  <info>string</info>  <strong>$events</strong>          

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Event::wait
type: function
doc:
<comment>Description:</comment>
  Description
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: Swoole\Event::write
type: function
doc:
<comment>Description:</comment>
  Write data to the socket.

<comment>Param:</comment>
  <info>string</info>  <strong>$fd</strong>    
  <info>string</info>  <strong>$data</strong>  

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


id: Swoole\Http\Client::__construct
type: function
doc:
<comment>Description:</comment>
  Construct the async HTTP client.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>  The hostname of the remote host.
  <info>string</info>  <strong>$port</strong>  The port number of the remote host.
  <info>bool</info>    <strong>$ssl</strong>   Whether to enable SSL.


id: Swoole\Http\Client::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the HTTP client.

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


id: Swoole\Http\Client::addFile
type: function
doc:
<comment>Description:</comment>
  Add a file to the post form.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$name</strong>      
  <info>string</info>  <strong>$type</strong>      
  <info>string</info>  <strong>$filename</strong>  
  <info>string</info>  <strong>$offset</strong>    

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


id: Swoole\Http\Client::close
type: function
doc:
<comment>Description:</comment>
  Close the http connection.

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


id: Swoole\Http\Client::download
type: function
doc:
<comment>Description:</comment>
  Download a file from the remote server.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      
  <info>string</info>    <strong>$file</strong>      
  <info>callable</info>  <strong>$callback</strong>  
  <info>int</info>       <strong>$offset</strong>    

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


id: Swoole\Http\Client::execute
type: function
doc:
<comment>Description:</comment>
  Send the HTTP request after setting the parameters.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$callback</strong>  

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


id: Swoole\Http\Client::get
type: function
doc:
<comment>Description:</comment>
  Send GET http request to the remote server.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      
  <info>callable</info>  <strong>$callback</strong>  

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


id: Swoole\Http\Client::isConnected
type: function
doc:
<comment>Description:</comment>
  Check if the HTTP connection is connected.

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Http\Client::on
type: function
doc:
<comment>Description:</comment>
  Register callback function by event name.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

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


id: Swoole\Http\Client::post
type: function
doc:
<comment>Description:</comment>
  Send POST http request to the remote server.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      
  <info>string</info>    <strong>$data</strong>      
  <info>callable</info>  <strong>$callback</strong>  

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


id: Swoole\Http\Client::push
type: function
doc:
<comment>Description:</comment>
  Push data to websocket client.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    
  <info>string</info>  <strong>$opcode</strong>  
  <info>string</info>  <strong>$finish</strong>  

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


id: Swoole\Http\Client::set
type: function
doc:
<comment>Description:</comment>
  Update the HTTP client paramters.

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  

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


id: Swoole\Http\Client::setCookies
type: function
doc:
<comment>Description:</comment>
  Set the http request cookies.

<comment>Param:</comment>
  <info>array</info>  <strong>$cookies</strong>  

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


id: Swoole\Http\Client::setData
type: function
doc:
<comment>Description:</comment>
  Set the HTTP request body data.
  
  The HTTP method will be changed to be POST.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Client::setHeaders
type: function
doc:
<comment>Description:</comment>
  Set the HTTP request headers.

<comment>Param:</comment>
  <info>array</info>  <strong>$headers</strong>  

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


id: Swoole\Http\Client::setMethod
type: function
doc:
<comment>Description:</comment>
  Set the HTTP request method.

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

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


id: Swoole\Http\Client::upgrade
type: function
doc:
<comment>Description:</comment>
  Upgrade to websocket protocol.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$callback</strong>  

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


id: Swoole\Http\Request::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the HTTP request.

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


id: Swoole\Http\Request::rawcontent
type: function
doc:
<comment>Description:</comment>
  Get the raw HTTP POST body.
  
  This method is used for the POST data which isn't in the form of
  `application/x-www-form-urlencoded`.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: Swoole\Http\Response::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the HTTP response.

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


id: Swoole\Http\Response::cookie
type: function
doc:
<comment>Description:</comment>
  Set the cookies of the HTTP response.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      
  <info>string</info>  <strong>$value</strong>     
  <info>string</info>  <strong>$expires</strong>   
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$domain</strong>    
  <info>string</info>  <strong>$secure</strong>    
  <info>string</info>  <strong>$httponly</strong>  

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


id: Swoole\Http\Response::end
type: function
doc:
<comment>Description:</comment>
  Send data for the HTTP request and finish the response.

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

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


id: Swoole\Http\Response::gzip
type: function
doc:
<comment>Description:</comment>
  Enable the gzip of response content.
  
  
  The header about Content-Encoding will be added automatically.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::header
type: function
doc:
<comment>Description:</comment>
  Set the HTTP response headers.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>      
  <info>string</info>  <strong>$value</strong>    
  <info>string</info>  <strong>$ucwords</strong>  

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


id: Swoole\Http\Response::initHeader
type: function
doc:
<comment>Description:</comment>
  Init the HTTP response header.
  
  Init the HTTP response header.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::rawcookie
type: function
doc:
<comment>Description:</comment>
  Set the raw cookies to the HTTP response.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      
  <info>string</info>  <strong>$value</strong>     
  <info>string</info>  <strong>$expires</strong>   
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$domain</strong>    
  <info>string</info>  <strong>$secure</strong>    
  <info>string</info>  <strong>$httponly</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::sendfile
type: function
doc:
<comment>Description:</comment>
  Send file through the HTTP response.
  
  Send file through the HTTP response.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  
  <info>int</info>     <strong>$offset</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::status
type: function
doc:
<comment>Description:</comment>
  Set the status code of the HTTP response.
  
  Set the status code of the HTTP response.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::write
type: function
doc:
<comment>Description:</comment>
  Append HTTP body content to the HTTP response.
  
  Append HTTP body content to the HTTP response.

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

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


id: Swoole\Http\Server::on
type: function
doc:
<comment>Description:</comment>
  Vincula a função de retorno (callback) ao servidor HTTP pelo nome do evento.
  
  Vincula a função de retorno (callback) ao servidor HTTP pelo nome do evento.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

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


id: Swoole\Http\Server::start
type: function
doc:
<comment>Description:</comment>
  Iniciar o servidor http swoole.
  
  Inicia o servidor http swoole.

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


id: Swoole\Lock::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a memory lock.
  
  Swoole lock is used for data synchronization between multiple theads or processes.

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>                
  <info>string</info>  <strong>$file_lock_location</strong>  


id: Swoole\Lock::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory a Swoole memory lock.

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


id: Swoole\Lock::lock
type: function
doc:
<comment>Description:</comment>
  Try to acquire the lock. It will block if the lock is not available.

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


id: Swoole\Lock::lock_read
type: function
doc:
<comment>Description:</comment>
  Lock a read-write lock for reading.
  
  Lock a read-write lock for reading.

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


id: Swoole\Lock::trylock
type: function
doc:
<comment>Description:</comment>
  Try to acquire the lock and return straight away even the lock is not available.

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


id: Swoole\Lock::trylock_read
type: function
doc:
<comment>Description:</comment>
  Try to lock a read-write lock for reading and return straight away even the lock is not available.

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


id: Swoole\Lock::unlock
type: function
doc:
<comment>Description:</comment>
  Release the lock.

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


id: Swoole\Mmap::open
type: function
doc:
<comment>Description:</comment>
  Map a file into memory and return the stream resource which can be used by PHP stream operations.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  
  <info>string</info>  <strong>$size</strong>      
  <info>string</info>  <strong>$offset</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\MySQL::__construct
type: function
doc:
<comment>Description:</comment>
  Construct an async MySQL client.
  
  Construct an async MySQL client.


id: Swoole\MySQL::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory the async MySQL client.

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


id: Swoole\MySQL::close
type: function
doc:
<comment>Description:</comment>
  Close the async MySQL connection.

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


id: Swoole\MySQL::connect
type: function
doc:
<comment>Description:</comment>
  Connect to the remote MySQL server.
  
  Connect to the remote MySQL server.

<comment>Param:</comment>
  <info>array</info>     <strong>$server_config</strong>  
  <info>callable</info>  <strong>$callback</strong>       

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


id: Swoole\MySQL::on
type: function
doc:
<comment>Description:</comment>
  Register callback function based on event name.
  
  Register callback function based on event name, current only 'close' event is supported.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

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


id: Swoole\MySQL::query
type: function
doc:
<comment>Description:</comment>
  Run the SQL query.

<comment>Param:</comment>
  <info>string</info>    <strong>$sql</strong>       
  <info>callable</info>  <strong>$callback</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Process::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a process.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>                   
  <info>bool</info>      <strong>$redirect_stdin_and_stdout</strong>  
  <info>int</info>       <strong>$pipe_type</strong>                  


id: Swoole\Process::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory the process.

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


id: Swoole\Process::alarm
type: function
doc:
<comment>Description:</comment>
  High precision timer which triggers signal with fixed interval.

<comment>Param:</comment>
  <info>int</info>  <strong>$interval_usec</strong>  

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


id: Swoole\Process::close
type: function
doc:
<comment>Description:</comment>
  Close the pipe to the child process.
  
  Close the pipe to the child process.

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


id: Swoole\Process::daemon
type: function
doc:
<comment>Description:</comment>
  Change the process to be a daemon process.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>bool</info>  <strong>$nochdir</strong>  
  <info>bool</info>  <strong>$noclose</strong>  

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


id: Swoole\Process::exec
type: function
doc:
<comment>Description:</comment>
  Execute system commands.
  
  The process will be replaced to be the system command process, but the pipe to the parent process
  will be kept.

<comment>Param:</comment>
  <info>string</info>  <strong>$exec_file</strong>  
  <info>string</info>  <strong>$args</strong>       

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Process::exit
type: function
doc:
<comment>Description:</comment>
  Stop the child processes.

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

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


id: Swoole\Process::freeQueue
type: function
doc:
<comment>Description:</comment>
  Destroy the message queue created by swoole_process::useQueue.

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


id: Swoole\Process::kill
type: function
doc:
<comment>Description:</comment>
  Send signal to the child process.
  
  Send signal to the child process.

<comment>Param:</comment>
  <info>int</info>  <strong>$pid</strong>        Process pid
  <info>int</info>  <strong>$signal_no</strong>  Signal to be sent

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Swoole\Process::name
type: function
doc:
<comment>Description:</comment>
  Set name of the process.

<comment>Param:</comment>
  <info>string</info>  <strong>$process_name</strong>  Set name of the process.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Swoole\Process::pop
type: function
doc:
<comment>Description:</comment>
  Read and pop data from the message queue.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxsize</strong>  

<comment>Return:</comment>
  <info>mixed</info>  


id: Swoole\Process::push
type: function
doc:
<comment>Description:</comment>
  Write and push data into the message queue.

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

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Process::read
type: function
doc:
<comment>Description:</comment>
  Read data sending to the process.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxsize</strong>  

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


id: Swoole\Process::signal
type: function
doc:
<comment>Description:</comment>
  Send signal to the child processes.

<comment>Param:</comment>
  <info>string</info>    <strong>$signal_no</strong>  
  <info>callable</info>  <strong>$callback</strong>   

<comment>Return:</comment>
  <info>void</info>  If signal sent successfully, it returns TRUE, otherwise it returns FALSE.


id: Swoole\Process::start
type: function
doc:
<comment>Description:</comment>
  Start the process.

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


id: Swoole\Process::statQueue
type: function
doc:
<comment>Description:</comment>
  Get the stats of the message queue used as the communication method between processes.

<comment>Return:</comment>
  <info>array</info>  The array of status of the message queue.


id: Swoole\Process::useQueue
type: function
doc:
<comment>Description:</comment>
  Create a message queue as the communication method between the parent process and child processes.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>   
  <info>int</info>  <strong>$mode</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Process::wait
type: function
doc:
<comment>Description:</comment>
  Wait for the events of child processes.

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

<comment>Return:</comment>
  <info>array</info>  


id: Swoole\Process::write
type: function
doc:
<comment>Description:</comment>
  Write data into the pipe and communicate with the parent process or child processes.

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

<comment>Return:</comment>
  <info>int</info>  


id: Swoole\Redis\Server::format
type: function
doc:
<comment>Description:</comment>
  Description
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>   
  <info>string</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Redis\Server::setHandler
type: function
doc:
<comment>Description:</comment>
  Description
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>                 
  <info>string</info>  <strong>$callback</strong>                
  <info>string</info>  <strong>$number_of_string_param</strong>  
  <info>string</info>  <strong>$type_of_array_param</strong>     

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Serialize::pack
type: function
doc:
<comment>Description:</comment>
  Serialize the data.
  
  Swoole provides a fast and high performance serialization module.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>     
  <info>int</info>     <strong>$is_fast</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Serialize::unpack
type: function
doc:
<comment>Description:</comment>
  Unserialize the data.
  
  Unserialize the data.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Swoole server.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>       
  <info>int</info>     <strong>$port</strong>       
  <info>integr</info>  <strong>$mode</strong>       
  <info>int</info>     <strong>$sock_type</strong>  


id: Swoole\Server::addProcess
type: function
doc:
<comment>Description:</comment>
  Add a user defined swoole_process to the server.

<comment>Param:</comment>
  <info>swoole_process</info>  <strong>$process</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Server::addlistener
type: function
doc:
<comment>Description:</comment>
  Add a new listener to the server.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>         
  <info>int</info>     <strong>$port</strong>         
  <info>string</info>  <strong>$socket_type</strong>  

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


id: Swoole\Server::after
type: function
doc:
<comment>Description:</comment>
  Trigger a callback function after a period of time.

<comment>Param:</comment>
  <info>int</info>       <strong>$after_time_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>       
  <info>string</info>    <strong>$param</strong>          

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::bind
type: function
doc:
<comment>Description:</comment>
  Bind the connection to a user defined user ID.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>   
  <info>int</info>  <strong>$uid</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Server::clearTimer
type: function
doc:
<comment>Description:</comment>
  Stop and destory a timer.
  
  Estilo orientado a objetos (method):
  
  Estilo procedural:
  
  Stop and destory a timer

<comment>Param:</comment>
  <info>int</info>  <strong>$timer_id</strong>  

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


id: Swoole\Server::close
type: function
doc:
<comment>Description:</comment>
  Close a connection to the client.

<comment>Param:</comment>
  <info>int</info>   <strong>$fd</strong>     
  <info>bool</info>  <strong>$reset</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Server::confirm
type: function
doc:
<comment>Description:</comment>
  Check status of the connection.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Server::connection_info
type: function
doc:
<comment>Description:</comment>
  Get the connection info by file description.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>          
  <info>int</info>  <strong>$reactor_id</strong>  

<comment>Return:</comment>
  <info>array</info>  


id: Swoole\Server::connection_list
type: function
doc:
<comment>Description:</comment>
  Get all of the established connections.

<comment>Param:</comment>
  <info>int</info>  <strong>$start_fd</strong>  
  <info>int</info>  <strong>$pagesize</strong>  

<comment>Return:</comment>
  <info>array</info>  


id: Swoole\Server::defer
type: function
doc:
<comment>Description:</comment>
  Delay execution of the callback function at the end of current EventLoop.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  

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


id: Swoole\Server::exist
type: function
doc:
<comment>Description:</comment>
  Check if the connection is existed.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Server::finish
type: function
doc:
<comment>Description:</comment>
  Used in task process for sending result to the worker process when the task is finished.

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

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


id: Swoole\Server::getClientInfo
type: function
doc:
<comment>Description:</comment>
  Get the connection info by file description.

<comment>Param:</comment>
  <info>int</info>   <strong>$fd</strong>            File descriptors.
  <info>int</info>   <strong>$reactor_id</strong>    The Reactor thread ID where the connection is made.
  <info>bool</info>  <strong>$ignore_error</strong>  Whether to ignore errors, if set to true, connection information will be
                       returned even if the connection is closed.

<comment>Return:</comment>
  <info>array</info>  Returns information about the client connection.


id: Swoole\Server::getClientList
type: function
doc:
<comment>Description:</comment>
  Get all of the established connections.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>  <strong>$start_fd</strong>  
  <info>int</info>  <strong>$pagesize</strong>  

<comment>Return:</comment>
  <info>array</info>  


id: Swoole\Server::getLastError
type: function
doc:
<comment>Description:</comment>
  Get the error code of the most recent error.

<comment>Return:</comment>
  <info>int</info>  


id: Swoole\Server::heartbeat
type: function
doc:
<comment>Description:</comment>
  Check all the connections on the server.

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

<comment>Return:</comment>
  <info>mixed</info>  


id: Swoole\Server::listen
type: function
doc:
<comment>Description:</comment>
  Listen on the given IP and port, socket type.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>         
  <info>int</info>     <strong>$port</strong>         
  <info>string</info>  <strong>$socket_type</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Server::on
type: function
doc:
<comment>Description:</comment>
  Register a callback function by event name.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

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


id: Swoole\Server::pause
type: function
doc:
<comment>Description:</comment>
  Stop receiving data from the connection.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>  

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


id: Swoole\Server::protect
type: function
doc:
<comment>Description:</comment>
  Set the connection to be protected mode.

<comment>Param:</comment>
  <info>int</info>   <strong>$fd</strong>            
  <info>bool</info>  <strong>$is_protected</strong>  

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


id: Swoole\Server::reload
type: function
doc:
<comment>Description:</comment>
  Restart all the worker process.

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Server::resume
type: function
doc:
<comment>Description:</comment>
  Start receving data from the connection.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>  

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


id: Swoole\Server::send
type: function
doc:
<comment>Description:</comment>
  Send data to the client.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>     <strong>$fd</strong>          
  <info>string</info>  <strong>$data</strong>        
  <info>int</info>     <strong>$reactor_id</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Server::sendMessage
type: function
doc:
<comment>Description:</comment>
  Send message to worker processes by ID.

<comment>Param:</comment>
  <info></info>        <strong>$dst_worker_id</strong>  
  <info>string</info>  <strong>$data</strong>           

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Server::sendfile
type: function
doc:
<comment>Description:</comment>
  Send file to the connection.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>     <strong>$fd</strong>        
  <info>string</info>  <strong>$filename</strong>  
  <info>int</info>     <strong>$offset</strong>    

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Server::sendto
type: function
doc:
<comment>Description:</comment>
  Send data to the remote UDP address.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>             
  <info>int</info>     <strong>$port</strong>           
  <info>string</info>  <strong>$data</strong>           
  <info>string</info>  <strong>$server_socket</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Server::sendwait
type: function
doc:
<comment>Description:</comment>
  Send data to the remote socket in the blocking way.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>     <strong>$fd</strong>    
  <info>string</info>  <strong>$data</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Server::set
type: function
doc:
<comment>Description:</comment>
  Set the runtime settings of the swoole server.
  
  Set the runtime settings of the swoole server. The settings can be accessed by $server-&gt;setting
  when the swoole server has started.

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::shutdown
type: function
doc:
<comment>Description:</comment>
  Shutdown the master server process, this function can be called in worker processes.

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


id: Swoole\Server::start
type: function
doc:
<comment>Description:</comment>
  Inicia o servidor Swoole.

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


id: Swoole\Server::stats
type: function
doc:
<comment>Description:</comment>
  Get the stats of the Swoole server.

<comment>Return:</comment>
  <info>array</info>  


id: Swoole\Server::stop
type: function
doc:
<comment>Description:</comment>
  Stop the Swoole server.

<comment>Param:</comment>
  <info>int</info>  <strong>$worker_id</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Server::task
type: function
doc:
<comment>Description:</comment>
  Send data to the task worker processes.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>    <strong>$data</strong>           
  <info>int</info>       <strong>$dst_worker_id</strong>  
  <info>callable</info>  <strong>$callback</strong>       

<comment>Return:</comment>
  <info>mixed</info>  


id: Swoole\Server::taskWaitMulti
type: function
doc:
<comment>Description:</comment>
  Execute multiple tasks concurrently.

<comment>Param:</comment>
  <info>array</info>  <strong>$tasks</strong>       
  <info>float</info>  <strong>$timeout_ms</strong>  

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


id: Swoole\Server::taskwait
type: function
doc:
<comment>Description:</comment>
  Send data to the task worker processes in blocking way.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>       
  <info>float</info>   <strong>$timeout</strong>    
  <info>int</info>     <strong>$worker_id</strong>  

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


id: Swoole\Server::tick
type: function
doc:
<comment>Description:</comment>
  Repeats a given function at every given time-interval.

<comment>Param:</comment>
  <info>int</info>       <strong>$interval_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>     

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


id: Swoole\Server\Port::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory server port

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


id: Swoole\Server\Port::on
type: function
doc:
<comment>Description:</comment>
  Register callback functions by event.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server\Port::set
type: function
doc:
<comment>Description:</comment>
  Set protocol of the server port.

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  

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


id: Swoole\Table::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Swoole memory table with fixed size.

<comment>Param:</comment>
  <info>int</info>  <strong>$table_size</strong>  


id: Swoole\Table::column
type: function
doc:
<comment>Description:</comment>
  Set the data type and size of the columns.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  
  <info>string</info>  <strong>$type</strong>  
  <info>int</info>     <strong>$size</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Table::count
type: function
doc:
<comment>Description:</comment>
  Count the rows in the table, or count all the elements in the table if $mode = 1.

<comment>Return:</comment>
  <info>int</info>  


id: Swoole\Table::create
type: function
doc:
<comment>Description:</comment>
  Create the swoole memory table.

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


id: Swoole\Table::current
type: function
doc:
<comment>Description:</comment>
  Get the current row.

<comment>Return:</comment>
  <info>array</info>  


id: Swoole\Table::decr
type: function
doc:
<comment>Description:</comment>
  Decrement the value in the Swoole table by $row_key and $column_key.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     
  <info>string</info>  <strong>$column</strong>  
  <info>int</info>     <strong>$decrby</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Table::del
type: function
doc:
<comment>Description:</comment>
  Delete a row in the Swoole table by $row_key.

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

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


id: Swoole\Table::destroy
type: function
doc:
<comment>Description:</comment>
  Destroy the Swoole table.

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


id: Swoole\Table::exist
type: function
doc:
<comment>Description:</comment>
  Check if a row is existed by $row_key.

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

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Table::get
type: function
doc:
<comment>Description:</comment>
  Get the value in the Swoole table by $row_key and $column_key.

<comment>Param:</comment>
  <info>string</info>  <strong>$row_key</strong>     
  <info>string</info>  <strong>$column_key</strong>  

<comment>Return:</comment>
  <info>int</info>  


id: Swoole\Table::incr
type: function
doc:
<comment>Description:</comment>
  Increment the value by $row_key and $column_key.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     
  <info>string</info>  <strong>$column</strong>  
  <info>int</info>     <strong>$incrby</strong>  

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


id: Swoole\Table::key
type: function
doc:
<comment>Description:</comment>
  Get the key of current row.

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


id: Swoole\Table::next
type: function
doc:
<comment>Description:</comment>
  Iterator the next row.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Table::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the iterator.

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


id: Swoole\Table::set
type: function
doc:
<comment>Description:</comment>
  Update a row of the table by $row_key.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    
  <info>array</info>   <strong>$value</strong>  

<comment>Return:</comment>
  <info>VOID</info>  


id: Swoole\Table::valid
type: function
doc:
<comment>Description:</comment>
  Check current if the current row is valid.

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Timer::after
type: function
doc:
<comment>Description:</comment>
  Trigger a callback function after a period of time.
  
  Trigger a callback function after a period of time.

<comment>Param:</comment>
  <info>int</info>       <strong>$after_time_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>       

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


id: Swoole\Timer::clear
type: function
doc:
<comment>Description:</comment>
  Delete a timer by timer ID.
  
  Delete a timer by timer ID.

<comment>Param:</comment>
  <info>int</info>  <strong>$timer_id</strong>  

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


id: Swoole\Timer::exists
type: function
doc:
<comment>Description:</comment>
  Check if a timer is existed.
  
  Check if a timer is existed.

<comment>Param:</comment>
  <info>int</info>  <strong>$timer_id</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\Timer::tick
type: function
doc:
<comment>Description:</comment>
  Repeats a given function at every given time-interval.

<comment>Param:</comment>
  <info>int</info>       <strong>$interval_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>     
  <info>string</info>    <strong>$param</strong>        

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


id: Swoole\WebSocket\Server::exist
type: function
doc:
<comment>Description:</comment>
  Check if the file descriptor exists.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: Swoole\WebSocket\Server::on
type: function
doc:
<comment>Description:</comment>
  Register event callback function
  
  Register event callback function

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\WebSocket\Server::pack
type: function
doc:
<comment>Description:</comment>
  Get a pack of binary data to send in a single frame.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    
  <info>string</info>  <strong>$opcode</strong>  
  <info>string</info>  <strong>$finish</strong>  
  <info>string</info>  <strong>$mask</strong>    

<comment>Return:</comment>
  <info>binary</info>  


id: Swoole\WebSocket\Server::push
type: function
doc:
<comment>Description:</comment>
  Push data to the remote client.

<comment>Param:</comment>
  <info>string</info>  <strong>$fd</strong>      
  <info>string</info>  <strong>$data</strong>    
  <info>string</info>  <strong>$opcode</strong>  
  <info>string</info>  <strong>$finish</strong>  

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


id: Swoole\WebSocket\Server::unpack
type: function
doc:
<comment>Description:</comment>
  Unpack the binary data received from the client.

<comment>Param:</comment>
  <info>binary</info>  <strong>$data</strong>  

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


id: SyncEvent
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native implementation of named and unnamed event objects.  Both automatic and
  manual event objects are supported.
  
  An event object waits, without polling, for the object to be fired/set. One instance waits on the
  event object while another instance fires/sets the event.  Event objects are useful wherever a
  long-running process would otherwise poll a resource (e.g. checking to see if uploaded data needs
  to be processed).


id: SyncEvent::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncEvent object
  
  Constructs a named or unnamed event object.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     The name of the event if this is a named event object.
                    
                    If the name already exists, it must be able to be opened by the current user
                    that the process is running as or an exception will be thrown with a meaningless
                    error message.
  <info>bool</info>    <strong>$manual</strong>   Specifies whether or not the event object must be reset manually.
                    
                    Manual reset event objects allow all waiting processes through until the object
                    is reset.
  <info>bool</info>    <strong>$prefire</strong>  Specifies whether or not to prefire (signal) the event object.
                    
                    Only has impact if the calling process/thread is the first to create the object.

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncEvent</class> object.

<comment>See Also:</comment>
   * SyncEvent::fire
   * SyncEvent::reset
   * SyncEvent::wait


id: SyncEvent::fire
type: function
doc:
<comment>Description:</comment>
  Fires/sets the event
  
  Fires/sets a <class>SyncEvent</class> object. Lets multiple threads through that are waiting if the event object
  was created with a manual value of <info>true</info>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * SyncEvent::reset
   * SyncEvent::wait


id: SyncEvent::reset
type: function
doc:
<comment>Description:</comment>
  Resets a manual event
  
  Resets a <class>SyncEvent</class> object that has been fired/set. Only valid for manual event objects.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * SyncEvent::fire
   * SyncEvent::reset
   * SyncEvent::wait


id: SyncEvent::wait
type: function
doc:
<comment>Description:</comment>
  Waits for the event to be fired/set
  
  Waits for the <class>SyncEvent</class> object to be fired.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  The number of milliseconds to wait for the event to be fired. A value of -1 is
              infinite.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * SyncEvent::fire


id: SyncMutex
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native implementation of named and unnamed countable mutex objects.
  
  A mutex is a mutual exclusion object that restricts access to a shared resource (e.g. a file) to a
  single instance. Countable mutexes acquire the mutex a single time and internally track the number
  of times the mutex is locked. The mutex is unlocked as soon as it goes out of scope or is unlocked
  the same number of times that it was locked.


id: SyncMutex::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncMutex object
  
  Constructs a named or unnamed countable mutex.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the mutex if this is a named mutex object.
                 
                 If the name already exists, it must be able to be opened by the current user that
                 the process is running as or an exception will be thrown with a meaningless error
                 message.

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncMutex</class> object.

<comment>See Also:</comment>
   * SyncMutex::lock
   * SyncMutex::unlock


id: SyncMutex::lock
type: function
doc:
<comment>Description:</comment>
  Waits for an exclusive lock
  
  Obtains an exclusive lock on a <class>SyncMutex</class> object. If the lock is already acquired, then this
  increments an internal counter.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  The number of milliseconds to wait for the exclusive lock. A value of -1 is infinite.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * SyncMutex::unlock


id: SyncMutex::unlock
type: function
doc:
<comment>Description:</comment>
  Unlocks the mutex
  
  Decreases the internal counter of a <class>SyncMutex</class> object. When the internal counter reaches zero, the
  actual lock on the object is released.

<comment>Param:</comment>
  <info>bool</info>  <strong>$all</strong>  Specifies whether or not to set the internal counter to zero and therefore release the
              lock.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * SyncMutex::lock


id: SyncReaderWriter
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native implementation of named and unnamed reader-writer objects.
  
  A reader-writer object allows many readers or one writer to access a resource. This is an
  efficient solution for managing resources where access will primarily be read-only but exclusive
  write access is occasionally necessary.


id: SyncReaderWriter::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncReaderWriter object
  
  Constructs a named or unnamed reader-writer object.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>        The name of the reader-writer if this is a named reader-writer object.
                       
                       If the name already exists, it must be able to be opened by the current user
                       that the process is running as or an exception will be thrown with a
                       meaningless error message.
                       
                       On Windows, <strong>$name</strong> must not contain backslashes.
  <info>int</info>     <strong>$autounlock</strong>  Specifies whether or not to automatically unlock the reader-writer at the
                       conclusion of the PHP script.
                       
                       If an object is:  A named reader-writer with an autounlock of FALSE, the
                       object is locked for either reading or writing, and the PHP script concludes
                       before the object is unlocked, then the underlying objects will end up in an
                       inconsistent state.

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncReaderWriter</class> object.

<comment>See Also:</comment>
   * SyncReaderWriter::readlock
   * SyncReaderWriter::readunlock
   * SyncReaderWriter::writelock
   * SyncReaderWriter::writeunlock


id: SyncReaderWriter::readlock
type: function
doc:
<comment>Description:</comment>
  Waits for a read lock
  
  Obtains a read lock on a <class>SyncReaderWriter</class> object.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  The number of milliseconds to wait for a lock. A value of -1 is infinite.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * SyncReaderWriter::readunlock


id: SyncReaderWriter::readunlock
type: function
doc:
<comment>Description:</comment>
  Releases a read lock
  
  Releases a read lock on a <class>SyncReaderWriter</class> object.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * SyncReaderWriter::readlock


id: SyncReaderWriter::writelock
type: function
doc:
<comment>Description:</comment>
  Waits for an exclusive write lock
  
  Obtains an exclusive write lock on a <class>SyncReaderWriter</class> object.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  The number of milliseconds to wait for a lock. A value of -1 is infinite.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * SyncReaderWriter::writeunlock


id: SyncReaderWriter::writeunlock
type: function
doc:
<comment>Description:</comment>
  Releases a write lock
  
  Releases a write lock on a <class>SyncReaderWriter</class> object.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * SyncReaderWriter::writelock


id: SyncSemaphore
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native implementation of named and unnamed semaphore objects.
  
  A semaphore restricts access to a limited resource to a limited number of instances. Semaphores
  differ from mutexes in that they can allow more than one instance to access a resource at one time
  while a mutex only allows one instance at a time.


id: SyncSemaphore::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncSemaphore object
  
  Constructs a named or unnamed semaphore.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>        The name of the semaphore if this is a named semaphore object.
                       
                       If the name already exists, it must be able to be opened by the current user
                       that the process is running as or an exception will be thrown with a
                       meaningless error message.
  <info>int</info>     <strong>$initialval</strong>  The initial value of the semaphore. This is the number of locks that may be
                       obtained.
  <info>bool</info>    <strong>$autounlock</strong>  Specifies whether or not to automatically unlock the semaphore at the
                       conclusion of the PHP script.
                       
                       If an object is: A named semaphore with an autounlock of <info>false</info>, the object is
                       locked, and the PHP script concludes before the object is unlocked, then the
                       underlying semaphore will end up in an inconsistent state.

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncSemaphore</class> object.

<comment>See Also:</comment>
   * SyncSemaphore::lock
   * SyncSemaphore::unlock


id: SyncSemaphore::lock
type: function
doc:
<comment>Description:</comment>
  Decreases the count of the semaphore or waits
  
  Decreases the count of a <class>SyncSemaphore</class> object or waits until the semaphore becomes non-zero.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  The number of milliseconds to wait for the semaphore. A value of -1 is infinite.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * SyncSemaphore::unlock


id: SyncSemaphore::unlock
type: function
doc:
<comment>Description:</comment>
  Increases the count of the semaphore
  
  Increases the count of a <class>SyncSemaphore</class> object.

<comment>Param:</comment>
  <info>int</info>  <strong>$prevcount</strong>  Returns the previous count of the semaphore.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * SyncSemaphore::lock


id: SyncSharedMemory
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native, consistent implementation of named shared memory objects.
  
  Shared memory lets two separate processes communicate without the need for complex pipes or
  sockets.  There are several integer-based shared memory implementations for PHP.  Named shared
  memory is an alternative.
  
  Synchronization objects (e.g. SyncMutex) are still required to protect most uses of shared memory.


id: SyncSharedMemory::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncSharedMemory object
  
  Constructs a named shared memory object.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the shared memory object.
                 
                 If the name already exists, it must be able to be opened by the current user that
                 the process is running as or an exception will be thrown with a meaningless error
                 message.
  <info>int</info>     <strong>$size</strong>  The size, in bytes, of shared memory to reserve.
                 
                 The amount of memory cannot be resized later.  Request sufficient storage up front.

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncSharedMemory</class> object.

<comment>See Also:</comment>
   * SyncSharedMemory::first
   * SyncSharedMemory::size
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::first
type: function
doc:
<comment>Description:</comment>
  Check to see if the object is the first instance system-wide of named shared memory
  
  Retrieves the system-wide first instance status of a <class>SyncSharedMemory</class> object.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::read
type: function
doc:
<comment>Description:</comment>
  Copy data from named shared memory
  
  Copies data from named shared memory.

<comment>Param:</comment>
  <info>int</info>  <strong>$start</strong>   The start/offset, in bytes, to begin reading.
                
                If the value is negative, the starting position will begin at the specified number
                of bytes from the end of the shared memory segment.
  <info>int</info>  <strong>$length</strong>  The number of bytes to read.
                
                If unspecified, reading will stop at the end of the shared memory segment.
                
                If the value is negative, reading will stop the specified number of bytes from the
                end of the shared memory segment.

<comment>Return:</comment>
  <info>unknown</info>  A string containing the data read from shared memory.

<comment>See Also:</comment>
   * SyncSharedMemory::__construct
   * SyncSharedMemory::first
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::size
type: function
doc:
<comment>Description:</comment>
  Returns the size of the named shared memory
  
  Retrieves the shared memory size of a <class>SyncSharedMemory</class> object.

<comment>Return:</comment>
  <info>int</info>  An integer containing the size of the shared memory. This will be the same size that was
       passed to the constructor.

<comment>See Also:</comment>
   * SyncSharedMemory::__construct
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::write
type: function
doc:
<comment>Description:</comment>
  Copy data to named shared memory
  
  Copies data to named shared memory.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The data to write to shared memory.
                   
                   If the size of the data exceeds the size of the shared memory, the number of
                   bytes written returned will be less than the length of the input.
  <info>int</info>     <strong>$start</strong>   The start/offset, in bytes, to begin writing.
                   
                   If the value is negative, the starting position will begin at the specified
                   number of bytes from the end of the shared memory segment.

<comment>Return:</comment>
  <info>unknown</info>  An integer containing the number of bytes written to shared memory.

<comment>See Also:</comment>
   * SyncSharedMemory::__construct
   * SyncSharedMemory::first
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SysvMessageQueue
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces a <return>sysvmsg queue</return> resource as of PHP 8.0.0.


id: SysvSemaphore
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces a <return>sysvsem</return> resource as of PHP 8.0.0.


id: SysvSharedMemory
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces a <return>sysvshm</return> resource as of PHP 8.0.0.


id: Table::count
type: function
doc:
<comment>Description:</comment>
  Get row count
  
  Fetch the number of rows in the table.

<comment>Return:</comment>
  <info>int</info>  The total number of rows in the table.


id: Table::delete
type: function
doc:
<comment>Description:</comment>
  Delete rows from table
  
  Deletes rows from a table.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  A TableDelete object; use the execute() method to execute the delete
                             query.


id: Table::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  Check if table exists in database
  
  Verifies if this table exists in the database.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if table exists in the database, else <info>false</info> if it does not.


id: Table::getName
type: function
doc:
<comment>Description:</comment>
  Get table name
  
  Returns the name of this database object.

<comment>Return:</comment>
  <info>string</info>  The name of this database object.


id: Table::getSchema
type: function
doc:
<comment>Description:</comment>
  Get table schema
  
  Fetch the schema associated with the table.

<comment>Return:</comment>
  <info>mysql_xdevapi\Schema</info>  A Schema object.


id: Table::getSession
type: function
doc:
<comment>Description:</comment>
  Get table session
  
  Get session associated with the table.

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  A Session object.


id: Table::insert
type: function
doc:
<comment>Description:</comment>
  Insert table rows
  
  Inserts rows into a table.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$columns</strong>       The columns to insert data into. Can be an array with one or more values, or
                        a string.
  <info>mixed</info>  <strong>$more_columns</strong>  Additional columns definitions.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableInsert</info>  A TableInsert object; use the execute() method to execute the insert
                             statement.


id: Table::isView
type: function
doc:
<comment>Description:</comment>
  Check if table is view
  
  Determine if the underlying object is a view or not.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the underlying object is a view, otherwise <info>false</info>.


id: Table::select
type: function
doc:
<comment>Description:</comment>
  Select rows from table
  
  Fetches data from a table.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$columns</strong>       The columns to select data from. Can be an array with one or more values, or
                        a string.
  <info>mixed</info>  <strong>$more_columns</strong>  Additional columns parameter definitions.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object; use the execute() method to execute the select
                             and return a RowResult object.


id: Table::update
type: function
doc:
<comment>Description:</comment>
  Update rows in table
  
  Updates columns in a table.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  A TableUpdate object; use the execute() method to execute the update
                             statement.


id: TableDelete::__construct
type: function
doc:
<comment>Description:</comment>
  TableDelete constructor
  
  Initiated by using the delete() method.


id: TableDelete::bind
type: function
doc:
<comment>Description:</comment>
  Bind delete query parameters
  
  Binds a value to a specific placeholder.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  The name of the placeholder and the value to bind.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  A TableDelete object.


id: TableDelete::execute
type: function
doc:
<comment>Description:</comment>
  Execute delete query
  
  Execute the delete query.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  A Result object.


id: TableDelete::limit
type: function
doc:
<comment>Description:</comment>
  Limit deleted rows
  
  Sets the maximum number of records or documents to delete.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of records or documents to delete.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  TableDelete object.


id: TableDelete::orderby
type: function
doc:
<comment>Description:</comment>
  Set delete sort criteria
  
  Set the order options for a result set.

<comment>Param:</comment>
  <info>string</info>  <strong>$orderby_expr</strong>  The sort definition.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  A TableDelete object.


id: TableDelete::where
type: function
doc:
<comment>Description:</comment>
  Set delete search condition
  
  Sets the search condition to filter.

<comment>Param:</comment>
  <info>string</info>  <strong>$where_expr</strong>  Define the search condition to filter documents or records.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  TableDelete object.


id: TableInsert::__construct
type: function
doc:
<comment>Description:</comment>
  TableInsert constructor
  
  Initiated by using the insert() method.


id: TableInsert::execute
type: function
doc:
<comment>Description:</comment>
  Execute insert query
  
  Execute the statement.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  A Result object.


id: TableInsert::values
type: function
doc:
<comment>Description:</comment>
  Add insert row values
  
  Set the values to be inserted.

<comment>Param:</comment>
  <info>array</info>  <strong>$row_values</strong>  Values (an array) of columns to insert.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableInsert</info>  A TableInsert object.


id: TableSelect::__construct
type: function
doc:
<comment>Description:</comment>
  TableSelect constructor
  
  An object returned by the select() method; use execute() to  execute the query.


id: TableSelect::bind
type: function
doc:
<comment>Description:</comment>
  Bind select query parameters
  
  Binds a value to a specific placeholder.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  The name of the placeholder, and the value to bind.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableSelect::execute
type: function
doc:
<comment>Description:</comment>
  Execute select statement
  
  Execute the select statement by chaining it with the execute() method.

<comment>Return:</comment>
  <info>mysql_xdevapi\RowResult</info>  A RowResult object.


id: TableSelect::groupBy
type: function
doc:
<comment>Description:</comment>
  Set select grouping criteria
  
  Sets a grouping criteria for the result set.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$sort_expr</strong>  The grouping criteria.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableSelect::having
type: function
doc:
<comment>Description:</comment>
  Set select having condition
  
  Sets a condition for records to consider in aggregate function operations.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  A condition on the aggregate functions used on the grouping criteria.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableSelect::limit
type: function
doc:
<comment>Description:</comment>
  Limit selected rows
  
  Sets the maximum number of records or documents to return.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of records or documents.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableSelect::lockExclusive
type: function
doc:
<comment>Description:</comment>
  Execute EXCLUSIVE LOCK
  
  Execute a read operation with EXCLUSIVE LOCK. Only one lock can be active at a time.

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  The optional waiting option that defaults to <info>MYSQLX_LOCK_DEFAULT</info>. Valid
                             values are:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  TableSelect object.


id: TableSelect::lockShared
type: function
doc:
<comment>Description:</comment>
  Execute SHARED LOCK
  
  Execute a read operation with SHARED LOCK. Only one lock can be active at a time.

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  The optional waiting option that defaults to <info>MYSQLX_LOCK_DEFAULT</info>.
                             Valid values are:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableSelect::offset
type: function
doc:
<comment>Description:</comment>
  Set limit offset
  
  Skip given number of rows in result.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  The limit offset.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableSelect::orderby
type: function
doc:
<comment>Description:</comment>
  Set select sort criteria
  
  Sets the order by criteria.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$sort_expr</strong>   The expressions that define the order by criteria. Can be an array with one or
                      more expressions, or a string.
  <info>mixed</info>  <strong>$sort_exprs</strong>  Additional sort_expr parameters.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableSelect::where
type: function
doc:
<comment>Description:</comment>
  Set select search condition
  
  Sets the search condition to filter.

<comment>Param:</comment>
  <info>string</info>  <strong>$where_expr</strong>  Define the search condition to filter documents or records.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableUpdate::__construct
type: function
doc:
<comment>Description:</comment>
  TableUpdate constructor
  
  Initiated by using the update() method.


id: TableUpdate::bind
type: function
doc:
<comment>Description:</comment>
  Bind update query parameters
  
  Binds a value to a specific placeholder.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  The name of the placeholder, and the value to bind, defined as a JSON
                              array.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  A TableUpdate object.


id: TableUpdate::execute
type: function
doc:
<comment>Description:</comment>
  Execute update query
  
  Executes the update statement.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  A TableUpdate object.


id: TableUpdate::limit
type: function
doc:
<comment>Description:</comment>
  Limit update row count
  
  Set the maximum number of records or documents update.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of records or documents to update.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  A TableUpdate object.


id: TableUpdate::orderby
type: function
doc:
<comment>Description:</comment>
  Set sorting criteria
  
  Sets the sorting criteria.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$orderby_expr</strong>   The expressions that define the order by criteria. Can be an array with one
                         or more expressions, or a string.
  <info>mixed</info>  <strong>$orderby_exprs</strong>  Additional sort_expr parameters.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  TableUpdate object.


id: TableUpdate::set
type: function
doc:
<comment>Description:</comment>
  Add field to be updated
  
  Updates the column value on records in a table.

<comment>Param:</comment>
  <info>string</info>  <strong>$table_field</strong>            The column name to be updated.
  <info>string</info>  <strong>$expression_or_literal</strong>  The value to be set on the specified column.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  TableUpdate object.


id: TableUpdate::where
type: function
doc:
<comment>Description:</comment>
  Set search filter
  
  Set the search condition to filter.

<comment>Param:</comment>
  <info>string</info>  <strong>$where_expr</strong>  The search condition to filter documents or records.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  A TableUpdate object.


id: Thread
type: class
doc:
<comment>Description:</comment>
  When the start method of a Thread is invoked, the run method code will be executed in separate
  Thread, in parallel.
  
  After the run method is executed the Thread will exit immediately, it will be joined with the
  creating Thread at the appropriate time.
  
  Relying on the engine to determine when a Thread should join may cause undesirable behaviour; the
  programmer should be explicit, where possible.


id: Thread::getCreatorId
type: function
doc:
<comment>Description:</comment>
  Identification
  
  Will return the identity of the Thread that created the referenced Thread

<comment>Return:</comment>
  <info>int</info>  A numeric identity


id: Thread::getCurrentThread
type: function
doc:
<comment>Description:</comment>
  Identification
  
  Return a reference to the currently executing Thread

<comment>Return:</comment>
  <info>Thread</info>  An object representing the currently executing Thread


id: Thread::getCurrentThreadId
type: function
doc:
<comment>Description:</comment>
  Identification
  
  Will return the identity of the currently executing Thread

<comment>Return:</comment>
  <info>int</info>  A numeric identity


id: Thread::getThreadId
type: function
doc:
<comment>Description:</comment>
  Identification
  
  Will return the identity of the referenced Thread

<comment>Return:</comment>
  <info>int</info>  A numeric identity


id: Thread::isJoined
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Tell if the referenced Thread has been joined

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Thread::isStarted
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Tell if the referenced Thread was started

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Thread::join
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Causes the calling context to wait for the referenced Thread to finish executing

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Thread::start
type: function
doc:
<comment>Description:</comment>
  Execution
  
  Will start a new Thread to execute the implemented run method

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  An optional mask of inheritance constants, by default PTHREADS_INHERIT_ALL

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Threaded
type: class
doc:
<comment>Description:</comment>
  Threaded objects form the basis of pthreads ability to execute user code in parallel; they expose
  synchronization methods and various useful interfaces.
  
  Threaded objects, most importantly, provide implicit safety for the programmer; all operations on
  the object scope are safe.


id: Threaded::chunk
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Fetches a chunk of the objects property table of the given size, optionally preserving keys

<comment>Param:</comment>
  <info>int</info>   <strong>$size</strong>      The number of items to fetch
  <info>bool</info>  <strong>$preserve</strong>  Preserve the keys of members, by default false

<comment>Return:</comment>
  <info>array</info>  An array of items from the objects property table


id: Threaded::count
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Returns the number of properties for this object

<comment>Return:</comment>
  <info>int</info>  


id: Threaded::extend
type: function
doc:
<comment>Description:</comment>
  Runtime Manipulation
  
  Makes thread safe standard class at runtime

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  The class to extend

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Threaded::isRunning
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Tell if the referenced object is executing

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of state  A object is considered running while executing the run method 
        
        A object is considered running while executing the run method


id: Threaded::isTerminated
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Tell if the referenced object was terminated during execution; suffered fatal errors, or threw
  uncaught exceptions

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of state


id: Threaded::merge
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Merges data into the current object

<comment>Param:</comment>
  <info>mixed</info>  <strong>$from</strong>       The data to merge
  <info>bool</info>   <strong>$overwrite</strong>  Overwrite existing keys, by default true

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Threaded::notify
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Send notification to the referenced object

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Threaded::notifyOne
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Send notification to the referenced object. This unblocks at least one of the blocked threads (as
  opposed to unblocking all of them, as seen with Threaded::notify).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Threaded::pop
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Pops an item from the objects property table

<comment>Return:</comment>
  <info>bool</info>  The last item from the objects property table


id: Threaded::run
type: function
doc:
<comment>Description:</comment>
  Execution
  
  The programmer should always implement the run method for objects that are intended for execution.

<comment>Return:</comment>
  <info>void</info>  The methods return value, if used, will be ignored


id: Threaded::shift
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Shifts an item from the objects property table

<comment>Return:</comment>
  <info>mixed</info>  The first item from the objects property table


id: Threaded::synchronized
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Executes the block while retaining the referenced objects synchronization lock for the calling
  context

<comment>Param:</comment>
  <info>Closure</info>  <strong>$block</strong>  The block of code to execute
  <info>mixed</info>    <strong>$args</strong>   Variable length list of arguments to use as function arguments to the block

<comment>Return:</comment>
  <info>mixed</info>  The return value from the block


id: Threaded::wait
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Will cause the calling context to wait for notification from the referenced object

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  An optional timeout in microseconds

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: Throwable
type: class
doc:
<comment>Description:</comment>
  <class>Throwable</class> é a interface base para qualquer objeto lançável usando a declaração <return>throw</return>, incluindo as
  classes <class>Error</class> e <class>Exception</class>.
  
  Classes do PHP não podem implementar a interface <class>Throwable</class> diretamente, e devem, ao invés,
  estender a classe <class>Exception</class>.


id: Throwable::__toString
type: function
doc:
<comment>Description:</comment>
  Obtém uma representação em string do objeto disparado

<comment>Return:</comment>
  <info>string</info>  Retornta a representação em <info>string</info> do objeto disparado.

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


id: Throwable::getCode
type: function
doc:
<comment>Description:</comment>
  Obtém o código da exceção
  
  Retorna o código de erro associado com o objeto de exceção disparado.

<comment>Return:</comment>
  <info>int</info>  Retorna o código de exceção como <info>int</info> na classe <class>Exception</class> mas possivelmente como outro tipo em
       descendentes de <class>Exception</class> (por exemplo como <info>string</info> em <class>PDOException</class>).

<comment>See Also:</comment>
   * Exception::getCode


id: Throwable::getFile
type: function
doc:
<comment>Description:</comment>
  Obtém o arquivo no qual o objeto foi criado
  
  Obtém o nome do arquivo no qual o objeto disparado foi criado.

<comment>Return:</comment>
  <info>string</info>  Obtém o nome do arquivo no qual o objeto disparado foi criado.

<comment>See Also:</comment>
   * Exception::getFile


id: Throwable::getLine
type: function
doc:
<comment>Description:</comment>
  Obtém a linha na qual o objeto foi instanciado
  
  Retorna o número da linha onde o objeto disparado foi instanciado.

<comment>Return:</comment>
  <info>int</info>  Retorna o número da linha onde o objeto disparado foi instanciado.

<comment>See Also:</comment>
   * Exception::getLine


id: Throwable::getMessage
type: function
doc:
<comment>Description:</comment>
  Obtém a mensagem
  
  Retorna a mensagem associada com o objeto disparado.

<comment>Return:</comment>
  <info>string</info>  Retorna a mensagem associada com o objeto disparado.

<comment>See Also:</comment>
   * Exception::getMessage


id: Throwable::getPrevious
type: function
doc:
<comment>Description:</comment>
  Retorna o Throwable anterior
  
  Retorna qualquer Throwable anterior (por exemplo, aquele fornecido como o terceiro parâmetro para
  Exception::__construct).

<comment>Return:</comment>
  <info>Throwable|null</info>  Retorna o <class>Throwable</class> anterior se disponível, ou <info>null</info> caso contrário.

<comment>See Also:</comment>
   * Exception::getPrevious


id: Throwable::getTrace
type: function
doc:
<comment>Description:</comment>
  Obtém o rastreamento de pilha
  
  Obtém o rastreamento de pilha como um <info>array</info>.

<comment>Return:</comment>
  <info>array</info>  Retorna o rastreamento de pilha como um <info>array</info> no mesmo formato de <strong>debug_backtrace()</strong>.

<comment>See Also:</comment>
   * Exception::getTrace


id: Throwable::getTraceAsString
type: function
doc:
<comment>Description:</comment>
  Obtém o rastreamento de pilha como uma string

<comment>Return:</comment>
  <info>string</info>  Retorna o rastreamento de pilha como uma string.

<comment>See Also:</comment>
   * Exception::getTraceAsString


id: Transliterator::__construct
type: function
doc:
<comment>Description:</comment>
  Private constructor to deny instantiation
  
  This method should not be called. Its only purpose is to deny instantiation with the new operator.
  
  Use the factory methods Transliterator::create or Transliterator::createFromRules instead.

<comment>See Also:</comment>
   * Transliterator::create
   * Transliterator::createFromRules


id: Transliterator::create
type: function
doc:
<comment>Description:</comment>
  Create a transliterator
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Opens a Transliterator by ID.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>         The ID. A list of all registered transliterator IDs can be retrieved by using
                      Transliterator::listIDs.
  <info>int</info>     <strong>$direction</strong>  The direction, defaults to  Transliterator::FORWARD. May also be set to
                      Transliterator::REVERSE.

<comment>Return:</comment>
  <info>Transliterator|null</info>  Returns a <class>Transliterator</class> object on success, or <info>null</info> on failure.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::__construct


id: Transliterator::createFromRules
type: function
doc:
<comment>Description:</comment>
  Create transliterator from rules
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Creates a Transliterator from rules.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$rules</strong>      The rules as defined in Transform Rules Syntax of UTS #35: Unicode LDML.
  <info>int</info>     <strong>$direction</strong>  The direction, defaults to  Transliterator::FORWARD. May also be set to
                      Transliterator::REVERSE.

<comment>Return:</comment>
  <info>Transliterator|null</info>  Returns a <class>Transliterator</class> object on success, or <info>null</info> on failure.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::create


id: Transliterator::createInverse
type: function
doc:
<comment>Description:</comment>
  Create an inverse transliterator
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Opens the inverse transliterator.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>Transliterator|null</info>  Returns a <class>Transliterator</class> object on success, or <info>null</info> on failure

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::create


id: Transliterator::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Get last error code
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Gets the last error code for this transliterator.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Transliterator</info>  <strong>$transliterator</strong>  

<comment>Return:</comment>
  <info>int|false</info>  The error code on success, or <info>false</info> if none exists, or on failure.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::listIDs


id: Transliterator::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Get last error message
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Gets the last error message for this transliterator.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Transliterator</info>  <strong>$transliterator</strong>  

<comment>Return:</comment>
  <info>string|false</info>  The error message on success, or <info>false</info> if none exists, or on failure.

<comment>See Also:</comment>
   * Transliterator::getErrorCode
   * Transliterator::listIDs


id: Transliterator::listIDs
type: function
doc:
<comment>Description:</comment>
  Get transliterator IDs
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Returns an array with the registered transliterator IDs.

<comment>Return:</comment>
  <info>array|false</info>  An <info>array</info> of registered transliterator IDs on success, ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::transliterate


id: Transliterator::transliterate
type: function
doc:
<comment>Description:</comment>
  Transliterate a string
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Transforms a string or part thereof using an ICU transliterator.

<comment>Param:</comment>
  <info>Transliterator|string</info>  <strong>$transliterator</strong>  In the procedural version, either a <class>Transliterator</class> or a
                                          <info>string</info> from which a <class>Transliterator</class> can be built.
  <info>string</info>                 <strong>$string</strong>          The string to be transformed.
  <info>int</info>                    <strong>$start</strong>           The start index (in UTF-16 code units) from which the
                                          string will start to be transformed, inclusive. Indexing
                                          starts at 0. The text before will be left as is.
  <info>int</info>                    <strong>$end</strong>             The end index (in UTF-16 code units) until which the
                                          string will be transformed, exclusive. Indexing starts at
                                          0. The text after will be left as is.

<comment>Return:</comment>
  <info>string|false</info>  The transformed string on success,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::__construct


id: Traversable
type: class
doc:
<comment>Description:</comment>
  Interface para detectar se uma classe é percorrível utilizando o foreach.
  
  Interface básica abstrata que não pode ser implementada sozinha. Ao invés, deve ser implementada
  as interfaces IteratorAggregate ou Iterator.


id: UConverter::__construct
type: function
doc:
<comment>Description:</comment>
  Cria um objeto UConverter
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$destination_encoding</strong>  
  <info>string|null</info>  <strong>$source_encoding</strong>       


id: UConverter::convert
type: function
doc:
<comment>Description:</comment>
  Converte uma string de um conjunto de caracteres (charset) para outro
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>      
  <info>bool</info>    <strong>$reverse</strong>  

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


id: UConverter::fromUCallback
type: function
doc:
<comment>Description:</comment>
  Função de retorno de origem padrão
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>    <strong>$reason</strong>     
  <info>array</info>  <strong>$source</strong>     
  <info>int</info>    <strong>$codePoint</strong>  
  <info>int</info>    <strong>$error</strong>      

<comment>Return:</comment>
  <info>string|int|array|null</info>  


id: UConverter::getAliases
type: function
doc:
<comment>Description:</comment>
  Obtém o pseudônimo de um nome
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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

<comment>Return:</comment>
  <info>array|false|null</info>  


id: UConverter::getAvailable
type: function
doc:
<comment>Description:</comment>
  Obtém os nomes canônicos dos conversores disponíveis
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>array</info>  


id: UConverter::getDestinationEncoding
type: function
doc:
<comment>Description:</comment>
  Obtém a codificação de destino
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>string|false|null</info>  


id: UConverter::getDestinationType
type: function
doc:
<comment>Description:</comment>
  Obtém o tipo do conversor de destino
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int|false|null</info>  


id: UConverter::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Obtém o código do último erro gerado pelo objeto
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  


id: UConverter::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Obtém a mensagem do último erro gerado pelo objeto
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: UConverter::getSourceEncoding
type: function
doc:
<comment>Description:</comment>
  Obtém a codificação de origem
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>string|false|null</info>  


id: UConverter::getSourceType
type: function
doc:
<comment>Description:</comment>
  Obtém o tipo do conversor de origem
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int|false|null</info>  


id: UConverter::getStandards
type: function
doc:
<comment>Description:</comment>
  Obtém os nomes dos conversores padrão associados
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>array|null</info>  


id: UConverter::getSubstChars
type: function
doc:
<comment>Description:</comment>
  Obtém os caracteres de substituição
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>string|false|null</info>  


