# php_manual

id: soundex
type: function
doc:
<comment>Description:</comment>
  Calcula a chave soundex de uma string
  
  Calcula a chave soundex de <strong>$string</strong>.
  
  Chaves soundex têm a propriedade de que palavras pronunciadas de forma semelhante produzem a mesma
  chave soundex e podem, portanto, ser usadas para simplificar pesquisas em bancos de dados onde a
  pronúncia é conhecida mas não a soletração.
  
  Esta função soundex em particular é a descrita por Donald Knuth em "The Art Of Computer
  Programming, vol. 3: Sorting And Searching", Addison-Wesley (1973), pp. 391-392.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string de entrada.

<comment>Return:</comment>
  <info>string</info>  Retorna a chave soundex como uma <info>string</info> com quatro caracteres. Se pelo menos uma letra
          estiver contida na <strong>$string</strong>, a string retornada começa com uma letra. Caso contrário,
          <return>"0000"</return> é retornado.

<comment>See Also:</comment>
   * <strong>levenshtein()</strong>
   * <strong>metaphone()</strong>
   * <strong>similar_text()</strong>


id: spl_autoload
type: function
doc:
<comment>Description:</comment>
  Default implementation for __autoload()
  
  This function is intended to be used as a default implementation for <strong>__autoload()</strong>. If nothing else
  is specified and <strong>spl_autoload_register()</strong> is called without any parameters then this function will
  be used for any later call to <strong>__autoload()</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$class</strong>            The name of the class (and namespace) being instantiated.
  <info>string|null</info>  <strong>$file_extensions</strong>  By default it checks all include paths to contain filenames built
                                 up by the lowercase class name appended by the filename extensions
                                 .inc and .php.

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


id: spl_autoload_call
type: function
doc:
<comment>Description:</comment>
  Tenta todas as funções __autoload() registradas para carregar a classe solicitada
  
  Esta função pode ser usada para procurar manualmente por uma classe ou interface usando as funções
  __autoload registradas.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  O nome da classe sendo procurada.

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


id: spl_autoload_extensions
type: function
doc:
<comment>Description:</comment>
  Register and return default file extensions for spl_autoload
  
  This function can modify and check the file extensions that the built in <strong>__autoload()</strong> fallback
  function <strong>spl_autoload()</strong>  will be using.
  
  There should not be a space between the defined file extensions.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$file_extensions</strong>  If <info>null</info>, it simply returns the current list of extensions each
                                 separated by comma. To modify the list of file extensions, simply
                                 invoke the functions with the new list of file extensions to use in
                                 a single string with each extensions separated by comma.

<comment>Return:</comment>
  <info>string</info>  A comma delimited list of default file extensions for <strong>spl_autoload()</strong>.


id: spl_autoload_functions
type: function
doc:
<comment>Description:</comment>
  Return all registered __autoload() functions
  
  Get all registered __autoload() functions.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of all registered __autoload functions. If no function is registered, or the
         autoload queue is not activated, then the return value will be an empty array.


id: spl_autoload_register
type: function
doc:
<comment>Description:</comment>
  Register given function as __autoload() implementation
  
  Register a function with the spl provided __autoload queue. If the queue is not yet activated it
  will be activated.
  
  If your code has an existing <strong>__autoload()</strong> function then this function must be explicitly
  registered on the __autoload queue. This is because <strong>spl_autoload_register()</strong> will effectively
  replace the engine cache for the <strong>__autoload()</strong> function by either <strong>spl_autoload()</strong> or
  <strong>spl_autoload_call()</strong>.
  
  If there must be multiple autoload functions, <strong>spl_autoload_register()</strong>  allows for this. It
  effectively creates a queue of autoload functions, and runs through each of them in the order they
  are defined. By contrast,  <strong>__autoload()</strong> may only be defined once.

<comment>Param:</comment>
  <info>callable|null</info>  <strong>$callback</strong>  The autoload function being registered. If <info>null</info>, then the default
                            implementation of <strong>spl_autoload()</strong> will be registered.
                            
                            The <strong>$class</strong> will not contain the leading backslash of a fully-qualified
                            identifier.
  <info>bool</info>           <strong>$throw</strong>     This parameter specifies whether <strong>spl_autoload_register()</strong> should throw
                            exceptions when the <strong>$callback</strong> cannot be registered.
                            
                            This parameter is ignored as of PHP 8.0.0, and a notice will be emitted
                            if set to <info>false</info>. <strong>spl_autoload_register()</strong> will now always throw a
                            <class>TypeError</class> on invalid arguments.
  <info>bool</info>           <strong>$prepend</strong>   If true, <strong>spl_autoload_register()</strong> will prepend the autoloader on the
                            autoload queue instead of appending it.

<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>__autoload()</strong>


id: spl_autoload_unregister
type: function
doc:
<comment>Description:</comment>
  Unregister given function as __autoload() implementation
  
  Removes a function from the autoload queue. If the queue is activated and empty after removing the
  given function then it will be deactivated.
  
  When this function results in the queue being deactivated, any __autoload function that previously
  existed will not be reactivated.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The autoload function being unregistered.

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


id: spl_classes
type: function
doc:
<comment>Description:</comment>
  Retorna as classes da SPL disponíveis
  
  Esta função retorna um array com as classes da SPL disponíveis atualmente.

<comment>Return:</comment>
  <info>array</info>  Retorna um <info>array</info> contendo as classes SPL disponíveis.


id: spl_object_hash
type: function
doc:
<comment>Description:</comment>
  Return hash id for given object
    
  
  This function returns a unique identifier for the object. This id can be used as a hash key for
  storing objects, or for identifying an object, as long as the object is not destroyed. Once the
  object is destroyed, its hash may  be reused for other objects. This behavior is similar to
  <strong>spl_object_id()</strong>.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Any object.

<comment>Return:</comment>
  <info>string</info>  A string that is unique for each currently existing object and is always the same for each
          object.

<comment>See Also:</comment>
   * <strong>spl_object_id()</strong>


id: spl_object_id
type: function
doc:
<comment>Description:</comment>
  Return the integer object handle for given object
    
  
  This function returns a unique identifier for the object. The object id is unique for the lifetime
  of the object. Once the object is destroyed, its id may be reused for other objects. This behavior
  is similar to <strong>spl_object_hash()</strong>.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Any object.

<comment>Return:</comment>
  <info>int</info>  An integer identifier that is unique for each currently existing object and is always the
       same for each object.


id: sprintf
type: function
doc:
<comment>Description:</comment>
  Return a formatted string
  
  Returns a string produced according to the formatting string <strong>$format</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  A string de formato é composta de zero ou mais diretivas: caracteres comuns
                   (excluindo <return>%</return>) que são copiados diretamente para o resultado e especificações de
                   conversão, cada uma das quais resulta na busca de seu próprio parâmetro.
                   
                   Uma especificação de conversão segue este protótipo:
                   <return>%[argnum$][flags][width][.precision]especificador</return>.
                   
                   Um número inteiro seguido por um cifrão <return>$</return>, para especificar qual o número de
                   argumento a tratar na conversão.
                   
                   FlagsFlagDescrição<return>-</return> Justificar à esquerda dentro da largura de campo
                   especificada; A justificação à direita é o padrão. <return>+</return> Prefixa números positivos
                   com um sinal de mais <return>+</return>; Por padrão, apenas números negativos são prefixados com
                   um sinal negativo. <return> </return>(espaço) Preenche o resultado com espaços. Este é o padrão. <return>0</return>
                   Preenche números com zeros apenas à esquerda. Com os especificadores <return>s</return>, também
                   pode preencher com zeros à direita. <return>'</return>(char) Preenche o resultado com o caractere
                   (char).
                   
                   Um número inteiro que define em quantos caracteres (mínimo) esta conversão deve
                   resultar, ou <return>*</return>. Se <return>*</return> for usado, a largura será fornecida como um valor inteiro
                   adicional precedendo aquele formatado pelo especificador.
                   
                   Um ponto <return>.</return> opcionalmente seguido por um número inteiro ou <return>*</return>, cujo significado
                   depende do especificador:  Para os especificadores <return>e</return>, <return>E</return>, <return>f</return> e <return>F</return>: este é o número
                   de dígitos a serem impressos após o ponto decimal (por padrão, é 6).  Para os
                   especificadores <return>g</return>, <return>G</return>, <return>h</return> e <return>H</return>: este é o número máximo de dígitos significativos a
                   serem impressos.  Para o especificador <return>s</return>: atua como um ponto de corte, definindo
                   um limite máximo de caracteres para a string.   Se o ponto for especificado sem
                   um valor explícito para precisão, 0 é assumido. Se <return>*</return> for usado, a precisão é
                   fornecida como um valor inteiro adicional precedendo aquele formatado pelo
                   especificador.
                   
                   Para os especificadores <return>e</return>, <return>E</return>, <return>f</return> e <return>F</return>: este é o número de dígitos a serem impressos
                   após o ponto decimal (por padrão, é 6).
                   
                   Para os especificadores <return>g</return>, <return>G</return>, <return>h</return> e <return>H</return>: este é o número máximo de dígitos
                   significativos a serem impressos.
                   
                   Para o especificador <return>s</return>: atua como um ponto de corte, definindo um limite máximo
                   de caracteres para a string.
                   
                   Se o ponto for especificado sem um valor explícito para precisão, 0 é assumido.
                   Se <return>*</return> for usado, a precisão é fornecida como um valor inteiro adicional precedendo
                   aquele formatado pelo especificador.
                   
                   EspecificadoresEspecificadorDescrição<return>%</return> Um caractere literal de porcentagem.
                   Nenhum argumento é necessário. <return>b</return> O argumento é tratado como um número inteiro e
                   apresentado como um número binário. <return>c</return> O argumento é tratado como um número
                   inteiro e apresentado como o caractere com aquele código ASCII. <return>d</return> O argumento é
                   tratado como um número inteiro e apresentado como um número decimal (com sinal).
                   <return>e</return> O argumento é tratado como notação científica (por exemplo, 1.2e+2). <return>E</return> Como o
                   especificador <return>e</return>, mas usa letra maiúscula (por exemplo, 1.2E+2). <return>f</return> O argumento é
                   tratado como um float e apresentado como um número de ponto flutuante (com
                   reconhecimento da localidade). <return>F</return> O argumento é tratado como um float e
                   apresentado como um número de ponto flutuante (sem reconhecimento da localidade).
                   <return>g</return> Formato geral.  Deixa P igual à precisão se for diferente de zero, 6 se a
                   precisão for omitida, ou 1 se a precisão for zero. Então, se uma conversão com
                   estilo E tivesse um expoente de X:  Se P &gt; X ≥ −4, a conversão é com estilo f
                   e precisão P − (X + 1). Caso contrário, a conversão é com estilo e e precisão P −
                   1. <return>G</return> Como o especificador <return>g</return>, mas usa <return>E</return> e <return>f</return>. <return>h</return> Como o especificador <return>g</return>, mas usa <return>F</return>.
                   Disponível a partir do PHP 8.0.0. <return>H</return> Como o especificador <return>g</return>, mas usa <return>E</return> e <return>F</return>.
                   Disponível a partir do PHP 8.0.0. <return>o</return> O argumento é tratado como um número inteiro
                   e apresentado como um número octal. <return>s</return> O argumento é tratado e apresentado como
                   uma string. <return>u</return> O argumento é tratado como um número inteiro e apresentado como um
                   número decimal sem sinal. <return>x</return> O argumento é tratado como um número inteiro e
                   apresentado como um número hexadecimal (com letras minúsculas). <return>X</return> O argumento é
                   tratado como um número inteiro e apresentado como um número hexadecimal (com
                   letras maiúsculas).
                   
                   Formato geral.
                   
                   Deixa P igual à precisão se for diferente de zero, 6 se a precisão for omitida,
                   ou 1 se a precisão for zero. Então, se uma conversão com estilo E tivesse um
                   expoente de X:
                   
                   Se P &gt; X ≥ −4, a conversão é com estilo f e precisão P − (X + 1). Caso
                   contrário, a conversão é com estilo e e precisão P − 1.
                   
                   O especificador de tipo <return>c</return> ignora preenchimento e largura.
                   
                   Tentar usar uma combinação dos especificadores de string e largura com conjuntos
                   de caracteres que requerem mais de um byte por caractere pode resultar em
                   resultados inesperados.
                   
                   As variáveis serão forçadas a um tipo adequado para o especificador: Tratamento
                   de TiposTipoEspecificadores<info>string</info><return>s</return><info>int</info><return>d</return>, <return>u</return>, <return>c</return>, <return>o</return>, <return>x</return>, <return>X</return>, <return>b</return><info>float</info><return>e</return>, <return>E</return>, <return>f</return>, <return>F</return>, <return>g</return>, <return>G</return>, <return>h</return>,
                   <return>H</return>
  <info>mixed</info>   <strong>$values</strong>  

<comment>Return:</comment>
  <info>string</info>  Returns a string produced according to the formatting string <strong>$format</strong>.

<comment>See Also:</comment>
   * <strong>printf()</strong>
   * <strong>fprintf()</strong>
   * <strong>vprintf()</strong>
   * <strong>vsprintf()</strong>
   * <strong>vfprintf()</strong>
   * <strong>sscanf()</strong>
   * <strong>fscanf()</strong>
   * <strong>number_format()</strong>
   * <strong>date()</strong>


id: sqlsrv_begin_transaction
type: function
doc:
<comment>Description:</comment>
  Begins a database transaction
  
  The transaction begun by <strong>sqlsrv_begin_transaction()</strong> includes  all statements that were executed
  after the call to  <strong>sqlsrv_begin_transaction()</strong> and before calls to  <strong>sqlsrv_rollback()</strong> or
  <strong>sqlsrv_commit()</strong>.  Explicit transactions should be started and committed or rolled back using
  these functions instead of executing SQL statements that begin and commit/roll  back transactions.
  For more information, see  SQLSRV Transactions.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn</strong>  The connection resource returned by a call to <strong>sqlsrv_connect()</strong>.

<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>sqlsrv_commit()</strong>
   * <strong>sqlsrv_rollback()</strong>


id: sqlsrv_cancel
type: function
doc:
<comment>Description:</comment>
  Cancels a statement
  
  Cancels a statement. Any results associated with the statement that have not  been consumed are
  deleted. After <strong>sqlsrv_cancel()</strong> has been  called, the specified statement can be re-executed if it
  was created with  <strong>sqlsrv_prepare()</strong>. Calling <strong>sqlsrv_cancel()</strong>  is not necessary if all the results
  associated with the statement have been  consumed.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>  The statement resource to be cancelled.

<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>sqlsrv_free_stmt()</strong>
   * <strong>sqlsrv_prepare()</strong>


id: sqlsrv_client_info
type: function
doc:
<comment>Description:</comment>
  Returns information about the client and specified connection
  
  Returns information about the client and specified connection

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn</strong>  The connection about which information is returned.

<comment>Return:</comment>
  <info>array</info>  Returns an associative array with keys described in the table below.  Returns <info>false</info>
         otherwise.  Array returned by
         sqlsrv_client_infoKeyDescriptionDriverDllNameSQLNCLI10.DLLDriverODBCVerODBC version
         (xx.yy)DriverVerSQL Server Native Client DLL version (10.5.xxx)ExtensionVerphp_sqlsrv.dll
         version (2.0.xxx.x)

<comment>See Also:</comment>
   * <strong>sqlsrv_server_info()</strong>


id: sqlsrv_close
type: function
doc:
<comment>Description:</comment>
  Closes an open connection and releases resourses associated with the connection
  
  Closes an open connection and releases resourses associated with the connection.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn</strong>  The connection to be closed.

<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>sqlsrv_connect()</strong>


id: sqlsrv_commit
type: function
doc:
<comment>Description:</comment>
  Commits a transaction that was begun with sqlsrv_begin_transaction
  
  Commits a transaction that was begun with <strong>sqlsrv_begin_transaction()</strong>.  The connection is returned
  to auto-commit mode after <strong>sqlsrv_commit()</strong>  is called. The transaction that is committed includes
  all statements that were  executed after the call to <strong>sqlsrv_begin_transaction()</strong>.  Explicit
  transactions should be started and committed or rolled back using these  functions instead of
  executing SQL statements that begin and commit/roll back  transactions. For more information, see
  SQLSRV Transactions.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn</strong>  The connection on which the transaction is to be committed.

<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>sqlsrv_begin_transaction()</strong>
   * <strong>sqlsrv_rollback()</strong>


id: sqlsrv_configure
type: function
doc:
<comment>Description:</comment>
  Changes the driver error handling and logging configurations
  
  Changes the driver error handling and logging configurations.

<comment>Param:</comment>
  <info>string</info>  <strong>$setting</strong>  The name of the setting to set. The possible values are
                    "WarningsReturnAsErrors", "LogSubsystems", and "LogSeverity".
  <info>mixed</info>   <strong>$value</strong>    The value of the specified setting. The following table shows possible values:
                    Error and Logging Setting OptionsSettingOptionsWarningsReturnAsErrors1 (<info>true</info>) or
                    0 (<info>false</info>)LogSubsystemsSQLSRV_LOG_SYSTEM_ALL (-1)  SQLSRV_LOG_SYSTEM_CONN (2)
                    SQLSRV_LOG_SYSTEM_INIT (1)  SQLSRV_LOG_SYSTEM_OFF (0)  SQLSRV_LOG_SYSTEM_STMT
                    (4)  SQLSRV_LOG_SYSTEM_UTIL (8)LogSeveritySQLSRV_LOG_SEVERITY_ALL (-1)
                    SQLSRV_LOG_SEVERITY_ERROR (1)  SQLSRV_LOG_SEVERITY_NOTICE (4)
                    SQLSRV_LOG_SEVERITY_WARNING (2)

<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>
   * SQLSRV Error Handling.
   * Logging SQLSRV Activity.


id: sqlsrv_connect
type: function
doc:
<comment>Description:</comment>
  Opens a connection to a Microsoft SQL Server database
  
  Opens a connection to a Microsoft SQL Server database. By default, the connection  is attempted
  using Windows Authentication. To connect using SQL Server  Authentication, include "UID" and "PWD"
  in the connection options array.

<comment>Param:</comment>
  <info>string</info>  <strong>$serverName</strong>      The name of the server to which a connection is established. To connect
                           to a specific instance, follow the server name with a backward slash  and
                           the instance name (e.g. serverName\sqlexpress).
  <info>array</info>   <strong>$connectionInfo</strong>  An associative array that specifies options for connecting to the server.
                           If values for the UID and PWD keys are not specified, the connection
                           will be attempted using Windows Authentication. For a complete list of
                           supported  keys, see SQLSRV Connection Options.

<comment>Return:</comment>
  <info>resource</info>  A connection resource. If a connection cannot be successfully opened, <info>false</info> is returned.

<comment>See Also:</comment>
   * <strong>sqlsrv_close()</strong>
   * <strong>sqlsrv_errors()</strong>
   * <strong>sqlsrv_query()</strong>


id: sqlsrv_errors
type: function
doc:
<comment>Description:</comment>
  Returns error and warning information about the last SQLSRV operation performed
  
  Returns error and warning information about the last SQLSRV operation performed.

<comment>Param:</comment>
  <info>int</info>  <strong>$errorsOrWarnings</strong>  Determines whether error information, warning information, or both are
                          returned. If this parameter is not supplied, both error information and
                          warning information are returned. The following are the supported values
                          for this parameter: SQLSRV_ERR_ALL, SQLSRV_ERR_ERRORS,
                          SQLSRV_ERR_WARNINGS.

<comment>Return:</comment>
  <info>mixed</info>  If errors and/or warnings occurred on the last sqlsrv operation, an array of  arrays
         containing error information is returned. If no errors and/or warnings  occurred on the
         last sqlsrv operation, <info>null</info> is returned. The following table  describes the structure of
         the returned arrays: Array returned by sqlsrv_errorsKeyDescriptionSQLSTATEFor errors that
         originate from the ODBC driver, the SQLSTATE returned  by ODBC. For errors that originate
         from the Microsoft Drivers for PHP for  SQL Server, a SQLSTATE of IMSSP. For warnings that
         originate from the  Microsoft Drivers for PHP for SQL Server, a SQLSTATE of 01SSP. codeFor
         errors that originate from SQL Server, the native SQL Server  error code. For errors that
         originate from the ODBC driver, the error  code returned by ODBC. For errors that originate
         from the Microsoft Drivers  for PHP for SQL Server, the Microsoft Drivers for PHP for SQL
         Server error code. messageA description of the error.

<comment>See Also:</comment>
   * <strong>sqlsrv_configure()</strong>


id: sqlsrv_execute
type: function
doc:
<comment>Description:</comment>
  Executes a statement prepared with sqlsrv_prepare
  
  Executes a statement prepared with <strong>sqlsrv_prepare()</strong>. This  function is ideal for executing a
  prepared statement multiple times with  different parameter values.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>  A statement resource returned by <strong>sqlsrv_prepare()</strong>.

<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>sqlsrv_prepare()</strong>
   * <strong>sqlsrv_query()</strong>


id: sqlsrv_fetch
type: function
doc:
<comment>Description:</comment>
  Makes the next row in a result set available for reading
  
  Makes the next row in a result set available for reading. Use  <strong>sqlsrv_get_field()</strong> to read the
  fields of the row.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>    A statement resource created by executing <strong>sqlsrv_query()</strong>  or <strong>sqlsrv_execute()</strong>.
  <info>int</info>       <strong>$row</strong>     The row to be accessed. This parameter can only be used if the specified
                     statement was prepared with a scrollable cursor. In that case, this parameter
                     can take on one of the following values:
                     SQLSRV_SCROLL_NEXTSQLSRV_SCROLL_PRIORSQLSRV_SCROLL_FIRSTSQLSRV_SCROLL_LASTSQLSRV_SCROLL_ABSOLUTESQLSRV_SCROLL_RELATIVE
  <info>int</info>       <strong>$offset</strong>  Specifies the row to be accessed if the row parameter is set to
                     <info>SQLSRV_SCROLL_ABSOLUTE</info> or <info>SQLSRV_SCROLL_RELATIVE</info>. Note that the first row in a
                     result set has index 0.

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>true</info> if the next row of a result set was successfully retrieved,  <info>false</info> if an error
         occurs, and <info>null</info> if there are no more rows in the result set.

<comment>See Also:</comment>
   * <strong>sqlsrv_get_field()</strong>
   * <strong>sqlsrv_fetch_array()</strong>
   * <strong>sqlsrv_fetch_object()</strong>


id: sqlsrv_fetch_array
type: function
doc:
<comment>Description:</comment>
  Returns a row as an array
  
  Returns the next available row of data as an associative array, a numeric  array, or both (the
  default).

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>       A statement resource returned by sqlsrv_query or sqlsrv_prepare.
  <info>int</info>       <strong>$fetchType</strong>  A predefined constant specifying the type of array to return. Possible
                        values are <info>SQLSRV_FETCH_ASSOC</info>,  <info>SQLSRV_FETCH_NUMERIC</info>, and  <info>SQLSRV_FETCH_BOTH</info>
                        (the default).
                        
                        A fetch type of SQLSRV_FETCH_ASSOC should not be used when consuming a
                        result set with multiple columns of the same name.
  <info>int</info>       <strong>$row</strong>        Specifies the row to access in a result set that uses a scrollable cursor.
                        Possible values are <info>SQLSRV_SCROLL_NEXT</info>,  <info>SQLSRV_SCROLL_PRIOR</info>,
                        <info>SQLSRV_SCROLL_FIRST</info>,  <info>SQLSRV_SCROLL_LAST</info>, <info>SQLSRV_SCROLL_ABSOLUTE</info> and,
                        <info>SQLSRV_SCROLL_RELATIVE</info> (the default). When this parameter  is specified, the
                        <strong>$fetchType</strong> must be explicitly defined.
  <info>int</info>       <strong>$offset</strong>     Specifies the row to be accessed if the row parameter is set to
                        <info>SQLSRV_SCROLL_ABSOLUTE</info> or <info>SQLSRV_SCROLL_RELATIVE</info>. Note that the first row in
                        a result set has index 0.

<comment>Return:</comment>
  <info>array</info>  Returns an array on success, <info>null</info> if there are no more rows to return, and  <info>false</info> if an
         error occurs.

<comment>See Also:</comment>
   * <strong>sqlsrv_connect()</strong>
   * <strong>sqlsrv_query()</strong>
   * <strong>sqlsrv_errors()</strong>
   * <strong>sqlsrv_fetch()</strong>


id: sqlsrv_fetch_object
type: function
doc:
<comment>Description:</comment>
  Retrieves the next row of data in a result set as an object
  
  Retrieves the next row of data in a result set as an instance of the specified  class with
  properties that match the row field names and values that correspond  to the row field values.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>        A statement resource created by <strong>sqlsrv_query()</strong> or  <strong>sqlsrv_execute()</strong>.
  <info>string</info>    <strong>$className</strong>   The name of the class to instantiate. If no class name is specified,
                         stdClass is instantiated.
  <info>array</info>     <strong>$ctorParams</strong>  Values passed to the constructor of the specified class. If the constructor
                         of the specified class takes parameters, the ctorParams array must be
                         supplied.
  <info>int</info>       <strong>$row</strong>         The row to be accessed. This parameter can only be used if the specified
                         statement was prepared with a scrollable cursor. In that case, this
                         parameter  can take on one of the following values:
                         SQLSRV_SCROLL_NEXTSQLSRV_SCROLL_PRIORSQLSRV_SCROLL_FIRSTSQLSRV_SCROLL_LASTSQLSRV_SCROLL_ABSOLUTESQLSRV_SCROLL_RELATIVE
  <info>int</info>       <strong>$offset</strong>      Specifies the row to be accessed if the row parameter is set to
                         <info>SQLSRV_SCROLL_ABSOLUTE</info> or <info>SQLSRV_SCROLL_RELATIVE</info>. Note that the first row
                         in a result set has index 0.

<comment>Return:</comment>
  <info>mixed</info>  Returns an object on success, <info>null</info> if there are no more rows to return,  and <info>false</info> if an
         error occurs or if the specified class does not exist.

<comment>See Also:</comment>
   * <strong>sqlsrv_fetch()</strong>
   * <strong>sqlsrv_fetch_array()</strong>


id: sqlsrv_field_metadata
type: function
doc:
<comment>Description:</comment>
  Retrieves metadata for the fields of a statement prepared by 
    sqlsrv_prepare or sqlsrv_query
    
  
  Retrieves metadata for the fields of a statement prepared by  <strong>sqlsrv_prepare()</strong> or <strong>sqlsrv_query()</strong>.
  <strong>sqlsrv_field_metadata()</strong> can be called on a statement before  or after statement execution.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>  The statement resource for which metadata is returned.

<comment>Return:</comment>
  <info>mixed</info>  Returns an array of arrays on success. Otherwise, <info>false</info> is returned.  Each returned array
         is described by the following table: Array returned by
         sqlsrv_field_metadataKeyDescriptionNameThe name of the field.TypeThe numeric value for the
         SQL type.SizeThe number of characters for fields of character type, the number of  bytes
         for fields of binary type, or <info>null</info> for other types.PrecisionThe precision for types of
         variable precision, <info>null</info> for other types.ScaleThe scale for types of variable scale, <info>null</info>
         for other types.NullableAn enumeration indicating whether the column is nullable, not
         nullable,  or if it is not known. For more information, see sqlsrv_field_metadata  in the
         Microsoft SQLSRV documentation.

<comment>See Also:</comment>
   * <strong>sqlsrv_client_info()</strong>


id: sqlsrv_free_stmt
type: function
doc:
<comment>Description:</comment>
  Frees all resources for the specified statement
  
  Frees all resources for the specified statement. The statement cannot be used  after
  <strong>sqlsrv_free_stmt()</strong> has been called on it. If  <strong>sqlsrv_free_stmt()</strong> is called on an in-progress
  statement  that alters server state, statement execution is terminated and the statement  is
  rolled back.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>  The statement for which resources are freed.  Note that <info>null</info> is a valid parameter
                   value. This allows the function to be  called multiple times in a script.

<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>sqlsrv_cancel()</strong>


id: sqlsrv_get_config
type: function
doc:
<comment>Description:</comment>
  Returns the value of the specified configuration setting
  
  Returns the value of the specified configuration setting.

<comment>Param:</comment>
  <info>string</info>  <strong>$setting</strong>  The name of the setting for which the value is returned. For a list of
                    configurable settings, see <strong>sqlsrv_configure()</strong>.

<comment>Return:</comment>
  <info>mixed</info>  Returns the value of the specified setting. If an invalid setting is specified,  <info>false</info> is
         returned.

<comment>See Also:</comment>
   * <strong>sqlsrv_configure()</strong>


id: sqlsrv_get_field
type: function
doc:
<comment>Description:</comment>
  Gets field data from the currently selected row
  
  Gets field data from the currently selected row. Fields must be accessed in  order. Field indices
  start at 0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>        A statement resource returned by <strong>sqlsrv_query()</strong> or  <strong>sqlsrv_execute()</strong>.
  <info>int</info>       <strong>$fieldIndex</strong>  The index of the field to be retrieved. Field indices start at 0. Fields
                         must be accessed in order. i.e. If you access field index 1, then field
                         index 0 will not be available.
  <info>int</info>       <strong>$getAsType</strong>   The PHP data type for the returned field data. If this parameter is not
                         set, the field data will be returned as its default PHP data type. For
                         information about default PHP data types, see  Default PHP Data Types  in
                         the Microsoft SQLSRV documentation.

<comment>Return:</comment>
  <info>mixed</info>  Returns data from the specified field on success. Returns <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>sqlsrv_fetch()</strong>
   * <strong>sqlsrv_fetch_array()</strong>
   * <strong>sqlsrv_fetch_object()</strong>


id: sqlsrv_has_rows
type: function
doc:
<comment>Description:</comment>
  Indicates whether the specified statement has rows
  
  Indicates whether the specified statement has rows.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>  A statement resource returned by <strong>sqlsrv_query()</strong> or  <strong>sqlsrv_execute()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the specified statement has rows and <info>false</info> if the statement  does not have
        rows or if an error occurred.

<comment>See Also:</comment>
   * <strong>sqlsrv_num_rows()</strong>
   * <strong>sqlsrv_query()</strong>


id: sqlsrv_next_result
type: function
doc:
<comment>Description:</comment>
  Makes the next result of the specified statement active
  
  Makes the next result of the specified statement active. Results include result  sets, row counts,
  and output parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>  The statement on which the next result is being called.

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>true</info> if the next result was successfully retrieved, <info>false</info> if an error  occurred,
         and <info>null</info> if there are no more results to retrieve.

<comment>See Also:</comment>
   * <strong>sqlsrv_query()</strong>
   * <strong>sqlsrv_fetch_array()</strong>
   * <strong>sqlsrv_rows_affected()</strong>


id: sqlsrv_num_fields
type: function
doc:
<comment>Description:</comment>
  Retrieves the number of fields (columns) on a statement
  
  Retrieves the number of fields (columns) on a statement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>  The statement for which the number of fields is returned.  <strong>sqlsrv_num_fields()</strong>
                   can be called on a statement before  or after statement execution.

<comment>Return:</comment>
  <info>mixed</info>  Returns the number of fields on success. Returns <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>sqlsrv_field_metadata()</strong>
   * <strong>sqlsrv_fetch()</strong>
   * <strong>sqlsrv_get_field()</strong>


id: sqlsrv_num_rows
type: function
doc:
<comment>Description:</comment>
  Retrieves the number of rows in a result set
  
  Retrieves the number of rows in a result set. This function requires that the  statement resource
  be created with a static or keyset cursor. For more information,  see <strong>sqlsrv_query()</strong>,
  <strong>sqlsrv_prepare()</strong>,  or Specifying a Cursor Type and Selecting Rows  in the Microsoft SQLSRV
  documentation.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>  The statement for which the row count is returned. The statement resource  must
                   be created with a static or keyset cursor. For more information, see
                   <strong>sqlsrv_query()</strong>, <strong>sqlsrv_prepare()</strong>, or  Specifying a Cursor Type and Selecting Rows
                   in the Microsoft SQLSRV documentation.

<comment>Return:</comment>
  <info>mixed</info>  Returns the number of rows retrieved on success and <info>false</info> if an error occurred.  If a
         forward cursor (the default) or dynamic cursor is used, <info>false</info> is returned.

<comment>See Also:</comment>
   * <strong>sqlsrv_has_rows()</strong>
   * <strong>sqlsrv_rows_affected()</strong>


id: sqlsrv_prepare
type: function
doc:
<comment>Description:</comment>
  Prepares a query for execution
  
  Prepares a query for execution. This function is ideal for preparing a query  that will be
  executed multiple times with different parameter values.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn</strong>     A connection resource returned by <strong>sqlsrv_connect()</strong>.
  <info>string</info>    <strong>$sql</strong>      The string that defines the query to be prepared and executed.
  <info>array</info>     <strong>$params</strong>   An array specifying parameter information when executing a parameterized
                      query. Array elements can be any of the following: A literal valueA PHP
                      variableAn array with this structure:  array($value [, $direction [, $phpType
                      [, $sqlType]]]) The following table describes the elements in the array
                      structure above:
  <info>array</info>     <strong>$options</strong>  An array specifying query property options. The supported keys are described
                      in the following table:

<comment>Return:</comment>
  <info>mixed</info>  Returns a statement resource on success and <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * <strong>sqlsrv_execute()</strong>
   * <strong>sqlsrv_query()</strong>


id: sqlsrv_query
type: function
doc:
<comment>Description:</comment>
  Prepares and executes a query
  
  Prepares and executes a query.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn</strong>     A connection resource returned by <strong>sqlsrv_connect()</strong>.
  <info>string</info>    <strong>$sql</strong>      The string that defines the query to be prepared and executed.
  <info>array</info>     <strong>$params</strong>   An array specifying parameter information when executing a parameterized
                      query.  Array elements can be any of the following: A literal valueA PHP
                      variableAn array with this structure:  array($value [, $direction [, $phpType
                      [, $sqlType]]]) The following table describes the elements in the array
                      structure above:
  <info>array</info>     <strong>$options</strong>  An array specifying query property options. The supported keys are described
                      in the following table:

<comment>Return:</comment>
  <info>mixed</info>  Returns a statement resource on success and <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * <strong>sqlsrv_prepare()</strong>
   * <strong>sqlsrv_execute()</strong>


id: sqlsrv_rollback
type: function
doc:
<comment>Description:</comment>
  Rolls back a transaction that was begun with 
    sqlsrv_begin_transaction
  
  Rolls back a transaction that was begun with <strong>sqlsrv_begin_transaction()</strong>  and returns the
  connection to auto-commit mode.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn</strong>  The connection resource returned by a call to <strong>sqlsrv_connect()</strong>.

<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>sqlsrv_begin_transaction()</strong>
   * <strong>sqlsrv_commit()</strong>


id: sqlsrv_rows_affected
type: function
doc:
<comment>Description:</comment>
  Returns the number of rows modified by the last INSERT, UPDATE, or 
    DELETE query executed
  
  Returns the number of rows modified by the last INSERT, UPDATE, or DELETE  query executed. For
  information about the number of rows returned by a SELECT  query, see <strong>sqlsrv_num_rows()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>  The executed statement resource for which the number of affected rows is
                   returned.

<comment>Return:</comment>
  <info>int|false</info>  Returns the number of rows affected by the last INSERT, UPDATE, or DELETE query.  If no
             rows were affected, 0 is returned. If the number of affected rows cannot  be
             determined, -1 is returned. If an error occurred, <info>false</info> is returned.

<comment>See Also:</comment>
   * <strong>sqlsrv_num_rows()</strong>


id: sqlsrv_send_stream_data
type: function
doc:
<comment>Description:</comment>
  Sends data from parameter streams to the server
  
  Send data from parameter streams to the server. Up to 8 KB of data is sent  with each call.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stmt</strong>  A statement resource returned by <strong>sqlsrv_query()</strong> or  <strong>sqlsrv_execute()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if there is more data to send and <info>false</info> if there is not.

<comment>See Also:</comment>
   * <strong>sqlsrv_prepare()</strong>
   * <strong>sqlsrv_query()</strong>


id: sqlsrv_server_info
type: function
doc:
<comment>Description:</comment>
  Returns information about the server
  
  Returns information about the server.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn</strong>  The connection resource that connects the client and the server.

<comment>Return:</comment>
  <info>array</info>  Returns an array as described in the following table: Returned ArrayCurrentDatabaseThe
         connected-to database.SQLServerVersionThe SQL Server version.SQLServerNameThe name of the
         server.

<comment>See Also:</comment>
   * <strong>sqlsrv_client_info()</strong>


id: sqrt
type: function
doc:
<comment>Description:</comment>
  Raiz quadrada
  
  Retorna a raiz quadrada de <strong>$num</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  O argumento para processar

<comment>Return:</comment>
  <info>float</info>  A raiz quadrada de <strong>$num</strong> ou o valor especial <return>NAN</return> para números negativos.

<comment>See Also:</comment>
   * <strong>pow()</strong>
   * <info>M_SQRTPI</info> - sqrt(pi)
   * <info>M_2_SQRTPI</info> - 2/sqrt(pi)
   * <info>M_SQRT2</info> - sqrt(2)
   * <info>M_SQRT3</info> - sqrt(3)
   * <info>M_SQRT1_2</info> - 1/sqrt(2)


id: srand
type: function
doc:
<comment>Description:</comment>
  Seed the random number generator
  
  Seeds the random number generator with <strong>$seed</strong> or with a random value if <strong>$seed</strong> is <return>0</return>.
  
  Não é necessário
  inicializar o gerador de números aleatórios com <strong>srand()</strong> ou
  <strong>mt_srand()</strong>, pois isso é feito automaticamente.
  
  Como o mecanismo Mt19937 (“Mersenne Twister”) aceita apenas um único inteiro de 32 bits como
  semente, o número de sequências aleatórias possíveis é limitado a apenas 232 (ou seja,
  4.294.967.296), embora o Mt19937 possua um gigantesco período de 219937-1.
  
  Ao depender da geração aleatória implícita ou explícita de sementes, as duplicações aparecerão
  muito mais cedo. Sementes duplicadas são esperadas com probabilidade de 50% depois de menos de
  80.000 sementes geradas aleatoriamente de acordo com o problema do aniversário. Uma probabilidade
  de 10% de uma semente duplicada acontece depois de gerar aleatoriamente cerca de 30.000 sementes.
  
  Isso torna o Mt19937 inadequado para aplicações em que sequências duplicadas não devem ocorrer com
  mais do que uma probabilidade desprezível. Se a geração reproduzível de sementes for necessária,
  ambos os mecanismos <class>Random\Engine\Xoshiro256StarStar</class> e <class>Random\Engine\PcgOneseq128XslRr64</class> suportam
  sementes muito maiores que são improváveis de colidir aleatoriamente. Se a reprodutibilidade não
  for necessária, o mecanismo <class>Random\Engine\Secure</class> fornece aleatoriedade criptograficamente segura.
  
  As of PHP 7.1.0, <strong>srand()</strong> has been made an alias of <strong>mt_srand()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$seed</strong>  An arbitrary <info>int</info> seed value.

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

<comment>See Also:</comment>
   * <strong>rand()</strong>
   * <strong>getrandmax()</strong>
   * <strong>mt_srand()</strong>


id: sscanf
type: function
doc:
<comment>Description:</comment>
  Interpreta a entrada de uma string de acordo com um formato
  
  A função <strong>sscanf()</strong> é a análoga de entrada a <strong>printf()</strong>. <strong>sscanf()</strong> lê da string <strong>$string</strong> e interpreta-a
  de acordo com o especificado em <strong>$format</strong>.
  
  Qualquer espaço em branco na string de formato corresponde a qualquer espaço em branco na string
  de entrada. Isto significa que até mesmo uma tabulação (<return>\t</return>) na string de formato pode corresponder
  a um caractere de espaço simples na string de entrada.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A <info>string</info> de entrada a ser analisada.
  <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>    Variáveis opcionais passadas por referência que conterão os valores analisados.

<comment>Return:</comment>
  <info>array|int|null</info>  Se apenas dois parâmetros forem passados para esta função, os valores
                  interpretados serão retornados como um array. Caso contrário, se parâmetros
                  opcionais forem passados, a função retornará o número de valores atribuídos. Os
                  parâmetros opcionais precisam ser passados por referência.
                  
                  Se houver mais substrings esperadas em <strong>$format</strong> do que estiverem disponíveis na
                  <strong>$string</strong>, <info>null</info> será retornado.

<comment>See Also:</comment>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>
   * <strong>fprintf()</strong>
   * <strong>vprintf()</strong>
   * <strong>vsprintf()</strong>
   * <strong>vfprintf()</strong>
   * <strong>fscanf()</strong>
   * <strong>number_format()</strong>
   * <strong>date()</strong>


id: ssdeep_fuzzy_compare
type: function
doc:
<comment>Description:</comment>
  Calculates the match score between two fuzzy hash signatures
  
  Calculates the match score between <strong>$signature1</strong> and <strong>$signature2</strong> using  context-triggered piecewise
  hashing, and returns the match score.

<comment>Param:</comment>
  <info>string</info>  <strong>$signature1</strong>  The first fuzzy hash signature string.
  <info>string</info>  <strong>$signature2</strong>  The second fuzzy hash signature string.

<comment>Return:</comment>
  <info>int</info>  Returns an integer from 0 to 100 on success, <info>false</info> otherwise.


id: ssdeep_fuzzy_hash
type: function
doc:
<comment>Description:</comment>
  Create a fuzzy hash from a string
  
  <strong>ssdeep_fuzzy_hash()</strong> calculates the hash of  <strong>$to_hash</strong> using  context-triggered piecewise hashing,
  and returns that hash.

<comment>Param:</comment>
  <info>string</info>  <strong>$to_hash</strong>  The input string.

<comment>Return:</comment>
  <info>string</info>  Returns a string on success, <info>false</info> otherwise.


id: ssdeep_fuzzy_hash_filename
type: function
doc:
<comment>Description:</comment>
  Create a fuzzy hash from a file
  
  <strong>ssdeep_fuzzy_hash_filename()</strong> calculates the hash  of the file specified by <strong>$file_name</strong> using
  context-triggered piecewise  hashing, and returns that hash.

<comment>Param:</comment>
  <info>string</info>  <strong>$file_name</strong>  The filename of the file to hash.

<comment>Return:</comment>
  <info>string</info>  Returns a string on success, <info>false</info> otherwise.


id: ssh2_auth_agent
type: function
doc:
<comment>Description:</comment>
  Authenticate over SSH using the ssh agent
  
  Authenticate over SSH using the ssh agent
  
  The <strong>ssh2_auth_agent()</strong> function will only be available  when the ssh2 extension is compiled with
  libssh &gt;= 1.2.3.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>   An SSH connection link identifier, obtained from a call to <strong>ssh2_connect()</strong>.
  <info>string</info>    <strong>$username</strong>  Remote user name.

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


id: ssh2_auth_hostbased_file
type: function
doc:
<comment>Description:</comment>
  Authenticate using a public hostkey
  
  Authenticate using a public hostkey read from a file.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>         An SSH connection link identifier, obtained from a call to
                             <strong>ssh2_connect()</strong>.
  <info>string</info>    <strong>$username</strong>        
  <info>string</info>    <strong>$hostname</strong>        
  <info>string</info>    <strong>$pubkeyfile</strong>      
  <info>string</info>    <strong>$privkeyfile</strong>     
  <info>string</info>    <strong>$passphrase</strong>      If <strong>$privkeyfile</strong> is encrypted (which it should be), the passphrase must
                             be provided.
  <info>string</info>    <strong>$local_username</strong>  If <strong>$local_username</strong> is omitted, then the value for <strong>$username</strong> will be
                             used for it.

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


id: ssh2_auth_none
type: function
doc:
<comment>Description:</comment>
  Authenticate as "none"
  
  Attempt "none" authentication which usually will (and should) fail. As part of the failure, this
  function will return an array of accepted authentication methods.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>   An SSH connection link identifier, obtained from a call to <strong>ssh2_connect()</strong>.
  <info>string</info>    <strong>$username</strong>  Remote user name.

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>true</info> if the server does accept "none" as an authentication method, or an array of
         accepted authentication methods on failure.


id: ssh2_auth_password
type: function
doc:
<comment>Description:</comment>
  Authenticate over SSH using a plain password
  
  Authenticate over SSH using a plain password. Since version 0.12 this function also supports
  keyboard_interactive method.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>   An SSH connection link identifier, obtained from a call to <strong>ssh2_connect()</strong>.
  <info>string</info>    <strong>$username</strong>  Remote user name.
  <info>string</info>    <strong>$password</strong>  Password for <strong>$username</strong>

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


id: ssh2_auth_pubkey_file
type: function
doc:
<comment>Description:</comment>
  Authenticate using a public key
  
  Authenticate using a public key read from a file.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>      An SSH connection link identifier, obtained from a call to <strong>ssh2_connect()</strong>.
  <info>string</info>    <strong>$username</strong>     
  <info>string</info>    <strong>$pubkeyfile</strong>   The public key file needs to be in OpenSSH's format. It should look
                          something like:
                          
                          ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110
  <info>string</info>    <strong>$privkeyfile</strong>  
  <info>string</info>    <strong>$passphrase</strong>   If <strong>$privkeyfile</strong> is encrypted (which it should be), the <strong>$passphrase</strong> must be
                          provided.

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


id: ssh2_connect
type: function
doc:
<comment>Description:</comment>
  Connect to an SSH server
  
  Establish a connection to a remote SSH server.
  
  Once connected, the client should verify the server's hostkey using <strong>ssh2_fingerprint()</strong>, then
  authenticate using either password or public key.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>       
  <info>int</info>     <strong>$port</strong>       
  <info>array</info>   <strong>$methods</strong>    <strong>$methods</strong> may be an associative array with up to four parameters as described
                      below.
                      
                      <strong>$methods</strong> may be an associative array with any or all of the following
                      parameters.IndexMeaningSupported Values*kex List of key exchange methods to
                      advertise, comma separated in order of preference. <return>diffie-hellman-group1-sha1</return>,
                      <return>diffie-hellman-group14-sha1</return>, and <return>diffie-hellman-group-exchange-sha1</return>hostkey
                      List of hostkey methods to advertise, comma separated in order of preference.
                      <return>ssh-rsa</return> and <return>ssh-dss</return> client_to_server Associative array containing crypt,
                      compression, and message authentication code (MAC) method preferences for
                      messages sent from client to server. server_to_client Associative array
                      containing crypt, compression, and message authentication code (MAC) method
                      preferences for messages sent from server to client.
                      
                      * - Supported Values are dependent on methods supported by underlying library.
                      See libssh2 documentation for additional information.
                      
                      <strong>$client_to_server</strong> and <strong>$server_to_client</strong> may be an associative array with any
                      or all of the following parameters. IndexMeaningSupported Values*cryptList of
                      crypto methods to advertise, comma separated in order of
                      preference.<return>rijndael-cbc@lysator.liu.se</return>, <return>aes256-cbc</return>, <return>aes192-cbc</return>, <return>aes128-cbc</return>,
                      <return>3des-cbc</return>, <return>blowfish-cbc</return>, <return>cast128-cbc</return>, <return>arcfour</return>, and <return>none**</return>compList of
                      compression methods to advertise, comma separated in order of preference.<return>zlib</return>
                      and <return>none</return> macList of MAC methods to advertise, comma separated in order of
                      preference.<return>hmac-sha1</return>, <return>hmac-sha1-96</return>, <return>hmac-ripemd160</return>,
                      <return>hmac-ripemd160@openssh.com</return>, and <return>none**</return>
                      
                      Crypt and MAC method "<return>none</return>" For security reasons, <return>none</return> is disabled by the
                      underlying libssh2 library unless explicitly enabled during build time by
                      using the appropriate ./configure options.  See documentation for the
                      underlying library for more information.
                      
                      For security reasons, <return>none</return> is disabled by the underlying libssh2 library
                      unless explicitly enabled during build time by using the appropriate
                      ./configure options.  See documentation for the underlying library for more
                      information.
  <info>array</info>   <strong>$callbacks</strong>  <strong>$callbacks</strong> may be an associative array with any or all of the following
                      parameters.  Callbacks parameters IndexMeaningPrototypeignore Name of function
                      to call when an <info>SSH2_MSG_IGNORE</info> packet is received void
                      ignore_cb($message)debug Name of function to call when an <info>SSH2_MSG_DEBUG</info>
                      packet is received void debug_cb($message, $language, $always_display)macerror
                      Name of function to call when a packet is received but the message
                      authentication code failed.  If the callback returns <info>true</info>, the mismatch will
                      be ignored, otherwise the connection will be terminated. bool
                      macerror_cb($packet)disconnect Name of function to call when an
                      <info>SSH2_MSG_DISCONNECT</info> packet is received void disconnect_cb($reason, $message,
                      $language)

<comment>Return:</comment>
  <info>resource|false</info>  Returns a resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>ssh2_fingerprint()</strong>
   * <strong>ssh2_auth_none()</strong>
   * <strong>ssh2_auth_password()</strong>
   * <strong>ssh2_auth_pubkey_file()</strong>
   * <strong>ssh2_disconnect()</strong>


id: ssh2_disconnect
type: function
doc:
<comment>Description:</comment>
  Close a connection to a remote SSH server
  
  Close a connection to a remote SSH server.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>  An SSH connection link identifier, obtained from a call to <strong>ssh2_connect()</strong>.

<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>ssh2_connect()</strong>


id: ssh2_exec
type: function
doc:
<comment>Description:</comment>
  Execute a command on a remote server
  
  Execute a command at the remote end and allocate a channel for it.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>            An SSH connection link identifier, obtained from a call to
                                <strong>ssh2_connect()</strong>.
  <info>string</info>    <strong>$command</strong>            
  <info>string</info>    <strong>$pty</strong>                
  <info>array</info>     <strong>$env</strong>                <strong>$env</strong> may be passed as an associative array of name/value pairs to
                                set in the target environment.
  <info>int</info>       <strong>$width</strong>              Width of the virtual terminal.
  <info>int</info>       <strong>$height</strong>             Height of the virtual terminal.
  <info>int</info>       <strong>$width_height_type</strong>  <strong>$width_height_type</strong> should be one of <info>SSH2_TERM_UNIT_CHARS</info> or
                                <info>SSH2_TERM_UNIT_PIXELS</info>.

<comment>Return:</comment>
  <info>resource|false</info>  Returns a stream on success ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ssh2_connect()</strong>
   * <strong>ssh2_shell()</strong>
   * <strong>ssh2_tunnel()</strong>


id: ssh2_fetch_stream
type: function
doc:
<comment>Description:</comment>
  Fetch an extended data stream
  
  Fetches an alternate substream associated with an SSH2 channel stream. The SSH2 protocol currently
  defines only one substream, STDERR, which has a substream ID of <info>SSH2_STREAM_STDERR</info> (defined as 1).

<comment>Param:</comment>
  <info>resource</info>  <strong>$channel</strong>   
  <info>int</info>       <strong>$streamid</strong>  An SSH2 channel stream.

<comment>Return:</comment>
  <info>resource</info>  Returns the requested stream resource.

<comment>See Also:</comment>
   * <strong>ssh2_shell()</strong>
   * <strong>ssh2_exec()</strong>
   * <strong>ssh2_connect()</strong>


id: ssh2_fingerprint
type: function
doc:
<comment>Description:</comment>
  Retrieve fingerprint of remote server
  
  Returns a server hostkey hash from an active session.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>  An SSH connection link identifier, obtained from a call to <strong>ssh2_connect()</strong>.
  <info>int</info>       <strong>$flags</strong>    <strong>$flags</strong> may be either of <info>SSH2_FINGERPRINT_MD5</info> or <info>SSH2_FINGERPRINT_SHA1</info>
                      logically ORed with <info>SSH2_FINGERPRINT_HEX</info> or <info>SSH2_FINGERPRINT_RAW</info>.

<comment>Return:</comment>
  <info>string</info>  Returns the hostkey hash as a string.


id: ssh2_forward_accept
type: function
doc:
<comment>Description:</comment>
  Accept a connection created by a listener
  
  Accepts a connection created by a listener.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info></info>  <strong>$desc</strong>  An SSH2 Listener resource, obtained from a call to <strong>ssh2_forward_listen()</strong>.

<comment>Return:</comment>
  <info>resource|false</info>  Returns a stream resource,  ou <info>false</info> em caso de falha.


id: ssh2_forward_listen
type: function
doc:
<comment>Description:</comment>
  Bind a port on the remote server and listen for connections
  
  Binds a port on the remote server and listen for connections.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>          An SSH Session resource, obtained from a call to <strong>ssh2_connect()</strong>.
  <info>int</info>       <strong>$port</strong>             The port of the remote server.
  <info>string</info>    <strong>$host</strong>             
  <info>int</info>       <strong>$max_connections</strong>  

<comment>Return:</comment>
  <info>resource|false</info>  Returns an SSH2 Listener,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ssh2_forward_accept()</strong>


id: ssh2_methods_negotiated
type: function
doc:
<comment>Description:</comment>
  Return list of negotiated methods
  
  Returns list of negotiated methods.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>  An SSH connection link identifier, obtained from a call to <strong>ssh2_connect()</strong>.

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

<comment>See Also:</comment>
   * <strong>ssh2_connect()</strong>


id: ssh2_poll
type: function
doc:
<comment>Description:</comment>
  Poll the channels/listeners/streams for events
  
  Polls the channels/listeners/streams for events, and returns the number of descriptors which
  returned non-zero revents.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>array</info>  <strong>$desc</strong>     An indexed array of subarrays with the keys <return>'resource'</return> and <return>'events'</return>. The value of
                   the resource is a (channel) stream or an SSH2 Listener resource. The value of the
                   event are SSH2_POLL* flags bitwise ORed together. Each subarray will be populated
                   with an <return>'revents'</return> element on return, whose values are SSH2_POLL* flags bitwise
                   ORed together of the events that occurred.
  <info>int</info>    <strong>$timeout</strong>  The timeout in seconds.

<comment>Return:</comment>
  <info>int</info>  Returns the number of descriptors which returned non-zero revents.


id: ssh2_publickey_add
type: function
doc:
<comment>Description:</comment>
  Add an authorized publickey
    
  
  O subsistema de chave pública
  é usado para gerenciar chaves públicas em um servidor no qual o cliente
  já está autenticado. Para autenticar em um servidor remoto
  usando autenticação com chave pública, use a função
  <strong>ssh2_auth_pubkey_file()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$pkey</strong>        Publickey Subsystem resource created by <strong>ssh2_publickey_init()</strong>.
  <info>string</info>    <strong>$algoname</strong>    Publickey algorithm (e.g.): ssh-dss, ssh-rsa
  <info>string</info>    <strong>$blob</strong>        Publickey blob as raw binary data
  <info>bool</info>      <strong>$overwrite</strong>   If the specified key already exists, should it be overwritten?
  <info>array</info>     <strong>$attributes</strong>  Associative array of attributes to assign to this public key. Refer to
                         ietf-secsh-publickey-subsystem for a list of supported attributes. To mark
                         an attribute as mandatory, precede its name with an asterisk. If the server
                         is unable to support an attribute marked mandatory, it will abort the add
                         process.

<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>ssh2_publickey_init()</strong>
   * <strong>ssh2_publickey_remove()</strong>
   * <strong>ssh2_publickey_list()</strong>


id: ssh2_publickey_init
type: function
doc:
<comment>Description:</comment>
  Initialize Publickey subsystem
    
  
  Request the Publickey subsystem from an already connected SSH2 server.
  
  The publickey subsystem allows an already connected and authenticated client to manage the list of
  authorized public keys stored on the target server in an implementation agnostic manner. If the
  remote server does not support the publickey subsystem, the <strong>ssh2_publickey_init()</strong> function will
  return <info>false</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>  

<comment>Return:</comment>
  <info>resource|false</info>  Returns an <return>SSH2 Publickey Subsystem</return> resource for use with all other
                  ssh2_publickey_*() methods ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ssh2_publickey_add()</strong>
   * <strong>ssh2_publickey_remove()</strong>
   * <strong>ssh2_publickey_list()</strong>


id: ssh2_publickey_list
type: function
doc:
<comment>Description:</comment>
  List currently authorized publickeys
    
  
  List currently authorized publickeys.

<comment>Param:</comment>
  <info>resource</info>  <strong>$pkey</strong>  Publickey Subsystem resource

<comment>Return:</comment>
  <info>array</info>  Returns a numerically indexed array of keys, each of which is an associative array
         containing: name, blob, and attrs elements.
         
         Publickey elementsArray KeyMeaningnameName of algorithm used by this publickey, for
         example: <return>ssh-dss</return> or <return>ssh-rsa</return>.blobPublickey blob as raw binary data.attrsAttributes assigned
         to this publickey. The most common attribute, and the only one supported by publickey
         version 1 servers, is <return>comment</return>, which may be any freeform string.

<comment>See Also:</comment>
   * <strong>ssh2_publickey_init()</strong>
   * <strong>ssh2_publickey_add()</strong>
   * <strong>ssh2_publickey_remove()</strong>


id: ssh2_publickey_remove
type: function
doc:
<comment>Description:</comment>
  Remove an authorized publickey
    
  
  Removes an authorized publickey.

<comment>Param:</comment>
  <info>resource</info>  <strong>$pkey</strong>      Publickey Subsystem Resource
  <info>string</info>    <strong>$algoname</strong>  Publickey algorithm (e.g.): ssh-dss, ssh-rsa
  <info>string</info>    <strong>$blob</strong>      Publickey blob as raw binary data

<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>ssh2_publickey_init()</strong>
   * <strong>ssh2_publickey_add()</strong>
   * <strong>ssh2_publickey_list()</strong>


id: ssh2_scp_recv
type: function
doc:
<comment>Description:</comment>
  Request a file via SCP
  
  Copy a file from the remote server to the local filesystem using the SCP protocol.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>      An SSH connection link identifier, obtained from a call to <strong>ssh2_connect()</strong>.
  <info>string</info>    <strong>$remote_file</strong>  Path to the remote file.
  <info>string</info>    <strong>$local_file</strong>   Path to the local 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>
   * <strong>ssh2_scp_send()</strong>
   * <strong>copy()</strong>


id: ssh2_scp_send
type: function
doc:
<comment>Description:</comment>
  Send a file via SCP
  
  Copy a file from the local filesystem to the remote server using the SCP protocol.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>      An SSH connection link identifier, obtained from a call to <strong>ssh2_connect()</strong>.
  <info>string</info>    <strong>$local_file</strong>   Path to the local file.
  <info>string</info>    <strong>$remote_file</strong>  Path to the remote file.
  <info>int</info>       <strong>$create_mode</strong>  The file will be created with the mode specified by <strong>$create_mode</strong>.

<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>ssh2_scp_recv()</strong>
   * <strong>copy()</strong>


id: ssh2_send_eof
type: function
doc:
<comment>Description:</comment>
  Send EOF to stream
  
  Sends an EOF to the stream; this is typically used to close standard input, while keeping output
  and error alive. For example, one can send a remote process some data over standard input, close
  it to start processing, and still be able to read out the results without creating additional
  files.

<comment>Param:</comment>
  <info>resource</info>  <strong>$channel</strong>  An SSH stream; can be acquired through functions like <strong>ssh2_fetch_stream()</strong> or
                      <strong>ssh2_connect()</strong>.

<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>ssh2_fetch_stream()</strong>


id: ssh2_sftp
type: function
doc:
<comment>Description:</comment>
  Initialize SFTP subsystem
  
  Request the SFTP subsystem from an already connected SSH2 server.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>  An SSH connection link identifier, obtained from a call to <strong>ssh2_connect()</strong>.

<comment>Return:</comment>
  <info>resource|false</info>  This method returns an <return>SSH2 SFTP</return> resource for use with all other ssh2_sftp_*()
                  methods and the ssh2.sftp:// fopen wrapper, ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ssh2_scp_recv()</strong>
   * <strong>ssh2_scp_send()</strong>


id: ssh2_sftp_chmod
type: function
doc:
<comment>Description:</comment>
  Changes file mode
  
  Attempts to change the mode of the specified file to that given in <strong>$mode</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>      An SSH2 SFTP resource opened by <strong>ssh2_sftp()</strong>.
  <info>string</info>    <strong>$filename</strong>  Path to the file.
  <info>int</info>       <strong>$mode</strong>      Permissions on the file. See the <strong>chmod()</strong> for more details on this parameter.

<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>chmod()</strong>
   * <strong>ssh2_sftp()</strong>
   * <strong>ssh2_connect()</strong>


id: ssh2_sftp_lstat
type: function
doc:
<comment>Description:</comment>
  Stat a symbolic link
  
  Stats a symbolic link on the remote filesystem without following the link.
  
  This function is similar to using the <strong>lstat()</strong> function with the ssh2.sftp:// wrapper and returns
  the same values.

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>  An SSH2 SFTP resource opened by <strong>ssh2_sftp()</strong>.
  <info>string</info>    <strong>$path</strong>  Path to the remote symbolic link.

<comment>Return:</comment>
  <info>array</info>  See the documentation for <strong>stat()</strong> for details on the values which may be returned.

<comment>See Also:</comment>
   * <strong>ssh2_sftp_stat()</strong>
   * <strong>lstat()</strong>
   * <strong>stat()</strong>


id: ssh2_sftp_mkdir
type: function
doc:
<comment>Description:</comment>
  Create a directory
  
  Creates a directory on the remote file server with permissions set to <strong>$mode</strong>.
  
  This function is similar to using <strong>mkdir()</strong> with the ssh2.sftp:// wrapper.

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>       An SSH2 SFTP resource opened by <strong>ssh2_sftp()</strong>.
  <info>string</info>    <strong>$dirname</strong>    Path of the new directory.
  <info>int</info>       <strong>$mode</strong>       Permissions on the new directory. The actual mode is affected by the current
                        umask.
  <info>bool</info>      <strong>$recursive</strong>  If <strong>$recursive</strong> is <info>true</info> any parent directories required for <strong>$dirname</strong> will be
                        automatically created as well.

<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>mkdir()</strong>
   * <strong>ssh2_sftp_rmdir()</strong>


id: ssh2_sftp_readlink
type: function
doc:
<comment>Description:</comment>
  Return the target of a symbolic link
  
  Returns the target of a symbolic link.

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>  An SSH2 SFTP resource opened by <strong>ssh2_sftp()</strong>.
  <info>string</info>    <strong>$link</strong>  Path of the symbolic link.

<comment>Return:</comment>
  <info>string</info>  Returns the target of the symbolic <strong>$link</strong>.

<comment>See Also:</comment>
   * <strong>readlink()</strong>
   * <strong>ssh2_sftp_symlink()</strong>


id: ssh2_sftp_realpath
type: function
doc:
<comment>Description:</comment>
  Resolve the realpath of a provided path string
  
  Translates <strong>$filename</strong> into the effective real path on the remote filesystem.

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>      An SSH2 SFTP resource opened by <strong>ssh2_sftp()</strong>.
  <info>string</info>    <strong>$filename</strong>  

<comment>Return:</comment>
  <info>string</info>  Returns the real path as a string.

<comment>See Also:</comment>
   * <strong>realpath()</strong>
   * <strong>ssh2_sftp_symlink()</strong>
   * <strong>ssh2_sftp_readlink()</strong>


id: ssh2_sftp_rename
type: function
doc:
<comment>Description:</comment>
  Rename a remote file
  
  Renames a file on the remote filesystem.

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>  An SSH2 SFTP resource opened by <strong>ssh2_sftp()</strong>.
  <info>string</info>    <strong>$from</strong>  The current file that is being renamed.
  <info>string</info>    <strong>$to</strong>    The new file name that replaces <strong>$from</strong>.

<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>rename()</strong>


id: ssh2_sftp_rmdir
type: function
doc:
<comment>Description:</comment>
  Remove a directory
  
  Removes a directory from the remote file server.
  
  This function is similar to using <strong>rmdir()</strong> with the ssh2.sftp:// wrapper.

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>     An SSH2 SFTP resource opened by <strong>ssh2_sftp()</strong>.
  <info>string</info>    <strong>$dirname</strong>  

<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>rmdir()</strong>
   * <strong>ssh2_sftp_mkdir()</strong>


id: ssh2_sftp_stat
type: function
doc:
<comment>Description:</comment>
  Stat a file on a remote filesystem
  
  Stats a file on the remote filesystem following any symbolic links.
  
  This function is similar to using the <strong>stat()</strong> function with the ssh2.sftp:// wrapper and returns
  the same values.

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>  An SSH2 SFTP resource opened by <strong>ssh2_sftp()</strong>.
  <info>string</info>    <strong>$path</strong>  

<comment>Return:</comment>
  <info>array</info>  See the documentation for <strong>stat()</strong> for details on the values which may be returned.

<comment>See Also:</comment>
   * <strong>ssh2_sftp_lstat()</strong>
   * <strong>lstat()</strong>
   * <strong>stat()</strong>


id: ssh2_sftp_symlink
type: function
doc:
<comment>Description:</comment>
  Create a symlink
  
  Creates a symbolic link named <strong>$link</strong> on the remote filesystem pointing to <strong>$target</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>    An SSH2 SFTP resource opened by <strong>ssh2_sftp()</strong>.
  <info>string</info>    <strong>$target</strong>  Target of the symbolic link.
  <info>string</info>    <strong>$link</strong>    

<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>ssh2_sftp_readlink()</strong>
   * <strong>symlink()</strong>


id: ssh2_sftp_unlink
type: function
doc:
<comment>Description:</comment>
  Delete a file
  
  Deletes a file on the remote filesystem.

<comment>Param:</comment>
  <info>resource</info>  <strong>$sftp</strong>      An SSH2 SFTP resource opened by <strong>ssh2_sftp()</strong>.
  <info>string</info>    <strong>$filename</strong>  

<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>unlink()</strong>


id: ssh2_shell
type: function
doc:
<comment>Description:</comment>
  Request an interactive shell
  
  Open a shell at the remote end and allocate a stream for it.

<comment>Param:</comment>
  <info>resource</info>    <strong>$session</strong>            An SSH connection link identifier, obtained from a call to
                                  <strong>ssh2_connect()</strong>.
  <info>string</info>      <strong>$termtype</strong>           <strong>$termtype</strong> should correspond to one of the entries in the target
                                  system's <return>/etc/termcap</return> file.
  <info>array|null</info>  <strong>$env</strong>                <strong>$env</strong> may be passed as an associative array of name/value pairs to
                                  set in the target environment.
  <info>int</info>         <strong>$width</strong>              Width of the virtual terminal.
  <info>int</info>         <strong>$height</strong>             Height of the virtual terminal.
  <info>int</info>         <strong>$width_height_type</strong>  <strong>$width_height_type</strong> should be one of <info>SSH2_TERM_UNIT_CHARS</info> or
                                  <info>SSH2_TERM_UNIT_PIXELS</info>.

<comment>Return:</comment>
  <info>resource|false</info>  Returns a stream resource on success,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ssh2_exec()</strong>
   * <strong>ssh2_tunnel()</strong>
   * <strong>ssh2_fetch_stream()</strong>


id: ssh2_tunnel
type: function
doc:
<comment>Description:</comment>
  Open a tunnel through a remote server
  
  Open a socket stream to an arbitrary host/port by way of the currently connected SSH server.

<comment>Param:</comment>
  <info>resource</info>  <strong>$session</strong>  An SSH connection link identifier, obtained from a call to <strong>ssh2_connect()</strong>.
  <info>string</info>    <strong>$host</strong>     
  <info>int</info>       <strong>$port</strong>     

<comment>Return:</comment>
  <info>resource</info>  

<comment>See Also:</comment>
   * <strong>ssh2_connect()</strong>
   * <strong>fsockopen()</strong>


id: stat
type: function
doc:
<comment>Description:</comment>
  Obtém informações sobre um arquivo
  
  Coleta estatísticas do arquivo informado em <strong>$filename</strong>. Se <strong>$filename</strong> for uma ligação simbólica,
  estatísticas serão do próprio arquivo, não da ligação. Antes do PHP 7.4.0, nas compilações NTS do
  Windows, as estatísticas <return>size</return>, <return>atime</return>, <return>mtime</return> e <return>ctime</return> statistics são da ligação simbólica, neste
  caso.
  
  <strong>lstat()</strong> é idêntica a <strong>stat()</strong> exceto que ela foi baseada no estado de ligações simbólicas.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Caminho para o arquivo.

<comment>Return:</comment>
  <info>array|false</info>  Formato de retorno de <strong>stat()</strong> e <strong>fstat()</strong>NuméricoAssociativoDescrição0devnúmero do
               dispositivo ***1inonúmero do inode ***2modemodo de proteção do inode
               *****3nlinknúmero de ligações4uidid de usuário do proprietário *5gidid de grupo do
               proprietário *6rdevtipo de dispositivo, se for inode7sizetamanho em
               bytes8atimehorário do último acesso (timestamp Unix)9mtimehorário da última
               modificação (timestamp Unix)10ctimehora da última modificação do inode (timestamp
               Unix)11blksizetamanho do bloco de E/S no sistema de arquivos **12blocksnúmero de
               blocos de 512 bytes alocados **
               
               * No Windows será sempre <return>0</return>.
               
               ** Válido apenas em sistemas que suportam o tipo st_blksize type - outros sistemas
               (ex.: Windows) retornam <return>-1</return>.
               
               *** No Windows, a partir do PHP 7.4.0, este é o número de série do volume que contém
               o arquivo, que é um inteiro de 64-bits sem sinal, ou seja, pode sobrecarregar.
               Anteriormente, era uma representação numérica da letra do dispositivo (ex.: <return>2</return> para
               <return>C:</return>) para <strong>stat()</strong>, e <return>0</return> para <strong>lstat()</strong>.
               
               **** No Windows, a partir do PHP 7.4.0, este é o identificador associado com o
               arquivo, que é um inteiro de 64-bits sem sinal, ou seja, pode sobrecarregar.
               Anteriormente, era sempre <return>0</return>.
               
               ***** No Windows, o bit de permissão de escrita é definido de acordo com o atributo
               de somente-leitura do arquivo, e o mesmo valor é reportado para todos os usuários,
               grupos e proprietários. A ACL não é levada em consideração, contrário a
               <strong>is_writable()</strong>.
               
               O valor de <return>mode</return> contém informação lida por várias funções. Quando escrita em octal,
               começando da direita, os primeiros três dígitos são retornados por <strong>chmod()</strong>. O dígito
               seguinte é ignorado pelo PHP. Os dois dígitos seguintes indicam o tipo de arquivo:
               Tipos de arquivo para <return>mode</return><return>mode</return> em
               octalSignificado<info>0140000</info>socket<info>0120000</info>ligação<info>0100000</info>arquivo normal<info>0060000</info>dispositivo de
               bloco<info>0040000</info>diretório<info>0020000</info>dispositivo de caracteres<info>0010000</info>fifo Por exemplo, um
               arquivo normal poderia ser <info>0100644</info> e um diretório poderia ser <info>0040755</info>.
               
               Em caso de erro, <strong>stat()</strong> retorna <info>false</info>.
               
               Como o tipo inteiro do PHP possui sinal e muitas plataformas usam números inteiros de
               32 bits, algumas funções do sistema de arquivos podem retornar resultados inesperados
               para arquivos maiores que 2GB.

<comment>See Also:</comment>
   * <strong>lstat()</strong>
   * <strong>fstat()</strong>
   * <strong>filemtime()</strong>
   * <strong>filegroup()</strong>
   * <class>SplFileInfo</class>


id: stats_absolute_deviation
type: function
doc:
<comment>Description:</comment>
  Returns the absolute deviation of an array of values
  
  Returns the absolute deviation of the values in <strong>$a</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$a</strong>  The input array

<comment>Return:</comment>
  <info>float</info>  Returns the absolute deviation of the values in <strong>$a</strong>, or <info>false</info> if <strong>$a</strong> is empty or is not an
         array.


id: stats_cdf_beta
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the beta distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the beta
  distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are determined
  by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, alpha, and beta
  denotes cumulative distribution function, the value of the random variable, and shape parameters
  of the beta distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxalphabeta2xCDFalphabeta3alphaxCDFbeta4betaxCDFalpha

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, alpha, or beta, determined by <strong>$which</strong>.


id: stats_cdf_binomial
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the binomial distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  binomial distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are
  determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, n, and p denotes
  cumulative distribution function, the number of successes, the number of trials, and the success
  rate for each trial, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxnp2xCDFnp3nxCDFp4pxCDFn

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, n, or p, determined by <strong>$which</strong>.


id: stats_cdf_cauchy
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the Cauchy distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the Cauchy
  distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are determined
  by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, x0, and gamma denotes
  cumulative distribution function, the value of the random variable, the location and the scale
  parameter of the Cauchy distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxx0gamma2xCDFx0gamma3x0xCDFgamma4gammaxCDFx0

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, x0, or gamma, determined by <strong>$which</strong>.


id: stats_cdf_chisquare
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the chi-square distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  chi-square distribution. The kind of the return value and parameters (<strong>$par1</strong> and <strong>$par2</strong>) are
  determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, and k denotes
  cumulative distribution function, the value of the random variable, and the degree of freedom of
  the chi-square distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong>1CDFxk2xCDFk3kxCDF

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, or k, determined by <strong>$which</strong>.


id: stats_cdf_exponential
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the exponential distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  exponential distribution. The kind of the return value and parameters (<strong>$par1</strong> and <strong>$par2</strong>) are
  determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, and lambda denotes
  cumulative distribution function, the value of the random variable, and the rate parameter of the
  exponential distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong>1CDFxlambda2xCDFlambda3lambdaxCDF

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, or lambda, determined by <strong>$which</strong>.


id: stats_cdf_f
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the F distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the F
  distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are determined
  by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, d1, and d2 denotes
  cumulative distribution function, the value of the random variable, and the degree of freedoms of
  the F distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxd1d22xCDFd1d23d1xCDFd24d2xCDFd1

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, d1, or d2, determined by <strong>$which</strong>.


id: stats_cdf_gamma
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the gamma distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the gamma
  distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are determined
  by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, k, and theta denotes
  cumulative distribution function, the value of the random variable, and the shape and the scale
  parameter of the gamma distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxktheta2xCDFktheta3kxCDFtheta4thetaxCDFk

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, k, or theta, determined by <strong>$which</strong>.


id: stats_cdf_laplace
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the Laplace distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  Laplace distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are
  determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, mu, and b denotes
  cumulative distribution function, the value of the random variable, and the location and the scale
  parameter of the Laplace distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxmub2xCDFmub3muxCDFb4bxCDFmu

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, mu, or b, determined by <strong>$which</strong>.


id: stats_cdf_logistic
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the logistic distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  logistic distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are
  determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, mu, and s denotes
  cumulative distribution function, the value of the random variable, and the location and the scale
  parameter of the logistic distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxmus2xCDFmus3muxCDFs4sxCDFmu

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, mu, or s, determined by <strong>$which</strong>.


id: stats_cdf_negative_binomial
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the negative binomial distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  negative binomial distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and
  <strong>$par3</strong>) are determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, r, and p denotes
  cumulative distribution function, the number of failure, the number of success, and the success
  rate for each trial, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxrp2xCDFrp3rxCDFp4pxCDFr

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, r, or p, determined by <strong>$which</strong>.


id: stats_cdf_noncentral_chisquare
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the non-central chi-square distribution given values for the
  others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  non-central chi-square distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>,
  and <strong>$par3</strong>) are determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, k, and lambda denotes
  cumulative distribution function, the value of the random variable, the degree of freedom and the
  non-centrality parameter of the distribution, respectively. Return value and
  parameters<strong>$which</strong>Return value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxklambda2xCDFklambda3kxCDFlambda4lambdaxCDFk

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, k, or lambda, determined by <strong>$which</strong>.


id: stats_cdf_noncentral_f
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the non-central F distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  non-central F distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, <strong>$par3</strong>, and
  <strong>$par4</strong>) are determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, nu1, nu2, and lambda
  denotes cumulative distribution function, the value of the random variable, the degree of freedoms
  and the non-centrality parameter of the distribution, respectively. Return value and
  parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong><strong>$par4</strong>1CDFxnu1nu2lambda2xCDFnu1nu2lambda3nu1xCDFnu2lambda4nu2xCDFnu1lambda5lambdaxCDFnu1nu2

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>float</info>  <strong>$par4</strong>   The fourth parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, nu1, nu2, or lambda, determined by <strong>$which</strong>.


id: stats_cdf_noncentral_t
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the non-central t-distribution give values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  non-central t-distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>)
  are determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, nu, and mu denotes
  cumulative distribution function, the value of the random variable, the degrees of freedom and the
  non-centrality parameter of the distribution, respectively. Return value and
  parameters<strong>$which</strong>Return value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxnumu2xCDFnumu3nuxCDFmu4muxCDFnu

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, nu, or mu, determined by <strong>$which</strong>.


id: stats_cdf_normal
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the normal distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the normal
  distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are determined
  by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, mu, and sigma denotes
  cumulative distribution function, the value of the random variable, the mean and the standard
  deviation of the normal distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxmusigma2xCDFmusigma3muxCDFsigma4sigmaxCDFmu

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, mu, or sigma, determined by <strong>$which</strong>.


id: stats_cdf_poisson
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the Poisson distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  Poisson distribution. The kind of the return value and parameters (<strong>$par1</strong> and <strong>$par2</strong>) are determined
  by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, and lambda denotes
  cumulative distribution function, the value of the random variable, and the parameter of the
  Poisson distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong>1CDFxlambda2xCDFlambda3lambdaxCDF

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, or lambda, determined by <strong>$which</strong>.


id: stats_cdf_t
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the t-distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  t-distribution. The kind of the return value and parameters (<strong>$par1</strong> and <strong>$par2</strong>) are determined by
  <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, and nu denotes
  cumulative distribution function, the value of the random variable, and the degrees of freedom of
  the t-distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong>1CDFxnu2xCDFnu3nuxCDF

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, or nu, determined by <strong>$which</strong>.


id: stats_cdf_uniform
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the uniform distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  uniform distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are
  determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, a, and b denotes
  cumulative distribution function, the value of the random variable, the lower bound and the higher
  bound of the uniform distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxab2xCDFab3axCDFb4bxCDFa

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, a, or b, determined by <strong>$which</strong>.


id: stats_cdf_weibull
type: function
doc:
<comment>Description:</comment>
  Calculates any one parameter of the Weibull distribution given values for the others
  
  Returns the cumulative distribution function, its inverse, or one of its parameters, of the
  Weibull distribution. The kind of the return value and parameters (<strong>$par1</strong>, <strong>$par2</strong>, and <strong>$par3</strong>) are
  determined by <strong>$which</strong>.
  
  The following table lists the return value and parameters by <strong>$which</strong>. CDF, x, k, and lambda denotes
  cumulative distribution function, the value of the random variable, the shape and the scale
  parameter of the Weibull distribution, respectively. Return value and parameters<strong>$which</strong>Return
  value<strong>$par1</strong><strong>$par2</strong><strong>$par3</strong>1CDFxklambda2xCDFklambda3kxCDFlambda4lambdaxCDFk

<comment>Param:</comment>
  <info>float</info>  <strong>$par1</strong>   The first parameter
  <info>float</info>  <strong>$par2</strong>   The second parameter
  <info>float</info>  <strong>$par3</strong>   The third parameter
  <info>int</info>    <strong>$which</strong>  The flag to determine what to be calculated

<comment>Return:</comment>
  <info>float</info>  Returns CDF, x, k, or lambda, determined by <strong>$which</strong>.


id: stats_covariance
type: function
doc:
<comment>Description:</comment>
  Computes the covariance of two data sets
  
  Returns the covariance of <strong>$a</strong> and <strong>$b</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$a</strong>  The first array
  <info>array</info>  <strong>$b</strong>  The second array

<comment>Return:</comment>
  <info>float</info>  Returns the covariance of <strong>$a</strong> and <strong>$b</strong>, or <info>false</info> on failure.


id: stats_dens_beta
type: function
doc:
<comment>Description:</comment>
  Probability density function of the beta distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the beta distribution of
  which the shape parameters are <strong>$a</strong> and <strong>$b</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  The value at which the probability density is calculated
  <info>float</info>  <strong>$a</strong>  The shape parameter of the distribution
  <info>float</info>  <strong>$b</strong>  The shape parameter of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_cauchy
type: function
doc:
<comment>Description:</comment>
  Probability density function of the Cauchy distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the Cauchy distribution
  whose location and scale are <strong>$ave</strong> and <strong>$stdev</strong>, respectively.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>      The value at which the probability density is calculated
  <info>float</info>  <strong>$ave</strong>    The location parameter of the distribution
  <info>float</info>  <strong>$stdev</strong>  The scale parameter of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_chisquare
type: function
doc:
<comment>Description:</comment>
  Probability density function of the chi-square distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the chi-square
  distribution of which the degree of freedom is <strong>$dfr</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>    The value at which the probability density is calculated
  <info>float</info>  <strong>$dfr</strong>  The degree of freedom of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_exponential
type: function
doc:
<comment>Description:</comment>
  Probability density function of the exponential distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the exponential
  distribution of which the scale is <strong>$scale</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>      The value at which the probability density is calculated
  <info>float</info>  <strong>$scale</strong>  The scale of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_f
type: function
doc:
<comment>Description:</comment>
  Probability density function of the F distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the F distribution of
  which the degree of freedoms are <strong>$dfr1</strong> and <strong>$dfr2</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>     The value at which the probability density is calculated
  <info>float</info>  <strong>$dfr1</strong>  The degree of freedom of the distribution
  <info>float</info>  <strong>$dfr2</strong>  The degree of freedom of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_gamma
type: function
doc:
<comment>Description:</comment>
  Probability density function of the gamma distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the gamma distribution of
  which the shape parameter is <strong>$shape</strong> and the scale parameter is <strong>$scale</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>      The value at which the probability density is calculated
  <info>float</info>  <strong>$shape</strong>  The shape parameter of the distribution
  <info>float</info>  <strong>$scale</strong>  The scale parameter of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_laplace
type: function
doc:
<comment>Description:</comment>
  Probability density function of the Laplace distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the Laplace distribution
  of which the location parameter is <strong>$ave</strong> and the scale parameter is <strong>$stdev</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>      The value at which the probability density is calculated
  <info>float</info>  <strong>$ave</strong>    The location parameter of the distribution
  <info>float</info>  <strong>$stdev</strong>  The shape parameter of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_logistic
type: function
doc:
<comment>Description:</comment>
  Probability density function of the logistic distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the logistic distribution
  of which the location parameter is <strong>$ave</strong> and the scale parameter is <strong>$stdev</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>      The value at which the probability density is calculated
  <info>float</info>  <strong>$ave</strong>    The location parameter of the distribution
  <info>float</info>  <strong>$stdev</strong>  The shape parameter of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_normal
type: function
doc:
<comment>Description:</comment>
  Probability density function of the normal distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the normal distribution
  of which the mean is <strong>$ave</strong> and the standard deviation is <strong>$stdev</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>      The value at which the probability density is calculated
  <info>float</info>  <strong>$ave</strong>    The mean of the distribution
  <info>float</info>  <strong>$stdev</strong>  The standard deviation of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_pmf_binomial
type: function
doc:
<comment>Description:</comment>
  Probability mass function of the binomial distribution
  
  Returns the probability mass at <strong>$x</strong>, where the random variable follows the binomial distribution of
  which the number of trials is <strong>$n</strong> and the success rate is <strong>$pi</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>   The value at which the probability mass is calculated
  <info>float</info>  <strong>$n</strong>   The number of trials of the distribution
  <info>float</info>  <strong>$pi</strong>  The success rate of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability mass at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_pmf_hypergeometric
type: function
doc:
<comment>Description:</comment>
  Probability mass function of the hypergeometric distribution
  
  Returns the probability mass at <strong>$n1</strong>, where the random variable follows the hypergeometric
  distribution of which the number of failure is <strong>$n2</strong>, the number of success samples is <strong>$N1</strong>, and the
  number of failure samples is <strong>$N2</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$n1</strong>  The number of success, at which the probability mass is calculated
  <info>float</info>  <strong>$n2</strong>  The number of failure of the distribution
  <info>float</info>  <strong>$N1</strong>  The number of success samples of the distribution
  <info>float</info>  <strong>$N2</strong>  The number of failure samples of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability mass at <strong>$n1</strong> or <info>false</info> for failure.


id: stats_dens_pmf_negative_binomial
type: function
doc:
<comment>Description:</comment>
  Probability mass function of the negative binomial distribution
  
  Returns the probability mass at <strong>$x</strong>, where the random variable follows the negative binomial
  distribution of which the number of the success is <strong>$n</strong> and the success rate is <strong>$pi</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>   The value at which the probability mass is calculated
  <info>float</info>  <strong>$n</strong>   The number of the success of the distribution
  <info>float</info>  <strong>$pi</strong>  The success rate of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability mass at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_pmf_poisson
type: function
doc:
<comment>Description:</comment>
  Probability mass function of the Poisson distribution
  
  Returns the probability mass at <strong>$x</strong>, where the random variable follows the Poisson distribution
  whose parameter is <strong>$lb</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>   The value at which the probability mass is calculated
  <info>float</info>  <strong>$lb</strong>  The parameter of the Poisson distribution

<comment>Return:</comment>
  <info>float</info>  The probability mass at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_t
type: function
doc:
<comment>Description:</comment>
  Probability density function of the t-distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the t-distribution of
  which the degree of freedom is <strong>$dfr</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>    The value at which the probability density is calculated
  <info>float</info>  <strong>$dfr</strong>  The degree of freedom of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_uniform
type: function
doc:
<comment>Description:</comment>
  Probability density function of the uniform distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the uniform distribution
  of which the lower bound is <strong>$a</strong> and the upper bound is <strong>$b</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  The value at which the probability density is calculated
  <info>float</info>  <strong>$a</strong>  The lower bound of the distribution
  <info>float</info>  <strong>$b</strong>  The upper bound of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_dens_weibull
type: function
doc:
<comment>Description:</comment>
  Probability density function of the Weibull distribution
  
  Returns the probability density at <strong>$x</strong>, where the random variable follows the Weibull distribution
  of which the shape parameter is <strong>$a</strong> and the scale parameter is <strong>$b</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  The value at which the probability density is calculated
  <info>float</info>  <strong>$a</strong>  The shape parameter of the distribution
  <info>float</info>  <strong>$b</strong>  The scale parameter of the distribution

<comment>Return:</comment>
  <info>float</info>  The probability density at <strong>$x</strong> or <info>false</info> for failure.


id: stats_harmonic_mean
type: function
doc:
<comment>Description:</comment>
  Returns the harmonic mean of an array of values
  
  Returns the harmonic mean of the values in <strong>$a</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$a</strong>  The input array

<comment>Return:</comment>
  <info>number</info>  Returns the harmonic mean of the values in <strong>$a</strong>, or <info>false</info> if <strong>$a</strong> is empty or is not an array.


id: stats_kurtosis
type: function
doc:
<comment>Description:</comment>
  Computes the kurtosis of the data in the array
  
  Returns the kurtosis of the values in <strong>$a</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$a</strong>  The input array

<comment>Return:</comment>
  <info>float</info>  Returns the kurtosis of the values in <strong>$a</strong>, or <info>false</info> if <strong>$a</strong> is empty or is not an array.


id: stats_rand_gen_beta
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the beta distribution
  
  Returns a random deviate from the beta distribution with parameters A and B. The density of the
  beta is x^(a-1) * (1-x)^(b-1) / B(a,b) for 0 \< x \<. Method R. C. H. Cheng.

<comment>Param:</comment>
  <info>float</info>  <strong>$a</strong>  The shape parameter of the beta distribution
  <info>float</info>  <strong>$b</strong>  The shape parameter of the beta distribution

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_chisquare
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the chi-square distribution
  
  Returns a random deviate from the chi-square distribution where the degrees of freedom is  <strong>$df</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$df</strong>  The degrees of freedom

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_exponential
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the exponential distribution
  
  Returns a random deviate from the exponential distribution of which the scale is <strong>$av</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$av</strong>  The scale parameter

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_f
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the F distribution
  
  Generates a random deviate from the F (variance ratio) distribution with  "dfn" degrees of freedom
  in the numerator and "dfd" degrees of freedom in  the denominator. Method : directly generates
  ratio of chisquare variates.

<comment>Param:</comment>
  <info>float</info>  <strong>$dfn</strong>  The degrees of freedom in the numerator
  <info>float</info>  <strong>$dfd</strong>  The degrees of freedom in the denominator

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_funiform
type: function
doc:
<comment>Description:</comment>
  Generates uniform float between low (exclusive) and high (exclusive)
  
  Returns a random deviate from the uniform distribution from <strong>$low</strong> to <strong>$high</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$low</strong>   The lower bound (inclusive)
  <info>float</info>  <strong>$high</strong>  The upper bound (exclusive)

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_gamma
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the gamma distribution
  
  Generates a random deviate from the gamma distribution whose density is (A**R)/Gamma(R) * X**(R-1)
  * Exp(-A*X).

<comment>Param:</comment>
  <info>float</info>  <strong>$a</strong>  location parameter of Gamma distribution (<strong>$a</strong> &gt; 0).
  <info>float</info>  <strong>$r</strong>  shape parameter of Gamma distribution (<strong>$r</strong> &gt; 0).

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_ibinomial
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the binomial distribution
  
  Returns a random deviate from the binomial distribution whose number of trials is <strong>$n</strong> and whose
  probability of an event in each trial is <strong>$pp</strong>.

<comment>Param:</comment>
  <info>int</info>    <strong>$n</strong>   The number of trials
  <info>float</info>  <strong>$pp</strong>  The probability of an event in each trial

<comment>Return:</comment>
  <info>int</info>  A random deviate


id: stats_rand_gen_ibinomial_negative
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the negative binomial distribution
  
  Returns a random deviate from a negative binomial distribution where the number of success is <strong>$n</strong>
  and the success rate is <strong>$p</strong>.

<comment>Param:</comment>
  <info>int</info>    <strong>$n</strong>  The number of success
  <info>float</info>  <strong>$p</strong>  The success rate

<comment>Return:</comment>
  <info>int</info>  A random deviate, which is the number of failure.


id: stats_rand_gen_int
type: function
doc:
<comment>Description:</comment>
  Generates random integer between 1 and 2147483562
  
  Returns a random integer between 1 and 2147483562

<comment>Return:</comment>
  <info>int</info>  A random integer


id: stats_rand_gen_ipoisson
type: function
doc:
<comment>Description:</comment>
  Generates a single random deviate from a Poisson distribution
  
  Returns a random deviate from the Poisson distribution with parameter <strong>$mu</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$mu</strong>  The parameter of the Poisson distribution

<comment>Return:</comment>
  <info>int</info>  A random deviate


id: stats_rand_gen_iuniform
type: function
doc:
<comment>Description:</comment>
  Generates integer uniformly distributed between LOW (inclusive) and HIGH (inclusive)
  
  Returns a random integer from the discrete uniform distribution between <strong>$low</strong> (inclusive) and <strong>$high</strong>
  (inclusive).

<comment>Param:</comment>
  <info>int</info>  <strong>$low</strong>   The lower bound
  <info>int</info>  <strong>$high</strong>  The upper bound

<comment>Return:</comment>
  <info>int</info>  A random integer


id: stats_rand_gen_noncentral_chisquare
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the non-central chi-square distribution
  
  Returns a random deviate from the non-central chi-square distribution with degrees of freedom,
  <strong>$df</strong>, and non-centrality parameter, <strong>$xnonc</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$df</strong>     The degrees of freedom
  <info>float</info>  <strong>$xnonc</strong>  The non-centrality parameter

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_noncentral_f
type: function
doc:
<comment>Description:</comment>
  Generates a random deviate from the noncentral F distribution
  
  Returns a random deviate from the non-central F distribution where the degrees of freedoms are
  <strong>$dfn</strong> (numerator) and <strong>$dfd</strong> (denominator), and the non-centrality parameter is <strong>$xnonc</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$dfn</strong>    The degrees of freedom of the numerator
  <info>float</info>  <strong>$dfd</strong>    The degrees of freedom of the denominator
  <info>float</info>  <strong>$xnonc</strong>  The non-centrality parameter

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_noncentral_t
type: function
doc:
<comment>Description:</comment>
  Generates a single random deviate from a non-central t-distribution
  
  Returns a random deviate from the non-central t-distribution with the degrees of freedom, <strong>$df</strong>, and
  the non-centrality parameter, <strong>$xnonc</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$df</strong>     The degrees of freedom
  <info>float</info>  <strong>$xnonc</strong>  The non-centrality parameter

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_normal
type: function
doc:
<comment>Description:</comment>
  Generates a single random deviate from a normal distribution
  
  Returns a random deviate from the normal distribution with mean, <strong>$av</strong>, and standard deviation, <strong>$sd</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$av</strong>  The mean of the normal distribution
  <info>float</info>  <strong>$sd</strong>  The standard deviation of the normal distribution

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_gen_t
type: function
doc:
<comment>Description:</comment>
  Generates a single random deviate from a t-distribution
  
  Returns a random deviate from the t-distribution with the degrees of freedom, <strong>$df</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$df</strong>  The degrees of freedom

<comment>Return:</comment>
  <info>float</info>  A random deviate


id: stats_rand_get_seeds
type: function
doc:
<comment>Description:</comment>
  Get the seed values of the random number generator
  
  Returns the current seed values of the random number generator

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


id: stats_rand_phrase_to_seeds
type: function
doc:
<comment>Description:</comment>
  Generate two seeds for the RGN random number generator
  
  Generate two seeds for the random number generator from a <strong>$phrase</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$phrase</strong>  The input phrase

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


id: stats_rand_ranf
type: function
doc:
<comment>Description:</comment>
  Generates a random floating point number between 0 and 1
  
  Returns a random floating point number from a uniform distribution between 0 (exclusive) and  1
  (exclusive).

<comment>Return:</comment>
  <info>float</info>  A random floating point number


id: stats_rand_setall
type: function
doc:
<comment>Description:</comment>
  Set seed values to the random generator
  
  Set <strong>$iseed1</strong> and <strong>$iseed2</strong> as seed values to the random generator used in statistic functions.

<comment>Param:</comment>
  <info>int</info>  <strong>$iseed1</strong>  The value which is used as the random seed
  <info>int</info>  <strong>$iseed2</strong>  The value which is used as the random seed

<comment>Return:</comment>
  <info>void</info>  No values are returned.


id: stats_skew
type: function
doc:
<comment>Description:</comment>
  Computes the skewness of the data in the array
  
  Returns the skewness of the values in <strong>$a</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$a</strong>  The input array

<comment>Return:</comment>
  <info>float</info>  Returns the skewness of the values in <strong>$a</strong>, or <info>false</info> if <strong>$a</strong> is empty or is not an array.


id: stats_standard_deviation
type: function
doc:
<comment>Description:</comment>
  Returns the standard deviation
  
  Returns the standard deviation of the values in <strong>$a</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$a</strong>       The array of data to find the standard deviation for. Note that all  values of the
                  array will be cast to <info>float</info>.
  <info>bool</info>   <strong>$sample</strong>  Indicates if <strong>$a</strong> represents a sample of the  population; defaults to <info>false</info>.

<comment>Return:</comment>
  <info>float</info>  Returns the standard deviation on success; <info>false</info> on failure.


id: stats_stat_binomial_coef
type: function
doc:
<comment>Description:</comment>
  Returns a binomial coefficient
  
  Returns the binomial coefficient of <strong>$n</strong> choose <strong>$x</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$x</strong>  The number of chooses from the set
  <info>int</info>  <strong>$n</strong>  The number of elements in the set

<comment>Return:</comment>
  <info>float</info>  Returns the binomial coefficient


id: stats_stat_correlation
type: function
doc:
<comment>Description:</comment>
  Returns the Pearson correlation coefficient of two data sets
  
  Returns the Pearson correlation coefficient between <strong>$arr1</strong> and <strong>$arr2</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$arr1</strong>  The first array
  <info>array</info>  <strong>$arr2</strong>  The second array

<comment>Return:</comment>
  <info>float</info>  Returns the Pearson correlation coefficient between <strong>$arr1</strong> and <strong>$arr2</strong>, or <info>false</info> on failure.


id: stats_stat_factorial
type: function
doc:
<comment>Description:</comment>
  Returns the factorial of an integer
  
  Returns the factorial of an integer, <strong>$n</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$n</strong>  An integer

<comment>Return:</comment>
  <info>float</info>  The factorial of <strong>$n</strong>.


id: stats_stat_independent_t
type: function
doc:
<comment>Description:</comment>
  Returns the t-value from the independent two-sample t-test
  
  Returns the t-value of the independent two-sample t-test between <strong>$arr1</strong> and <strong>$arr2</strong>.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>array</info>  <strong>$arr1</strong>  The first set of values
  <info>array</info>  <strong>$arr2</strong>  The second set of values

<comment>Return:</comment>
  <info>float</info>  Returns the t-value, or <info>false</info> if failure.


id: stats_stat_innerproduct
type: function
doc:
<comment>Description:</comment>
  Returns the inner product of two vectors
  
  Returns the inner product of <strong>$arr1</strong> and <strong>$arr2</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$arr1</strong>  The first array
  <info>array</info>  <strong>$arr2</strong>  The second array

<comment>Return:</comment>
  <info>float</info>  Returns the inner product of <strong>$arr1</strong> and <strong>$arr2</strong>, or <info>false</info> on failure.


id: stats_stat_paired_t
type: function
doc:
<comment>Description:</comment>
  Returns the t-value of the dependent t-test for paired samples
  
  Returns the t-value of the dependent t-test for paired samples <strong>$arr1</strong> and <strong>$arr2</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$arr1</strong>  The first samples
  <info>array</info>  <strong>$arr2</strong>  The second samples

<comment>Return:</comment>
  <info>float</info>  Returns the t-value, or <info>false</info> if failure.


id: stats_stat_percentile
type: function
doc:
<comment>Description:</comment>
  Returns the percentile value
  
  Returns the <strong>$perc</strong>-th percentile value of the array <strong>$arr</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$arr</strong>   The input array
  <info>float</info>  <strong>$perc</strong>  The percentile

<comment>Return:</comment>
  <info>float</info>  Returns the percentile values of the input array.


id: stats_stat_powersum
type: function
doc:
<comment>Description:</comment>
  Returns the power sum of a vector
  
  Returns the sum of the <strong>$power</strong>-th power of a vector represented as an array <strong>$arr</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$arr</strong>    The input array
  <info>float</info>  <strong>$power</strong>  The power

<comment>Return:</comment>
  <info>float</info>  Returns the power sum of the input array.


id: stats_variance
type: function
doc:
<comment>Description:</comment>
  Returns the variance
  
  Returns the variance of the values in <strong>$a</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$a</strong>       The array of data to find the standard deviation for. Note that all  values of the
                  array will be cast to <info>float</info>.
  <info>bool</info>   <strong>$sample</strong>  Indicates if <strong>$a</strong> represents a sample of the  population; defaults to <info>false</info>.

<comment>Return:</comment>
  <info>float</info>  Returns the variance on success; <info>false</info> on failure.


id: stdClass
type: class
doc:
<comment>Description:</comment>
  Uma classe vazia genérica com propriedades dinâmicas.
  
  Objetos desta classe podem ser instaciados com o operador new ou criados por conversores de tipo
  para o objeto. Muitas funções do PHP também criam instâncias desta classe, ex.: <strong>json_decode()</strong>,
  <strong>mysqli_fetch_object()</strong> ou PDOStatement::fetchObject.
  
  Apesar de não implementar os métodos mágicos __get()/__set(), esta classe permite propriedades
  dinâmicas e não requer o atributo #[\AllowDynamicProperties].
  
  Esta não é uma classe base já que o PHP não possui um conceito de uma classe base universal.
  Entretanto, é possível criar uma classe customizada que se estende a partir de <class>stdClass</class> e como
  resultado herda a funcionalidade de propriedades dinâmicas.


id: stomp_connect_error
type: function
doc:
<comment>Description:</comment>
  Returns a string description of the last connect error
  
  Returns a string description of the last connect error.

<comment>Return:</comment>
  <info>string</info>  A string that describes the error, or <info>null</info> if no error occurred.


id: stomp_version
type: function
doc:
<comment>Description:</comment>
  Gets the current stomp extension version
  
  Returns a string containing the version of the current stomp extension.

<comment>Return:</comment>
  <info>string</info>  It returns the current stomp extension version


id: str_contains
type: function
doc:
<comment>Description:</comment>
  Determina se uma string contém uma substring fornecida
  
  Realiza uma busca case-sensitive indicando se <strong>$needle</strong> existe em <strong>$haystack</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  A string onde será feita a busca.
  <info>string</info>  <strong>$needle</strong>    A substring para ser buscada em <strong>$haystack</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se <strong>$needle</strong> está em <strong>$haystack</strong>, <info>false</info> caso contrário.

<comment>See Also:</comment>
   * <strong>str_ends_with()</strong>
   * <strong>str_starts_with()</strong>
   * <strong>stripos()</strong>
   * <strong>strrpos()</strong>
   * <strong>strripos()</strong>
   * <strong>strstr()</strong>
   * <strong>strpbrk()</strong>
   * <strong>substr()</strong>
   * <strong>preg_match()</strong>


id: str_decrement
type: function
doc:
<comment>Description:</comment>
  Decrement an alphanumeric string
  
  Returns the decremented alphanumeric ASCII <strong>$string</strong>.

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

<comment>Return:</comment>
  <info>string</info>  Returns the decremented alphanumeric ASCII string.

<comment>See Also:</comment>
   * <strong>str_increment()</strong>


id: str_ends_with
type: function
doc:
<comment>Description:</comment>
  Verifica se uma string termina com uma substring fornecida
  
  Realiza uma verificação case-sensitive indicando se <strong>$haystack</strong> termina com <strong>$needle</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  A string onde será feita a busca.
  <info>string</info>  <strong>$needle</strong>    A substring para procurar em <strong>$haystack</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se <strong>$haystack</strong> terminar com <strong>$needle</strong>, <info>false</info> caso contrário.

<comment>See Also:</comment>
   * <strong>str_contains()</strong>
   * <strong>str_starts_with()</strong>
   * <strong>stripos()</strong>
   * <strong>strrpos()</strong>
   * <strong>strripos()</strong>
   * <strong>strstr()</strong>
   * <strong>strpbrk()</strong>
   * <strong>substr()</strong>
   * <strong>preg_match()</strong>


id: str_getcsv
type: function
doc:
<comment>Description:</comment>
  Analisa uma string CSV e retorna os dados em um array
    
  
  Interpreta uma string de entrada procurando por campos no formato CSV e retorna um array contendo
  os campos encontrados.
  
  As configurações de localidade são levadas em consideração por esta função. Se <return>LC_CTYPE</return> for, por
  exemplo, <return>en_US.UTF-8</return>, strings com codificação de um byte podem ser lidas incorretamente por esta
  função.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>     A string a ser analisada.
  <info>string</info>  <strong>$separator</strong>  Define o delimitador de campos (somente um caractere de um byte).
  <info>string</info>  <strong>$enclosure</strong>  Define o caractere que envolve os campos (somente um caractere de um byte).
  <info>string</info>  <strong>$escape</strong>     Define o caractere de escape (no máximo um caractere de um byte). O valor
                      padrão é a barra invertida. (<return>\</return>) Uma string vazia (<return>""</return>) desabilita o mecanismo
                      proprietário de escape.
                      
                      Normalmente um caractere de <strong>$enclosure</strong> é escapado dentro do campo por
                      duplicação; entretanto, o caratere definido em <strong>$escape</strong> pode ser utilizado como
                      alternativa. Então, para os valores do parâmetro padrões <return>""</return> e <return>\"</return> têm o mesmo
                      significado. Além de permitir escapar o caractere de <strong>$enclosure</strong>, o caractere
                      de <strong>$escape</strong> não possui significado especial; nem mesmo para escapar a si mesmo.

<comment>Return:</comment>
  <info>array</info>  Retorna um array indexado contendo os campos lidos.

<comment>See Also:</comment>
   * <strong>fgetcsv()</strong>


id: str_increment
type: function
doc:
<comment>Description:</comment>
  Increment an alphanumeric string
  
  Returns the incremented alphanumeric ASCII <strong>$string</strong>.

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

<comment>Return:</comment>
  <info>string</info>  Returns the incremented alphanumeric ASCII string.

<comment>See Also:</comment>
   * <strong>str_decrement()</strong>


id: str_ireplace
type: function
doc:
<comment>Description:</comment>
  Case-insensitive version of str_replace
  
  This function returns a string or an array with all occurrences of <strong>$search</strong> in <strong>$subject</strong> (ignoring
  case) replaced with the given <strong>$replace</strong> value.
  
  To replace text based on a pattern rather than a fixed string, use <strong>preg_replace()</strong> with the <return>i</return>
  pattern modifier.

<comment>Param:</comment>
  <info>array|string</info>  <strong>$search</strong>   The value being searched for, otherwise known as the needle.  An array may
                          be used to designate multiple needles.
  <info>array|string</info>  <strong>$replace</strong>  The replacement value that replaces found <strong>$search</strong> values. An array may be
                          used to designate multiple replacements.
  <info>string|array</info>  <strong>$subject</strong>  The string or array being searched and replaced on, otherwise known as the
                          haystack.
                          
                          If <strong>$subject</strong> is an array, then the search and replace is performed with
                          every entry of  <strong>$subject</strong>, and the return value is an array as well.
  <info>int</info>           <strong>$count</strong>    If passed, this will be set to the number of replacements performed.

<comment>Return:</comment>
  <info>string|array</info>  Returns a string or an array of replacements.

<comment>See Also:</comment>
   * <strong>str_replace()</strong>
   * <strong>preg_replace()</strong>
   * <strong>strtr()</strong>


id: str_pad
type: function
doc:
<comment>Description:</comment>
  Pad a string to a certain length with another string
  
  This function returns the <strong>$string</strong> string padded on the left, the right, or both sides to the
  specified padding length. If the optional argument <strong>$pad_string</strong> is not supplied, the <strong>$string</strong> is
  padded with spaces, otherwise it is padded with characters from <strong>$pad_string</strong> up to the limit.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>      The input string.
  <info>int</info>     <strong>$length</strong>      The desired length of the final padded string. If the value of <strong>$length</strong> is
                       negative, less than, or equal to the length of the input string, no padding
                       takes place, and <strong>$string</strong> will be returned.
  <info>string</info>  <strong>$pad_string</strong>  The <strong>$pad_string</strong> may be truncated if the required number of padding characters
                       can't be evenly divided by the <strong>$pad_string</strong>'s length.
  <info>int</info>     <strong>$pad_type</strong>    Optional argument <strong>$pad_type</strong> can be <info>STR_PAD_RIGHT</info>, <info>STR_PAD_LEFT</info>, or
                       <info>STR_PAD_BOTH</info>. If <strong>$pad_type</strong> is not specified it is assumed to be
                       <info>STR_PAD_RIGHT</info>.

<comment>Return:</comment>
  <info>string</info>  Returns the padded string.

<comment>See Also:</comment>
   * <strong>mb_str_pad()</strong>


id: str_repeat
type: function
doc:
<comment>Description:</comment>
  Repete uma string
  
  Retorna a <strong>$string</strong> repetida pelo número de vezes definido em <strong>$times</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string a ser repetida.
  <info>int</info>     <strong>$times</strong>   Número de vezes que a <strong>$string</strong> será repetida.
                   
                   <strong>$times</strong> deve ser maior ou igual a 0. Se o parâmetro <strong>$times</strong> for 0, a função irá
                   retornar uma string vazia.

<comment>Return:</comment>
  <info>string</info>  Retorna a string repetida.

<comment>See Also:</comment>
   * for
   * <strong>str_pad()</strong>
   * <strong>substr_count()</strong>


id: str_replace
type: function
doc:
<comment>Description:</comment>
  Substitui todas as ocorrências da string de pesquisa com a string de substituição
  
  Esta função retorna uma string ou um array com todas as ocorrências de <strong>$search</strong> em <strong>$subject</strong>
  substituídas com o valor informado em <strong>$replace</strong>.
  
  Para substituir texto baseado em um padrão que não seja uma string fixa, use <strong>preg_replace()</strong>.

<comment>Param:</comment>
  <info>array|string</info>  <strong>$search</strong>   O valor sendo pesquisado, também conhecido como agulha. Um array pode ser
                          usado para designar múltiplas agulhas.
  <info>array|string</info>  <strong>$replace</strong>  O valor de substituição que será usado no lugar dos valores de <strong>$search</strong>
                          encontrados. Um array pode ser usado para deignar múltiplas substituições.
  <info>string|array</info>  <strong>$subject</strong>  A string ou array sendo pesquisado ou substituído, também conhecido como o
                          palheiro.
                          
                          Se <strong>$subject</strong> for um array, então a pesquisa e a substituição são executadas
                          com cada entrada de <strong>$subject</strong>, e o valor de retorno é um array também.
  <info>int</info>           <strong>$count</strong>    Se passado, será definido para o número de substituições realizadas.

<comment>Return:</comment>
  <info>string|array</info>  Esta função retorna uma string ou um array com os valores substituídos.

<comment>See Also:</comment>
   * <strong>str_ireplace()</strong>
   * <strong>substr_replace()</strong>
   * <strong>preg_replace()</strong>
   * <strong>strtr()</strong>


id: str_rot13
type: function
doc:
<comment>Description:</comment>
  Executa a transformação rot13 em uma string
  
  Executa a codificação ROT13 no argumento <strong>$string</strong> e retorna a string resultante.
  
  A codificação ROT13 simplesmente troca cada letra por 13 lugares no alfabeto, enquanto não muda os
  caracteres não alfabéticos. Codificação e decodificação são feitos pela mesma função, passando uma
  string codificada como argumento retornará a string com a versão original.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string de entrada.

<comment>Return:</comment>
  <info>string</info>  Retorna a versão ROT13 de uma dada string.


id: str_shuffle
type: function
doc:
<comment>Description:</comment>
  Embaralha uma string aleatoriamente
  
  <strong>str_shuffle()</strong> embaralha uma string. Uma permutação de todas as possíveis é criada.
  
  Esta função não gera valores criptograficamente seguros e não deve ser usada para propósitos
  criptográficos ou fins que exijam que os valores retornados sejam impossíveis de adivinhar.
  
  Se aleatoriedade criptograficamente segura for necessária, a classe <class>Random\Randomizer</class> pode ser
  usada com o mecanismo <class>Random\Engine\Secure</class>. Para casos de uso simples, as funções <strong>random_int()</strong> e
  <strong>random_bytes()</strong> fornecem uma API conveniente e segura que é garantida pelo CSPRNG do sistema
  operacional.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string de entrada.

<comment>Return:</comment>
  <info>string</info>  Retorna a string embaralhada.

<comment>See Also:</comment>
   * <strong>Random\Randomizer::shuffleBytes()</strong>
   * <strong>Random\Randomizer::shuffleArray()</strong>


id: str_split
type: function
doc:
<comment>Description:</comment>
  Convert a string to an array
  
  Converts a string to an array.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The input string.
  <info>int</info>     <strong>$length</strong>  Maximum length of the chunk.

<comment>Return:</comment>
  <info>array</info>  If the optional <strong>$length</strong> parameter is specified, the returned array will be broken down into
         chunks with each being <strong>$length</strong> in length, except the final chunk which may be shorter if
         the string does not divide evenly.  The default <strong>$length</strong> is <return>1</return>, meaning every chunk will be
         one byte in size.

<comment>See Also:</comment>
   * <strong>mb_str_split()</strong>
   * <strong>chunk_split()</strong>
   * <strong>preg_split()</strong>
   * <strong>explode()</strong>
   * <strong>count_chars()</strong>
   * <strong>str_word_count()</strong>
   * for


id: str_starts_with
type: function
doc:
<comment>Description:</comment>
  Verifica se uma string começa com uma substring fornecida
  
  Realiza uma verificação case-sensitive indicando se <strong>$haystack</strong> começa com <strong>$needle</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  A string onde será feita a busca.
  <info>string</info>  <strong>$needle</strong>    A substring para procurar em <strong>$haystack</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se <strong>$haystack</strong> começa com <strong>$needle</strong>, <info>false</info> caso contrário.

<comment>See Also:</comment>
   * <strong>str_contains()</strong>
   * <strong>str_ends_with()</strong>
   * <strong>stripos()</strong>
   * <strong>strrpos()</strong>
   * <strong>strripos()</strong>
   * <strong>strstr()</strong>
   * <strong>strpbrk()</strong>
   * <strong>substr()</strong>
   * <strong>preg_match()</strong>


id: str_word_count
type: function
doc:
<comment>Description:</comment>
  Retorna informação sobre palavras usadas em uma string
    
  
  Conta o número de palavras dentro de <strong>$string</strong>. Se o parâmetro opcional <strong>$format</strong> não for
  especificado, então o valor de retorno será um inteiro representando o número de palavras
  encontradas. Caso <strong>$format</strong> seja especificado, o valor de retorno será um array, cujo conteúdo é
  dependente de <strong>$format</strong>. Os valores possíveis para <strong>$format</strong> e as saídas resultantes estão listadas
  abaixo.
  
  Para o propósito desta função, 'palavra' é definida como uma string dependente da localidade
  contendo caracteres alfabéticos, que também podem conter, mas não iniciar com os caracteres "'"
  and "-". Note que localidades que utilizam caracteres multibyte não são suportadas.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>      A string
  <info>int</info>          <strong>$format</strong>      Especifica o valor de retorno desta função. Os valores atualmente
                            suportados são:  0 - retorna o número de palavras encontradas  1 -
                            retorna um array contendo todas as palavras encontradas dentro da
                            <strong>$string</strong>  2 - retorna um array associativo, onde a chave é a posição
                            numérica da palavra dentro da <strong>$string</strong> e o valor é a própria palavra
                            
                            0 - retorna o número de palavras encontradas
                            
                            1 - retorna um array contendo todas as palavras encontradas dentro da
                            <strong>$string</strong>
                            
                            2 - retorna um array associativo, onde a chave é a posição numérica da
                            palavra dentro da <strong>$string</strong> e o valor é a própria palavra
  <info>string|null</info>  <strong>$characters</strong>  Uma lista de caracteres adicionais que serão considerados como
                            'palavra'.

<comment>Return:</comment>
  <info>array|int</info>  Retorna um array ou um inteiro, dependendo do parâmetro <strong>$format</strong>.

<comment>See Also:</comment>
   * <strong>explode()</strong>
   * <strong>preg_split()</strong>
   * <strong>count_chars()</strong>
   * <strong>substr_count()</strong>


id: strcasecmp
type: function
doc:
<comment>Description:</comment>
  Binary safe case-insensitive string comparison
  
  Binary safe case-insensitive string comparison. The comparison is not locale aware; only ASCII
  letters are compared in a case-insensitive way.

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>  The first string
  <info>string</info>  <strong>$string2</strong>  The second string

<comment>Return:</comment>
  <info>int</info>  Returns <return>-1</return> if <strong>$string1</strong> is less than <strong>$string2</strong>; <return>1</return> if <strong>$string1</strong> is greater than <strong>$string2</strong>, and <return>0</return>
       if they are equal.

<comment>See Also:</comment>
   * <strong>strcmp()</strong>
   * <strong>preg_match()</strong>
   * <strong>substr_compare()</strong>
   * <strong>strncasecmp()</strong>
   * <strong>stristr()</strong>
   * <strong>substr()</strong>


id: strchr
type: function
doc:
<comment>Description:</comment>
  Sinônimo de strstr
  
  Esta função é um apelido para:  <strong>strstr()</strong>.


id: strcmp
type: function
doc:
<comment>Description:</comment>
  Binary safe string comparison
  
  Note that this comparison is case sensitive.

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>  The first string.
  <info>string</info>  <strong>$string2</strong>  The second string.

<comment>Return:</comment>
  <info>int</info>  Returns <return>-1</return> if <strong>$string1</strong> is less than <strong>$string2</strong>; <return>1</return> if <strong>$string1</strong> is greater than <strong>$string2</strong>, and <return>0</return>
       if they are equal.

<comment>See Also:</comment>
   * <strong>strcasecmp()</strong>
   * <strong>preg_match()</strong>
   * <strong>substr_compare()</strong>
   * <strong>strncmp()</strong>
   * <strong>strstr()</strong>
   * <strong>substr()</strong>


id: strcoll
type: function
doc:
<comment>Description:</comment>
  Locale based string comparison
  
  Note that this comparison is case sensitive, and unlike <strong>strcmp()</strong> this function is not binary safe.
  
  <strong>strcoll()</strong> uses the current locale for doing the comparisons.  If the current locale is C or POSIX,
  this function is equivalent to <strong>strcmp()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>  The first string.
  <info>string</info>  <strong>$string2</strong>  The second string.

<comment>Return:</comment>
  <info>int</info>  Returns \< 0 if <strong>$string1</strong> is less than <strong>$string2</strong>; &gt; 0 if <strong>$string1</strong> is greater than <strong>$string2</strong>,
       and 0 if they are equal.

<comment>See Also:</comment>
   * <strong>preg_match()</strong>
   * <strong>strcmp()</strong>
   * <strong>strcasecmp()</strong>
   * <strong>substr()</strong>
   * <strong>stristr()</strong>
   * <strong>strncasecmp()</strong>
   * <strong>strncmp()</strong>
   * <strong>strstr()</strong>
   * <strong>setlocale()</strong>


id: strcspn
type: function
doc:
<comment>Description:</comment>
  Encontra o tamanho do segmento inicial que não corresponde à máscara
  
  Retorna o tamanho do segmento inicial de <strong>$string</strong> que não contiver nenhum dos caracteres definidos
  no parâmetro <strong>$characters</strong>.
  
  Se <strong>$offset</strong> e <strong>$length</strong> forem omitidos, então tudo da <strong>$string</strong> será examinado. Se forem incluídos,
  então o efeito será o mesmo que chamar <return>strcspn(substr($string, $offset, $length), $characters)</return>
  (consulte  para mais informações).

<comment>Param:</comment>
  <info>string</info>    <strong>$string</strong>      O string a ser examinado.
  <info>string</info>    <strong>$characters</strong>  A string contendo os caracteres não permitidos.
  <info>int</info>       <strong>$offset</strong>      A posição na <strong>$string</strong> para iniciar a pesquisa.
                         
                         Se <strong>$offset</strong> for informado e não negativo, a função <strong>strcspn()</strong> começará a
                         examinar a <strong>$string</strong> na posição <strong>$offset</strong>. Por exemplo, na string '<return>abcdef</return>', o
                         caractere na posição <return>0</return> é '<return>a</return>', na posição <return>2</return> é '<return>c</return>', e assim por diante.
                         
                         Se <strong>$offset</strong> for informado e negativo, a função <strong>strcspn()</strong> começará a examinar
                         a <strong>$string</strong> na posição <strong>$offset</strong> a partir do final da <strong>$string</strong>.
  <info>int|null</info>  <strong>$length</strong>      O tamanho do segmento da <strong>$string</strong> a ser examinado.
                         
                         Se <strong>$length</strong> for informado e não negativo, a <strong>$string</strong> será examinada pelo
                         número de caracteres em <strong>$length</strong> a partir da posição inicial.
                         
                         Se <strong>$length</strong> for informado e negativo, a <strong>$string</strong> será examinada a partir da
                         posição inicial até o número de caracteres informado em <strong>$length</strong> contados a
                         partir do final da <strong>$string</strong>.

<comment>Return:</comment>
  <info>int</info>  Retorna o tamanho do segmento inicial da <strong>$string</strong> que consiste inteiramente de caracteres que
       não estejam em <strong>$characters</strong>.
       
       Quando <strong>$offset</strong> estiver definido, o tamanho retornado é contado a partir deste posição, e não
       a partir do início da <strong>$string</strong>.

<comment>See Also:</comment>
   * <strong>strspn()</strong>


id: streamWrapper
type: class
doc:
<comment>Description:</comment>
  Permite que o usuário implemente seus próprios fluxos e manipuladores de protocolo para uso com
  todas as outras funções de sistema de arquivos (como <strong>fopen()</strong>, <strong>fread()</strong> etc.).
  
  Esta NÃO É uma classe verdadeira, apenas um protótipo de como uma classe que define seu próprio
  protocolo deve ser.
  
  Implementar os métodos de forma diferente da descrita aqui pode levar a comportamentos
  indefinidos.
  
  Uma instância desta classe é inicializada assim que uma função de fluxo tenta acessar o protocolo
  ao qual está associada.


id: streamWrapper::__construct
type: function
doc:
<comment>Description:</comment>
  Constrói um novo empacotador de fluxo
  
  Chamado na abertura do empacotador de fluxo, logo antes de streamWrapper::stream_open.


id: streamWrapper::__destruct
type: function
doc:
<comment>Description:</comment>
  Destrói um empacotador de fluxo existente
  
  Chamado no fechamento do empacotador de fluxo, logo antes de streamWrapper::stream_flush.


id: streamWrapper::dir_closedir
type: function
doc:
<comment>Description:</comment>
  Fecha o manipulador de diretório
  
  Este método é chamado em resposta a <strong>closedir()</strong>.
  
  Quaisquer recursos que estavam travados ou alocados durante abertura e uso do fluxo de diretório
  devem ser liberados.

<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>closedir()</strong>
   * streamWrapper::dir_opendir


id: streamWrapper::dir_opendir
type: function
doc:
<comment>Description:</comment>
  Abre um manipulador de diretório
  
  Este método é chamado em resposta a <strong>opendir()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>     Especifica a URL que foi passada a <strong>opendir()</strong>.
                    
                    A URL pode ser quebrada em partes com <strong>parse_url()</strong>.
  <info>int</info>     <strong>$options</strong>  

<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>opendir()</strong>
   * streamWrapper::dir_closedir
   * <strong>parse_url()</strong>


id: streamWrapper::dir_readdir
type: function
doc:
<comment>Description:</comment>
  Lê entrada do manipulador de diretório
  
  Este método é chamado em resposta a <strong>readdir()</strong>.

<comment>Return:</comment>
  <info>string</info>  Deve retornar uma <info>string</info> representando a próxima entrada, ou <info>false</info> se não existir uma
          próxima.
          
          O valor de retorno será convertido para <info>string</info>.

<comment>See Also:</comment>
   * <strong>readdir()</strong>


id: streamWrapper::dir_rewinddir
type: function
doc:
<comment>Description:</comment>
  Retrocede um manipulador de diretório
  
  Este método é chamado em resposta a <strong>rewinddir()</strong>.
  
  Deve redefinir a saída gerada por streamWrapper::dir_readdir. Isto é, a próxima chamada a
  streamWrapper::dir_readdir deve retornar a primeira entrada na localização retornada por
  streamWrapper::dir_opendir.

<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>rewinddir()</strong>
   * streamWrapper::dir_readdir


id: streamWrapper::mkdir
type: function
doc:
<comment>Description:</comment>
  Cria um diretório
  
  Este método é chamado em resposta a <strong>mkdir()</strong>.
  
  Para que sejam retornadas mensagens de erro apropriadas, este método não deve ser definido se o
  empacotador não suporta criação de diretórios.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>     Diretório a ser criado.
  <info>int</info>     <strong>$mode</strong>     O valor passado à função <strong>mkdir()</strong>.
  <info>int</info>     <strong>$options</strong>  Uma máscara de bits convertida em valores, como <info>STREAM_MKDIR_RECURSIVE</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>
   * <strong>mkdir()</strong>
   * streamwrapper::rmdir


id: streamWrapper::rename
type: function
doc:
<comment>Description:</comment>
  Renomeia um arquivo ou diretório
  
  Este método é chamado em resposta a <strong>rename()</strong>.
  
  Tenta renomear <strong>$path_from</strong> para <strong>$path_to</strong>
  
  Para que sejam retornadas mensagens de erro apropriadas, este método não deve ser definido se o
  empacotador não suporta renomear arquivos.

<comment>Param:</comment>
  <info>string</info>  <strong>$path_from</strong>  A URL do arquivo atual.
  <info>string</info>  <strong>$path_to</strong>    A URL para a qual <strong>$path_from</strong> deve ser renomeada.

<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>rename()</strong>


id: streamWrapper::rmdir
type: function
doc:
<comment>Description:</comment>
  Remove um diretório
  
  Este método é chamado em resposta a <strong>rmdir()</strong>.
  
  Para que sejam retornadas mensagens de erro apropriadas, este método não deve ser definido se o
  empacotador não suporta remoção de diretórios.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>     URL do diretório a ser removido.
  <info>int</info>     <strong>$options</strong>  Uma máscara de bits convertida em valores, como <info>STREAM_MKDIR_RECURSIVE</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>
   * <strong>rmdir()</strong>
   * streamwrapper::mkdir
   * streamwrapper::unlink


id: streamWrapper::stream_cast
type: function
doc:
<comment>Description:</comment>
  Obtém o recurso subjacente
  
  Este método é chamado em resposta a <strong>stream_select()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$cast_as</strong>  Pode ser <info>STREAM_CAST_FOR_SELECT</info> quando <strong>stream_select()</strong> estiver chamando
                 <strong>stream_cast()</strong> ou <info>STREAM_CAST_AS_STREAM</info> quando <strong>stream_cast()</strong> for chamado para outros
                 usos.

<comment>Return:</comment>
  <info>resource</info>  Deve retornar o recurso de fluxo subjacente usado pelo empacotador, ou <info>false</info>.

<comment>See Also:</comment>
   * <strong>stream_select()</strong>


id: streamWrapper::stream_close
type: function
doc:
<comment>Description:</comment>
  Fecha um recurso
  
  Este método é chamado em resposta a <strong>fclose()</strong>.
  
  Todos os recursos que estavam travados ou alocados pelo empacotador devem ser liberados.

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

<comment>See Also:</comment>
   * <strong>fclose()</strong>
   * streamWrapper::dir_closedir


id: streamWrapper::stream_eof
type: function
doc:
<comment>Description:</comment>
  Teste para fim de arquivo em ponteiros
  
  Este método é chamado em resposta a <strong>feof()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Deve retornar <info>true</info> se a posição de leitura/escrita estiver no final do fluxo e se não houver
        mais dados disponíveis para leitura, ou <info>false</info> caso contrário.

<comment>See Also:</comment>
   * <strong>feof()</strong>


id: streamWrapper::stream_flush
type: function
doc:
<comment>Description:</comment>
  Descarrega a saída
  
  Este método é chamado em resposta a <strong>fflush()</strong> e quando o fluxo está sendo fechado enquanto dados
  não descarregados foram anteriormente escritos nele.
  
  Se houver dados em cache no fluxo porém ainda não armazenados, este é o momento de armazená-los.

<comment>Return:</comment>
  <info>bool</info>  Deve retornar <info>true</info> se os dados em cache foram armazenados com sucesso (ou se não havia dados
        para armazenar), or <info>false</info> se os dados não puderam ser armazenados.

<comment>See Also:</comment>
   * <strong>fflush()</strong>


id: streamWrapper::stream_lock
type: function
doc:
<comment>Description:</comment>
  Travamento de aviso para arquivos
  
  Este método é chamado em resposta a <strong>flock()</strong>, em <strong>file_put_contents()</strong> (quando <strong>$flags</strong> contiver
  <info>LOCK_EX</info>), em <strong>stream_set_blocking()</strong> e no fechamento do fluxo (<info>LOCK_UN</info>).

<comment>Param:</comment>
  <info>int</info>  <strong>$operation</strong>  <strong>$operation</strong> pode ser um dos seguintes: <info>LOCK_SH</info> para obter uma trava compartilhada
                   (leitura). <info>LOCK_EX</info> para obter uma trava exclusiva (escrita). <info>LOCK_UN</info> para liberar
                   uma trava (compartilhada ou exclusiva). <info>LOCK_NB</info> se não for desejado que <strong>flock()</strong>
                   bloqueie durante a trava. (não suportado no Windows)
                   
                   <info>LOCK_SH</info> para obter uma trava compartilhada (leitura).
                   
                   <info>LOCK_EX</info> para obter uma trava exclusiva (escrita).
                   
                   <info>LOCK_UN</info> para liberar uma trava (compartilhada ou exclusiva).
                   
                   <info>LOCK_NB</info> se não for desejado que <strong>flock()</strong> bloqueie durante a trava. (não suportado
                   no Windows)

<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>stream_set_blocking()</strong>
   * <strong>flock()</strong>


id: streamWrapper::stream_metadata
type: function
doc:
<comment>Description:</comment>
  Alterar metadados de fluxo
  
  Este método é chamado para definir metadados no fluxo. É chamado quando uma das funções a seguir é
  chamada em uma URL de fluxo: <strong>touch()</strong><strong>chmod()</strong><strong>chown()</strong><strong>chgrp()</strong> Favor notar que algumas destas operações
  podem não estar disponíveis no sistema.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>    O caminho ou URL de arquivo para configurar os metadados. Note que no caso de uma
                   URL, deve haver um :// delimitando-a. Outras formas de URL não são suportadas.
  <info>int</info>     <strong>$option</strong>  Uma das opções: <info>STREAM_META_TOUCH</info> (método foi chamado em resposta a
                   <strong>touch()</strong>)<info>STREAM_META_OWNER_NAME</info> (método foi chamado em resposta a <strong>chown()</strong> com
                   parâmetro string)<info>STREAM_META_OWNER</info> (método foi chamado em resposta a
                   <strong>chown()</strong>)<info>STREAM_META_GROUP_NAME</info> (método foi chamado em resposta a
                   <strong>chgrp()</strong>)<info>STREAM_META_GROUP</info> (método foi chamado em resposta a
                   <strong>chgrp()</strong>)<info>STREAM_META_ACCESS</info> (método foi chamado em resposta a <strong>chmod()</strong>)
  <info>mixed</info>   <strong>$value</strong>   Se a opção for <strong>$option</strong> <info>STREAM_META_TOUCH</info>: <info>Array</info> consistindo de dois argumentos da
                   função <strong>touch()</strong>.<info>STREAM_META_OWNER_NAME</info> ou <info>STREAM_META_GROUP_NAME</info>: O nome do
                   usuário/grupo proprietário, como uma <info>string</info>.<info>STREAM_META_OWNER</info> ou
                   <info>STREAM_META_GROUP</info>: O valor do usuário/grupo proprietário, como um
                   <info>int</info>.<info>STREAM_META_ACCESS</info>: O argumento de <strong>chmod()</strong>, como <info>int</info>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. Se a opção (<strong>$option</strong>) não estiver
        implementada, <info>false</info> deve ser retornado.

<comment>See Also:</comment>
   * <strong>touch()</strong>
   * <strong>chmod()</strong>
   * <strong>chown()</strong>
   * <strong>chgrp()</strong>


id: streamWrapper::stream_open
type: function
doc:
<comment>Description:</comment>
  Abre arquivo ou URL
  
  Este método é chamado imediatamente após o empacotador ser inicializado (por exemplo por <strong>fopen()</strong> e
  <strong>file_get_contents()</strong>).

<comment>Param:</comment>
  <info>string</info>       <strong>$path</strong>         Especifica a URL que foi passada à função original.
                             
                             A URL pode ser quebrada em partes com <strong>parse_url()</strong>. Note que apenas URLs
                             delimitadas por :// são suportadas. : e :/ são delimitadores
                             tecnicamente válidos, porém não suportados.
  <info>string</info>       <strong>$mode</strong>         O modo usado para abrir o arquivo, como detalhado para <strong>fopen()</strong>.
                             
                             Importante lembrar de verificar se o parâmetro <strong>$mode</strong> é válido para o
                             caminho (<strong>$path</strong>) requisitado.
  <info>int</info>          <strong>$options</strong>      Contém opções adicionais definidas pela API de fluxos. Pode conter uma
                             ou mais das opcções a seguir somadas (com a operação OR).
                             OpçãoDescrição<info>STREAM_USE_PATH</info>Se o caminho <strong>$path</strong> for relativo, a
                             pesquisa pelo recurso utilizará include_path. <info>STREAM_REPORT_ERRORS</info>Se
                             esta opção estiver definida, o programador é responsável por emitir
                             erros usando <strong>trigger_error()</strong> durante abertura do fluxo. Se não estiver
                             definida, o programador não deve emitir erros.
  <info>string|null</info>  <strong>$opened_path</strong>  Se o caminho <strong>$path</strong> for aberto com sucesso, e <info>STREAM_USE_PATH</info> estiver
                             definida em <strong>$options</strong>, <strong>$opened_path</strong> deve ser definida para o caminho
                             completo do arquivo/recurso que foi realmente aberto.

<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>fopen()</strong>
   * <strong>parse_url()</strong>


id: streamWrapper::stream_read
type: function
doc:
<comment>Description:</comment>
  Lê dados do fluxo
  
  Este método é chamado em resposta a <strong>fread()</strong> e <strong>fgets()</strong>.
  
  Lembre-se de atualizar a posição de leitura/escrita do fluxo (com o número de bytes lidos com
  sucesso).

<comment>Param:</comment>
  <info>int</info>  <strong>$count</strong>  Quantos bytes de dados da posição atual devem ser retornados.

<comment>Return:</comment>
  <info>string|false</info>  Se houver menos bytes disponíveis que <strong>$count</strong>, devem ser retornados quantos estiverem
                disponíveis. Se não houver mais dados, uma string vazia deve ser retornada. Para
                sinalizar que a leitura falhou, <info>false</info> deve ser retornado.

<comment>See Also:</comment>
   * <strong>fread()</strong>
   * <strong>fgets()</strong>


id: streamWrapper::stream_seek
type: function
doc:
<comment>Description:</comment>
  Pesquisa uma localização específica em um fluxo
  
  Este método é chamado em resposta a <strong>fseek()</strong>.
  
  A posição de leitura/escrita do fluxo deve ser atualizada de acordo com os parâmetros <strong>$offset</strong> e
  <strong>$whence</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  O deslocamento no fluxo a pesquisar.
  <info>int</info>  <strong>$whence</strong>  Valores posssíveis: <info>SEEK_SET</info> - Definir a posição igual ao número de bytes em
                <strong>$offset</strong>.<info>SEEK_CUR</info> - Definir a poisção igual à localização atual mais <strong>$offset</strong>.<info>SEEK_END</info>
                - Definir a poisção do fim do arquivo mais <strong>$offset</strong>.
                
                A implementação atual nunca define o parâmetro <strong>$whence</strong> para <info>SEEK_CUR</info>; em vez disso,
                tais pesquisas são internamente convertidas para pesquisas <info>SEEK_SET</info>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se a posição foi atualizada, <info>false</info> caso contrário.

<comment>See Also:</comment>
   * <strong>fseek()</strong>


id: streamWrapper::stream_set_option
type: function
doc:
<comment>Description:</comment>
  Altera as opções do fluxo
  
  Este método é chamado para definir as opções no fluxo.

<comment>Param:</comment>
  <info>int</info>  <strong>$option</strong>  Uma das opções: <info>STREAM_OPTION_BLOCKING</info> (o método foi chamado em resposta a
                <strong>stream_set_blocking()</strong>)<info>STREAM_OPTION_READ_TIMEOUT</info> (o método foi chamado em resposta a
                <strong>stream_set_timeout()</strong>)<info>STREAM_OPTION_WRITE_BUFFER</info> (o método foi chamado em resposta a
                <strong>stream_set_write_buffer()</strong>)
  <info>int</info>  <strong>$arg1</strong>    Se <strong>$option</strong> for <info>STREAM_OPTION_BLOCKING</info>: modo de bloqueio requerido (1 significa
                bloqueio e 0 sem bloqueio).<info>STREAM_OPTION_READ_TIMEOUT</info>: limite de tempo em
                segundos.<info>STREAM_OPTION_WRITE_BUFFER</info>: modo de buffer (<info>STREAM_BUFFER_NONE</info> ou
                <info>STREAM_BUFFER_FULL</info>).
  <info>int</info>  <strong>$arg2</strong>    Se <strong>$option</strong> for <info>STREAM_OPTION_BLOCKING</info>: esta opção não está
                definida.<info>STREAM_OPTION_READ_TIMEOUT</info>: limite de tempo em
                microssegundos.<info>STREAM_OPTION_WRITE_BUFFER</info>: tamanho do buffer requerido.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. Se <strong>$option</strong> não for implementada,
        <info>false</info> deve ser retornado.

<comment>See Also:</comment>
   * <strong>stream_set_blocking()</strong>
   * <strong>stream_set_timeout()</strong>
   * <strong>stream_set_write_buffer()</strong>


id: streamWrapper::stream_stat
type: function
doc:
<comment>Description:</comment>
  Obtém informação sobre um recurso de arquivo
  
  Este método é chamado em resposta a <strong>fstat()</strong>.

<comment>Return:</comment>
  <info>array|false</info>  Consulte <strong>stat()</strong>.

<comment>See Also:</comment>
   * <strong>stat()</strong>
   * streamwrapper::url_stat


id: streamWrapper::stream_tell
type: function
doc:
<comment>Description:</comment>
  Obtém a posição atual de um fluxo
  
  Este método é chamado em resposta a <strong>fseek()</strong> para determinar a posição atual.

<comment>Return:</comment>
  <info>int</info>  Deve retornar a posição atual do fluxo.

<comment>See Also:</comment>
   * streamWrapper::stream_tell


id: streamWrapper::stream_truncate
type: function
doc:
<comment>Description:</comment>
  Trunca o fluxo
  
  Irá responder ao truncamento, isto é, através da função <strong>ftruncate()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$new_size</strong>  O novo tamanho.

<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: streamWrapper::stream_write
type: function
doc:
<comment>Description:</comment>
  Escreve no fluxo
  
  Este método é chamado em resposta a <strong>fwrite()</strong>.
  
  Lembre-se de atualizar a posição atual do fluxo com o número de bytes que foram escritos com
  sucesso.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Deve ser armazenado no fluxo subjacente.
                 
                 Se não houver espaço suficiente no fluxo subjacente, armazena o quanto for
                 possível.

<comment>Return:</comment>
  <info>int</info>  Deve retornar o número de bytes que foram armazenados com sucesso, ou 0 se nenhum pôde ser
       armazenado.

<comment>See Also:</comment>
   * <strong>fwrite()</strong>


id: streamWrapper::unlink
type: function
doc:
<comment>Description:</comment>
  Remove um arquivo
  
  Este método é chamado em resposta a <strong>unlink()</strong>.
  
  Para que a mensagem de erro apropriada seja retornada, este método não deve ser definido se o
  empacotador não suportar remoção de arquivos.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  A URL do arquivo que deve ser removido.

<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>unlink()</strong>
   * streamWrapper::rmdir


id: streamWrapper::url_stat
type: function
doc:
<comment>Description:</comment>
  Obtém informação sobre um arquivo
  
  Este método é chamado em resposta a todas as funções relacionadas a <strong>stat()</strong>, como:
  <strong>copy()</strong><strong>fileperms()</strong><strong>fileinode()</strong><strong>filesize()</strong><strong>fileowner()</strong><strong>filegroup()</strong><strong>fileatime()</strong><strong>filemtime()</strong><strong>filectime()</strong><strong>filetype()</strong><strong>is_writable()</strong><strong>is_readable()</strong><strong>is_executable()</strong><strong>is_file()</strong><strong>is_dir()</strong><strong>is_link()</strong><strong>file_exists()</strong><strong>lstat()</strong><strong>stat()</strong>SplFileInfo::getPermsSplFileInfo::getInodeSplFileInfo::getSizeSplFileInfo::getOwnerSplFileInfo::getGroupSplFileInfo::getATimeSplFileInfo::getMTimeSplFileInfo::getCTimeSplFileInfo::getTypeSplFileInfo::isWritableSplFileInfo::isReadableSplFileInfo::isExecutableSplFileInfo::isFileSplFileInfo::isDirSplFileInfo::isLinkRecursiveDirectoryIterator::hasChildren

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>   O caminho ou URL do arquivo a explorar. Note que no caso de uma URL, ela deve ser
                  delimitada com ://. Outras formas de URL não são suportadas.
  <info>int</info>     <strong>$flags</strong>  Contém opções adicionais configuradas pela API de fluxos. Pode conter uma ou mais
                  dos valores a seguir somados (com a operação OR).
                  OpçãoDescriçãoSTREAM_URL_STAT_LINK Para recursos com a habilidade de criar atalho
                  a outro recurso (como um redirecionamento HTTP ou uma ligação simbólica do sistema
                  de arquivos). Esta opção especifica que apenas informação sobre o atalho em si
                  deve ser retornada, e não sobre o recurso apontado pelo atalho. Esta função é
                  definida em resposta a chamadas a <strong>lstat()</strong>, <strong>is_link()</strong> ou <strong>filetype()</strong>.
                  STREAM_URL_STAT_QUIETSe esta opção for definida, o empacotador não deve emitir
                  erros. Se a opção não for definida, o programador é responsável por reportar erros
                  usando a função <strong>trigger_error()</strong> durante a obtenção de informações sobre o arquivo.

<comment>Return:</comment>
  <info>array|false</info>  Deve retornar um <info>array</info> com os mesmos elementdos que <strong>stat()</strong> retorna. Valores
               desconhecidos ou indisponíveis devem ser definidos para um valor racional
               (normalmente <info>0</info>). Atenção especial deve ser prestada ao <return>modo</return> como documentado na
               função <strong>stat()</strong>. Deve retornar <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>stat()</strong>
   * streamwrapper::stream_stat


id: stream_bucket_append
type: function
doc:
<comment>Description:</comment>
  Anexa o bucket à brigada
    
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: stream_bucket_make_writeable
type: function
doc:
<comment>Description:</comment>
  Retorna um objeto bucket da brigada para se operar sobre ele
    
  
  Esta função é chamada sempre que existir a necessidade de acessar e operar no conteúdo de uma
  brigada. É tipicamente chamada por php_user_filter::filter.

<comment>Param:</comment>
  <info>resource</info>  <strong>$brigade</strong>  A brigada da qual se retornará o objeto bucket.

<comment>Return:</comment>
  <info>object|null</info>  Retorna um objeto bucket com as propriedades listadas abaixo ou <info>null</info>. data (<info>string</info>)
               <strong>$data</strong><return>bucket</return> A string atual no bucket. datalen (<info>integer</info>) <strong>$datalen</strong><return>bucket</return> O comprimento
               da string no bucket.
               
               <strong>$data</strong><return>bucket</return> A string atual no bucket.
               
               <strong>$datalen</strong><return>bucket</return> O comprimento da string no bucket.

<comment>See Also:</comment>
   * <strong>stream_bucket_append()</strong>
   * <strong>stream_bucket_prepend()</strong>


id: stream_bucket_new
type: function
doc:
<comment>Description:</comment>
  Cria um novo bucket para uso no fluxo atual
    
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: stream_bucket_prepend
type: function
doc:
<comment>Description:</comment>
  Adiciona um bucket ao início da brigada
    
  
  Esta função pode ser chamada para adicionar um bucket ao início da brigada. É tipicamente chamada
  por php_user_filter::filter.

<comment>Param:</comment>
  <info>resource</info>  <strong>$brigade</strong>  <strong>$brigade</strong> é um recurso que aponta para uma <return>brigada de bucket</return> que contém um ou
                      mais objetos <return>bucket</return>.
  <info>object</info>    <strong>$bucket</strong>   Um objeto bucket.

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


id: stream_context_create
type: function
doc:
<comment>Description:</comment>
  Cria um contexto de fluxo
  
  Cria e retorna um contexto de fluxo com as opções fornecidas em <strong>$options</strong> predefinidas.

<comment>Param:</comment>
  <info>array|null</info>  <strong>$options</strong>  Deve ser um array associativo de arrays associativos no formato
                        <return>$arr['empacotador']['opcao'] = $valor</return> ou <info>null</info>. Consulte opções de contexto
                        para uma lista de empacotadores disponíveis e opções.
                        
                        O padrão é <info>null</info>.
  <info>array|null</info>  <strong>$params</strong>   Deve ser um array associativo no formato <return>$arr['parametro'] = $valor</return> ou <info>null</info>.
                        Consulte parâmetros de contexto para uma lista de parâmetros de fluxo
                        padrões.

<comment>Return:</comment>
  <info>resource</info>  Um recurso do tipo <info>resource</info> de contexto de fluxo.

<comment>See Also:</comment>
   * <strong>stream_context_set_option()</strong>
   * Lista de empacotadores suportados ()
   * Opções de contexto ()


id: stream_context_get_default
type: function
doc:
<comment>Description:</comment>
  Obtém o contexto padrão de fluxo
  
  Retorna o contexto padrão de fluxo que é usado sempre que operações de arquivos (<strong>fopen()</strong>,
  <strong>file_get_contents()</strong>, etc.) são chamadas sem parâmetro de contexto. Opções para o contexto padrão
  podem ser opcionalmente especificadas com esta função usando a mesma sintaxe de
  <strong>stream_context_create()</strong>.

<comment>Param:</comment>
  <info>array|null</info>  <strong>$options</strong>  <strong>$options</strong> deve ser um array associativo de arrays associativos no formato
                        <return>$arr['empacotador']['opcao'] = $valor</return> ou <info>null</info>.

<comment>Return:</comment>
  <info>resource</info>  Um recurso do tipo <info>resource</info> de contexto de fluxo.

<comment>See Also:</comment>
   * <strong>stream_context_create()</strong>
   * <strong>stream_context_set_default()</strong>
   * Lista dos empacotadores suportados com opções de contexto ().


id: stream_context_get_options
type: function
doc:
<comment>Description:</comment>
  Obtém opções para um fluxo/empacotador/contexto
  
  Retorna um array de opções sobre o contexto ou fluxo especificado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream_or_context</strong>  O fluxo (<info>stream</info>) ou contexto (<info>context</info>) do qual as opções serão
                                obtidas

<comment>Return:</comment>
  <info>array</info>  Retorna um array associativo com as opções.


id: stream_context_get_params
type: function
doc:
<comment>Description:</comment>
  Obtém parâmetros de um contexto
  
  Obtém informações de parâmetro e opções de um fluxo ou contexto.

<comment>Param:</comment>
  <info>resource</info>  <strong>$context</strong>  Um fluxo do tipo <info>resource</info> ou um context do tipo <info>resource</info>

<comment>Return:</comment>
  <info>array</info>  Retorna um array associativo contendo todas as opções de contexto e parâmetros.

<comment>See Also:</comment>
   * <strong>stream_context_set_option()</strong>
   * <strong>stream_context_set_params()</strong>


id: stream_context_set_default
type: function
doc:
<comment>Description:</comment>
  Define o contexto padrão do fluxo
  
  Define o contexto padrão do fluxo que será usado sempre que operações de arquivos (<strong>fopen()</strong>,
  <strong>file_get_contents()</strong>, etc.) forem chamadas sem um parâmetro de contexto. Usa a mesma sintaxe de
  <strong>stream_context_create()</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  As opções a serem definidas para o contexto padrão.
                   
                   <strong>$options</strong> deve ser um array associativo de arrays associativos no formato
                   <return>$arr['empacotador']['opção'] = $valor</return>.

<comment>Return:</comment>
  <info>resource</info>  Retorna o contexto padrão do fluxo.

<comment>See Also:</comment>
   * <strong>stream_context_create()</strong>
   * <strong>stream_context_get_default()</strong>
   * Lista dos empacotadores suportados com opções de contexto ().


id: stream_context_set_option
type: function
doc:
<comment>Description:</comment>
  Define uma opção para um fluxo/empacotador/contexto
  
  Define uma opção para o contexto especificado. <strong>$value</strong> é definido para <strong>$option</strong> para o parâmetro
  <strong>$wrapper</strong> (empacotador).

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream_or_context</strong>  O recurso fluxo ou contexto ao qual deve-se aplicar as opções.
  <info>string</info>    <strong>$wrapper</strong>            O nome do empacotador (que pode ser diferente do protocolo).
                                Consulte opções de contexto e parâmetros para uma lista de opções de
                                fluxo.
  <info>string</info>    <strong>$option</strong>             O nome da opção.
  <info>mixed</info>     <strong>$value</strong>              O valor da opção.
  <info>array</info>     <strong>$options</strong>            As opções a serem definidas para <strong>$stream_or_context</strong>.
                                
                                <strong>$options</strong> deve ser um array associativo de arrays associativos no
                                formato <return>$arr['empacotador']['opcao'] = $valor</return>.
                                
                                Consulte opções de contexto e parâmetros para uma lista de opções de
                                fluxo.

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


id: stream_context_set_options
type: function
doc:
<comment>Description:</comment>
  Define opções no contexto especificado
  
  Define opções no contexto especificado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$context</strong>  O recurso fluxo ou contexto ao qual deve-se aplicar as opções.
  <info>array</info>     <strong>$options</strong>  As opções a serem definidas para <strong>$context</strong>.
                      
                      <strong>$options</strong> deve ser um <info>array</info> associativo de arrays associativos no formato
                      $array['empacotador']['opcao'] = $valor.
                      
                      Consulte opções de contexto e parâmetros para uma lista de opções de fluxo.

<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>stream_context_set_option()</strong>


id: stream_context_set_params
type: function
doc:
<comment>Description:</comment>
  Define parâmetros para um fluxo/empacotador/contexto
  
  Define parâmetros para o contexto especificado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$context</strong>  O fluxo ou contexto ao qual os parâmetros devem ser aplicados.
  <info>array</info>     <strong>$params</strong>   Um array associativo de parâmetros a serem definidos no seguinte formato:
                      <return>$params['nome_parametro'] = "valor_parametro";</return>.

<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>stream_notification_callback()</strong>


id: stream_copy_to_stream
type: function
doc:
<comment>Description:</comment>
  Copia dados de um fluxo para outro
  
  Faz uma cópia dos dados com um comprimento em bytes definido em <strong>$length</strong>, a partir da posição atual
  (ou a partir da posição <strong>$offset</strong>, se especificada) do fluxo <strong>$from</strong> para o fluxo <strong>$to</strong>. Se <strong>$length</strong> for
  <info>null</info>, todo o conteúdo remanescente em <strong>$from</strong> será copiado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$from</strong>    O fluxo de origem
  <info>resource</info>  <strong>$to</strong>      O fluxo de destino
  <info>int|null</info>  <strong>$length</strong>  Máximo de bytes a copiar. Por padrão todos os bytes restantes são copiados.
  <info>int</info>       <strong>$offset</strong>  O deslocamento a partir do qual deve-se começar a copiar os dados

<comment>Return:</comment>
  <info>int|false</info>  Retorna a contagem total de bytes copiados, ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>copy()</strong>


id: stream_filter_append
type: function
doc:
<comment>Description:</comment>
  Anexa um filtro a um fluxo
  
  Adiciona o nome do filtro <strong>$filtername</strong> à lista de filtros anexados ao fluxo <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>      O fluxo alvo.
  <info>string</info>    <strong>$filtername</strong>  O nome do filtro.
  <info>int</info>       <strong>$read_write</strong>  Por padrão, <strong>stream_filter_append()</strong> irá anexar o filtro à <return>cadeia de filtros
                         de leitura</return> se o arquivo foi aberto para leitura (isto é, modo de arquivo: <return>r</return>
                         e/ou <return>+</return>). O filtro também será anexado à <return>cadeia de filtros de escrita</return> se o
                         arquivo foi aberto para escrita (isto é, modo de arquivo: <return>w</return>, <return>a</return> e/ou <return>+</return>). As
                         constantes <info>STREAM_FILTER_READ</info>, <info>STREAM_FILTER_WRITE</info> e/ou <info>STREAM_FILTER_ALL</info>
                         também podem ser passadas ao parâmetro <strong>$read_write</strong> para substituir este
                         comportamento.
  <info>mixed</info>     <strong>$params</strong>      Este filtro será adicionado com os parâmetros especificados em <strong>$params</strong> ao
                         final da lista e portanto serão chamados por último durante operações de
                         fluxo. Para adicionar um filtro ao início da lista, use
                         <strong>stream_filter_prepend()</strong>.

<comment>Return:</comment>
  <info>resource</info>  Retorna um recurso em caso de sucesso ou <info>false</info> em caso de falha. O recurso pode ser
            usado para se referir a este instância de filtro durante a chamada a
            <strong>stream_filter_remove()</strong>.
            
            <info>false</info> é retornado se o parâmetro <strong>$stream</strong> não for um recurso ou se o nome do filtro
            <strong>$filtername</strong> não puder ser localizado.

<comment>See Also:</comment>
   * <strong>stream_filter_register()</strong>
   * <strong>stream_filter_prepend()</strong>
   * <strong>stream_get_filters()</strong>


id: stream_filter_prepend
type: function
doc:
<comment>Description:</comment>
  Anexa um filtro a um fluxo
  
  Adiciona o nome do filtro <strong>$filtername</strong> à lista de filtros anexados ao fluxo <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>      O fluxo alvo.
  <info>string</info>    <strong>$filtername</strong>  O nome do filtro.
  <info>int</info>       <strong>$read_write</strong>  Por padrão, <strong>stream_filter_prepend()</strong> irá anexar o filtro à <return>cadeia de filtros
                         de leitura</return> se o arquivo foi aberto para leitura (isto é, modo de arquivo: <return>r</return>
                         e/ou <return>+</return>). O filtro também será anexado à <return>cadeia de filtros de escrita</return> se o
                         arquivo foi aberto para escrita (isto é, modo de arquivo: <return>w</return>, <return>a</return> e/ou <return>+</return>). As
                         constantes <info>STREAM_FILTER_READ</info>, <info>STREAM_FILTER_WRITE</info> e/ou <info>STREAM_FILTER_ALL</info>
                         também podem ser passadas ao parâmetro <strong>$read_write</strong> para substituir este
                         comportamento. Consulte a função <strong>stream_filter_append()</strong> para um exemplo de
                         uso deste parâmetro.
  <info>mixed</info>     <strong>$params</strong>      Este filtro será adicionado com os parâmetros especificados em <strong>$params</strong> ao
                         início da lista e portanto serão chamados em primeiro lugar durante
                         operações de fluxo. Pra adicionar um filtro ao final da lista, use
                         <strong>stream_filter_append()</strong>.

<comment>Return:</comment>
  <info>resource</info>  Retorna um recurso em caso de sucesso ou <info>false</info> em caso de falha. O recurso pode ser
            usado para se referir a esta instância de filtro durante uma chamada a
            <strong>stream_filter_remove()</strong>.
            
            <info>false</info> é retornado se o parâmetro <strong>$stream</strong> não for um recurso ou se o nome do filtro
            <strong>$filtername</strong> não puder ser localizado.

<comment>See Also:</comment>
   * <strong>stream_filter_register()</strong>
   * <strong>stream_filter_append()</strong>


id: stream_filter_register
type: function
doc:
<comment>Description:</comment>
  Registra um filtro de fluxo definido pelo usuário
  
  <strong>stream_filter_register()</strong> permite implementar filtro de usuário em qualquer fluxo registrado usado
  com todas as outras funções de sistemas de arquivos (como <strong>fopen()</strong>, <strong>fread()</strong> etc.).

<comment>Param:</comment>
  <info>string</info>  <strong>$filter_name</strong>  O nome do filtro a ser registrado.
  <info>string</info>  <strong>$class</strong>        Para implementar um filtro, deve-se definir uma classe como uma extensão de
                        <class>php_user_filter</class> com um número de funções membro. Na execução de operações de
                        leitura/escrita no fluxo ao qual o filtro estiver anexado, o PHP passará os
                        dados através do filtro (e quaisquer outros filtros anexados ao fluxo) para
                        que os dados possam ser modificados como desejado. Deve-se implementar os
                        métodos exatamente como descrito em <class>php_user_filter</class> - caso contrário,
                        pode-se chegar a comportamentos não definidos.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
        
        <strong>stream_filter_register()</strong> irá retornar <info>false</info> se o nome do filtro em <strong>$filter_name</strong> já estiver
        definido.

<comment>See Also:</comment>
   * <strong>stream_wrapper_register()</strong>
   * <strong>stream_filter_append()</strong>
   * <strong>stream_filter_prepend()</strong>


id: stream_filter_remove
type: function
doc:
<comment>Description:</comment>
  Remove um filtro de um fluxo
  
  Remove um filtro de fluxo previamente adicionado a um fluxo com <strong>stream_filter_prepend()</strong> ou
  <strong>stream_filter_append()</strong>.  Quaisquer dados remanescentes no buffer interno do filtro serão
  descarregados no filtro seguinte antes da remoção.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream_filter</strong>  O filtro de fluxo a ser removido.

<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>stream_filter_register()</strong>
   * <strong>stream_filter_append()</strong>
   * <strong>stream_filter_prepend()</strong>


id: stream_get_contents
type: function
doc:
<comment>Description:</comment>
  Lê o restante de um fluxo em uma string
  
  Idêntico a <strong>file_get_contents()</strong>, exceto que <strong>stream_get_contents()</strong> opera em um recurso de fluxo já
  aberto e retorna o conteúdo remanescente em uma string, até o número de bytes definido em <strong>$length</strong>
  e iniciando na posição <strong>$offset</strong> especificada.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Um recurso de fluxo (ex.: retornado de <strong>fopen()</strong>)
  <info>int|null</info>  <strong>$length</strong>  O máximo de bytes para leitura. O padrão é <info>null</info> (ler todo o buffer
                     remanescente).
  <info>int</info>       <strong>$offset</strong>  Posiciona o ponteiro até o deslocamento especificado antes da leitura. Se o
                     número for negativo, não irá ocorrer deslocamento e a leitura irá iniciar na
                     posição atual.

<comment>Return:</comment>
  <info>string|false</info>  Retorna uma string ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>fgets()</strong>
   * <strong>fread()</strong>
   * <strong>fpassthru()</strong>


id: stream_get_filters
type: function
doc:
<comment>Description:</comment>
  Obtém lista de filtros registrados
  
  Obtém a lista de filtros registrados no sistema em execução.

<comment>Return:</comment>
  <info>array</info>  Retorna um array indexado contendo o nome de todos os filtros de fluxo disponíveis.

<comment>See Also:</comment>
   * <strong>stream_filter_register()</strong>
   * <strong>stream_get_wrappers()</strong>


id: stream_get_line
type: function
doc:
<comment>Description:</comment>
  Obtém uma linha do recurso do fluxo até um delimitador informado
  
  Obtém uma linha do manipulador informado.
  
  A leitura termina quando o número de bytes especificados em <strong>$length</strong> tiverem sido lidos, ou quando
  a string não vazia especificada por <strong>$ending</strong> for encontrada (que não é incluída no valor de
  retorno), ou em EOF (o que ocorrer primeiro).
  
  Esta função é praticamente idêntica a <strong>fgets()</strong> exceto por permitir delimitadores de final de linha
  diferente dos padrões \n, \r e \r\n, e não retorna o delimitador em si.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Um manipulador de arquivo válido.
  <info>int</info>       <strong>$length</strong>  O número máximo de bytes para leitura do manuipulador. Valores negativos não
                     são suportados. Zero (<return>0</return>) define o tamanho padrão do pacote do socket, isto é,
                     <return>8192</return> bytes.
  <info>string</info>    <strong>$ending</strong>  Um delimitador string opcional.

<comment>Return:</comment>
  <info>string|false</info>  Retorna uma string com no máximo o número de bytes de <strong>$length</strong> lidos do arquivo
                apontado por <strong>$stream</strong>, ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>fread()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetc()</strong>


id: stream_get_meta_data
type: function
doc:
<comment>Description:</comment>
  Obtém cabeçalhos/metadados de ponteiros de arquivos/fluxos
  
  Retorna informação sobre um fluxo (<strong>$stream</strong>) existente.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O fluxo pode ser qualquer um criado por <strong>fopen()</strong>, <strong>fsockopen()</strong>, <strong>pfsockopen()</strong> e
                     <strong>stream_socket_client()</strong>.

<comment>Return:</comment>
  <info>array</info>  O array resultante contém os seguintes itens:
         
         <return>timed_out</return> (bool) - <info>true</info> se o fluxo passou do limite de tempo definido enquanto esperava por
         dados na última chamada a <strong>fread()</strong> or <strong>fgets()</strong>.
         
         <return>blocked</return> (bool) - <info>true</info> se o fluxo estiver em modo bloqueado de E/S. Consulte
         <strong>stream_set_blocking()</strong>.
         
         <return>eof</return> (bool) - <info>true</info> se o fluxo alcançou o fim do arquivo. Note que para fluxos de socket este
         membro pode ser <info>true</info> mesmo quando  os bytes não lidos (<return>unread_bytes</return>) for diferente de zero.
         Para determinar se há mais dados para leitura, use <strong>feof()</strong> no lugar de ler este item.
         
         <return>unread_bytes</return> (int) - o número de bytes atualmente contidos no buffer interno do próprio
         PHP.
         
         Este valor não deve ser usado em um script.
         
         <return>stream_type</return> (string) - uma identificação descrevendo a implementação subjacente do fluxo.
         
         <return>wrapper_type</return> (string) - uma identificação descrevendo a implementação do empacotador de
         protocolo sobre o fluxo. Consulte  para mais informações sobre empacotadores.
         
         <return>wrapper_data</return> (mixed) - dados específicos de empacotadores anexados a este fluxo. Consulte
         para mais informações sobre empacotadores e seus dados.
         
         <return>mode</return> (string) - o tipo de acesso requerido para este fluxo (veja Tabela 1 da referência de
         fopen())
         
         <return>seekable</return> (bool) - se o fluxo atual pode ou não ser pesquisado.
         
         <return>uri</return> (string) - o nome de arquivo ou URI associado com este fluxo.
         
         <return>crypto</return> (array) - os metadados de conexão TLS para este fluxo. (Nota: fornecido somente
         quando o fluxo do recurso usa TLS.)

<comment>See Also:</comment>
   * <strong>get_headers()</strong>
   * $http_response_header


id: stream_get_transports
type: function
doc:
<comment>Description:</comment>
  Obtém lista de transportes socket registrados
  
  Retorna um array indexado contendo os nomes de todos os transportes de socket disponíveis no
  sistema em execução.

<comment>Return:</comment>
  <info>array</info>  Retorna um array indexado de nomes de transporte de sockets.

<comment>See Also:</comment>
   * <strong>stream_get_filters()</strong>
   * <strong>stream_get_wrappers()</strong>


id: stream_get_wrappers
type: function
doc:
<comment>Description:</comment>
  Obtém lista de fluxos registrados
  
  Obtém lista de fluxos registrados disponíveis no sistema em execução.

<comment>Return:</comment>
  <info>array</info>  Retorna um array indexado contendo os nomes de todos os empacotadores de fluxo disponíveis
         no sistema em execução.

<comment>See Also:</comment>
   * <strong>stream_wrapper_register()</strong>


id: stream_is_local
type: function
doc:
<comment>Description:</comment>
  Verifica se o fluxo é local
  
  Verifica se um fluxo ou uma URL é ou não local.

<comment>Param:</comment>
  <info>resource|string</info>  <strong>$stream</strong>  O fluxo do tipo <info>resource</info> ou URL a ser verificado.

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


id: stream_isatty
type: function
doc:
<comment>Description:</comment>
  Verifica se um fluxo é um TTY
  
  Determina se o fluxo <strong>$stream</strong> se refere a um dispositivo tipo terminal válido. Esta é uma versão
  mais portável de <strong>posix_isatty()</strong>, já que também funciona no Windows.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O fluxo a ser verificado.

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


id: stream_notification_callback
type: function
doc:
<comment>Description:</comment>
  Uma função de chamada de retorno para o parâmetro de contexto de notification
  
  Uma função do tipo <info>callable</info>, usada pelo parâmetro de contexto de notificação, chamado durante um
  evento.
  
  Esta não é uma função real, apenas um protótipo de como uma função deve ser.

<comment>Param:</comment>
  <info>int</info>          <strong>$notification_code</strong>  Uma das constantes de notificação <info>STREAM_NOTIFY_*</info>.
  <info>int</info>          <strong>$severity</strong>           Uma das constantes de notificação <info>STREAM_NOTIFY_SEVERITY_*</info>.
  <info>string|null</info>  <strong>$message</strong>            Passado se uma mensagem descritiva estiver disponível para o
                                   evento.
  <info>int</info>          <strong>$message_code</strong>       Passado se um código de mensagem descritiva estiver disponível
                                   para o evento.
                                   
                                   O significado deste valor depende do empacotador específico em
                                   uso.
  <info>int</info>          <strong>$bytes_transferred</strong>  Se aplicável, o número de bytes em <strong>$bytes_transferred</strong> será
                                   preenchido.
  <info>int</info>          <strong>$bytes_max</strong>          Se aplicável, o número máximo de bytes em <strong>$bytes_max</strong> será
                                   preenchido.

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

<comment>See Also:</comment>
   * 


id: stream_register_wrapper
type: function
doc:
<comment>Description:</comment>
  Sinônimo de stream_wrapper_register
  
  Esta função é um apelido para:  <strong>stream_wrapper_register()</strong>.


id: stream_resolve_include_path
type: function
doc:
<comment>Description:</comment>
  Resolve o nome do arquivo em relação ao caminho de include
    
  
  Resolve <strong>$filename</strong> em relação ao caminho de include de acordo com as mesmas regras que
  <strong>fopen()</strong>/<strong>include()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  O nome de arquivo a resolver.

<comment>Return:</comment>
  <info>string|false</info>  Retorna uma <info>string</info> contendo o caminho absoluto para o arquivo,  ou <info>false</info> em caso de
                falha.


id: stream_select
type: function
doc:
<comment>Description:</comment>
  Executa o equivalente à chamada de sistema select() nos arrays de fluxos
     informados com um limite de tempo especificado por segundos e microssegundos
  
  A função <strong>stream_select()</strong> aceita arrays de fluxos e espera por alteração em seus estados. Sua
  operação é equivalente à da função <strong>socket_select()</strong> exceto por atuar em fluxos.

<comment>Param:</comment>
  <info>array|null</info>  <strong>$read</strong>          Os fluxos listados no array <strong>$read</strong> serão observados para ver se
                             caracteres se tornem disponíveis para leitura (mais precisamente, para
                             ver se uma leitura não irá bloquear - em particular, um recurso de
                             fluxo já se encontra pronto no final do arquivo, neste caso a função
                             <strong>fread()</strong> irá retornar uma string com comprimento zero).
  <info>array|null</info>  <strong>$write</strong>         Os fluxos listados no array <strong>$write</strong> serão observados para ver se uma
                             escrita não irá bloquear.
  <info>array|null</info>  <strong>$except</strong>        Os fluxos listados no array <strong>$except</strong> serão observados para chegada de
                             dados excepcional ("fora-de-banda") de alta prioridade.
                             
                             Quando <strong>stream_select()</strong> retorna, os arrays <strong>$read</strong>, <strong>$write</strong> e <strong>$except</strong> são
                             modificados para indicar qual(is) recurso(s) de fluxo realmente tiveram
                             o estado alterado. As chaves originais dos <info>array</info>s são preservadas.
  <info>int|null</info>    <strong>$seconds</strong>       Os parâmetros <strong>$seconds</strong> e <strong>$microseconds</strong> formam juntos o parâmetro limite
                             de tempo, <strong>$seconds</strong> especifica o número de segundos e <strong>$microseconds</strong> o
                             número de microssegundos. O parâmetro <strong>$timeout</strong> é um limite do tempo que
                             <strong>stream_select()</strong> irá esperar antes de retornar. Se tanto <strong>$seconds</strong> quanto
                             <strong>$microseconds</strong> forem iguais a <return>0</return>, <strong>stream_select()</strong> não irá esperar por
                             dados - em vez disso irá retornar imediatamente, indicando o estado
                             atual dos fluxos.
                             
                             Se <strong>$seconds</strong> for <info>null</info> <strong>stream_select()</strong> pode bloquear indefinidamente,
                             retornando somente quando um evento em algum dos fluxos observados
                             ocorrer (ou se um sinal interromper a chamada de sistema).
                             
                             Usando um valor de <return>0</return> no limite de tempo permite que se faça pesquisa
                             instantânea dos estados dos fluxos, entretanto, NÃO é recomendado usar
                             um limite de <return>0</return> em um loop pois poderá causar um consumo excessivo de
                             tempo de CPU.
                             
                             É muito melhor especificar um limite de tempo de alguns segundos,
                             embora caso seja necessário ficar verificando e executando outro código
                             concorrentemente, usar um limite de pelo menos <return>200000</return> microssegundos
                             ajudará a reduzir o consumo de CPU do seu script.
                             
                             Lembre-se que o valor de limite de tempo é o tempo máximo que irá
                             decorrer; <strong>stream_select()</strong> irá retornar tão logo os fluxos requisitados
                             estiverem prontos para uso.
  <info>int|null</info>    <strong>$microseconds</strong>  Veja descrição de <strong>$seconds</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Em caso de sucesso, <strong>stream_select()</strong> retorna o número de recursos de fluxo contidos nos
             arrays modificados, o que pode ser zero se o limite de tempo for alcançado antes que
             alguma coisa interessante aconteça. Em caso de erro, <info>false</info> é retornado e um aviso é
             emitido (isto pode acontecer se a chamada ao sistema for interrompida por algum sinal).

<comment>See Also:</comment>
   * <strong>stream_set_blocking()</strong>


id: stream_set_blocking
type: function
doc:
<comment>Description:</comment>
  Definir modo de bloqueio/não-bloqueio em um fluxo
  
  Definir modo de bloqueio ou não-bloqueio em um fluxo informado em <strong>$stream</strong>.
  
  Esta função funciona para qualquer fluxo que suporte modo de não-bloqueio (atualmente, arquivos
  comuns e fluxos de socket).

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O fluxo.
  <info>bool</info>      <strong>$enable</strong>  Se <strong>$enable</strong> for <info>false</info>, o fluxo informado será trocado para o modo de
                     não-bloqueio, e se for <info>true</info>, será trocado para o modo de bloqueio. Isto afeta
                     chamadas como <strong>fgets()</strong> e <strong>fread()</strong> que lêem do fluxo. Em modo de não-bloqueio, uma
                     chamada a <strong>fgets()</strong> irá sempre retornar imediatamente, enquanto que em modo de
                     bloqueio, ela irá esperar que dados fiquem disponíveis no fluxo.

<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>stream_select()</strong>


id: stream_set_chunk_size
type: function
doc:
<comment>Description:</comment>
  Define o tamanho do pacote do fluxo
  
  Define o tamanho do pacote do fluxo.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O fluxo alvo.
  <info>int</info>       <strong>$size</strong>    O novo tamanho de pacote desejado.

<comment>Return:</comment>
  <info>int</info>  Retorna o tamanho anterior em caso de sucesso.


id: stream_set_read_buffer
type: function
doc:
<comment>Description:</comment>
  Define o tamanho de buffer de leitura do stream
  
  Define o tamanho do buffer de leitura. É equivalente a <strong>stream_set_write_buffer()</strong>, porém para
  operações de leitura.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro para o arquivo.
  <info>int</info>       <strong>$size</strong>    O número de bytes do buffer. Se <strong>$size</strong> for 0 as operações são realizadas sem
                     buffer. Isto assegura que todas as leituras com <strong>fread()</strong> estejam completas antes
                     que outros processos possam ler do fluxo de entrada.

<comment>Return:</comment>
  <info>int</info>  Retorna 0 em caso de sucesso, ou outro valor se a requisição não puder ser cumprida.

<comment>See Also:</comment>
   * <strong>stream_set_write_buffer()</strong>


id: stream_set_timeout
type: function
doc:
<comment>Description:</comment>
  Define o limite de tempo em um fluxo
  
  Define o valor limite de tempo no fluxo <strong>$stream</strong>, expresso pela soma de <strong>$seconds</strong> e <strong>$microseconds</strong>.
  
  Quando o fluxo expira, a chave 'timed_out' do array retornado pela função <strong>stream_get_meta_data()</strong> é
  definida para <info>true</info>, embora nenhum erro/aviso seja gerado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>        O fluxo alvo.
  <info>int</info>       <strong>$seconds</strong>       A parte em segundos do limite de tempo.
  <info>int</info>       <strong>$microseconds</strong>  A parte em microssegundos do limite de tempo.

<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>fsockopen()</strong>
   * <strong>fopen()</strong>


id: stream_set_write_buffer
type: function
doc:
<comment>Description:</comment>
  Define o tamanho do buffer de escrita do fluxo
  
  Define o tamanho do buffer de operações de escrita no fluxo informado em <strong>$stream</strong> para o número de
  bytes informado em <strong>$size</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro para o arquivo.
  <info>int</info>       <strong>$size</strong>    O número de bytes do buffer. Se <strong>$size</strong> for 0, as operações de escrita não terão
                     buffer. Isto assegura que todas as operações de escrita com <strong>fwrite()</strong> estejam
                     completas antes que outros processos possam escrever no fluxo de saída.

<comment>Return:</comment>
  <info>int</info>  Retorna 0 em caso de sucesso, ou outro valor se a requisição não puder ser cumprida.

<comment>See Also:</comment>
   * <strong>fopen()</strong>
   * <strong>fwrite()</strong>


id: stream_socket_accept
type: function
doc:
<comment>Description:</comment>
  Aceita uma conexão em um socket criado por stream_socket_server
  
  Aceita uma conexão em um socket previamente criado por <strong>stream_socket_server()</strong>.

<comment>Param:</comment>
  <info>resource</info>    <strong>$socket</strong>     O socket do servidor de onde a conexão será aceita.
  <info>float|null</info>  <strong>$timeout</strong>    Substitui o limite de tempo padrão de aceitação do socket. O tempo deve
                          ser informado em segundos. Por padrão, default_socket_timeout é usado.
  <info>string</info>      <strong>$peer_name</strong>  Será definido para o nome (endereço) do cliente que conectou, se incluído
                          e disponível no transporte selecionado.
                          
                          Pode também ser determinado mais tarde usando <strong>stream_socket_get_name()</strong>.

<comment>Return:</comment>
  <info>resource|false</info>  Retorna um fluxo para a conexão de socket aceita ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>stream_socket_server()</strong>
   * <strong>stream_socket_get_name()</strong>
   * <strong>stream_set_blocking()</strong>
   * <strong>stream_set_timeout()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetss()</strong>
   * <strong>fwrite()</strong>
   * <strong>fclose()</strong>
   * <strong>feof()</strong>
   * 


id: stream_socket_client
type: function
doc:
<comment>Description:</comment>
  Abre conexão de socket de domínio Internet ou Unix
  
  Inicia uma conexão de fluxo ou datagrada ao destino especificado pelo parâmetro <strong>$address</strong>. O tipo
  de socket criado é determinado pelo transporte especificado usando-se formatação de URL padrão:
  <return>transporte://alvo</return>. Para sockets de domínio Internet (AF_INET) tais como TCP e UDP, a porção <return>alvo</return>
  do parâmetro <strong>$address</strong> deve consistir de um nome de servidor ou endereço IP seguido por dois-pontos
  e um número de porta. Para sockets de domínio Unix, a porção <return>alvo</return> seve apontar ao arquivo de
  socket no sistema de arquivos.
  
  O fluxo por padrão será aberto em modo de bloqueio. Pode-se trocar para modo de não-bloqueio
  usando <strong>stream_set_blocking()</strong>.

<comment>Param:</comment>
  <info>string</info>         <strong>$address</strong>        Endereço ao qual o socket deve se conectar.
  <info>int</info>            <strong>$error_code</strong>     Será definido para o número de erro no nível do sistema se a
                                 conexão falhar.
  <info>string</info>         <strong>$error_message</strong>  Será definido para a mensagem de erro no nível do sistema se a
                                 conexão falhar.
  <info>float|null</info>     <strong>$timeout</strong>        Número máximo de segundos que a chamada de sistema <return>connect()</return> deve
                                 esperar. Por padrão, default_socket_timeout é usado.  Este
                                 parâmetro aplica-se somente quando não há tentativas de se fazer
                                 conexões assíncronas.   Para definir um limite de tempo para
                                 leitura/escrita de dados no socket, use a função
                                 <strong>stream_set_timeout()</strong>, já que <strong>$timeout</strong> se aplica somente enquanto
                                 está sendo feita a conexão ao socket.
                                 
                                 Este parâmetro aplica-se somente quando não há tentativas de se
                                 fazer conexões assíncronas.
                                 
                                 Para definir um limite de tempo para leitura/escrita de dados no
                                 socket, use a função <strong>stream_set_timeout()</strong>, já que <strong>$timeout</strong> se
                                 aplica somente enquanto está sendo feita a conexão ao socket.
  <info>int</info>            <strong>$flags</strong>          Um campo de máscara de bits que pode ser configurada para qualquer
                                 combinação de opções de conexão. Atualmente a seleção de opções de
                                 conecão está limitada a <info>STREAM_CLIENT_CONNECT</info> (padrão),
                                 <info>STREAM_CLIENT_ASYNC_CONNECT</info> e <info>STREAM_CLIENT_PERSISTENT</info>.
  <info>resource|null</info>  <strong>$context</strong>        Um recurso válido de contexto criado com <strong>stream_context_create()</strong>.

<comment>Return:</comment>
  <info>resource|false</info>  Em caso de sucesso, um recurso de fluxo é retornado, e pode ser usado com outras
                  funções de arquivos (como <strong>fgets()</strong>, <strong>fgetss()</strong>, <strong>fwrite()</strong>, <strong>fclose()</strong> e <strong>feof()</strong>), <info>false</info>
                  em caso de falha.

<comment>See Also:</comment>
   * <strong>stream_socket_server()</strong>
   * <strong>stream_set_blocking()</strong>
   * <strong>stream_set_timeout()</strong>
   * <strong>stream_select()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetss()</strong>
   * <strong>fwrite()</strong>
   * <strong>fclose()</strong>
   * <strong>feof()</strong>
   * 


id: stream_socket_enable_crypto
type: function
doc:
<comment>Description:</comment>
  Liga ou desliga criptografia em socket já conectado
  
  Liga ou desliga criptografia no fluxo.
  
  Assim que as configurações de criptografia estiverem estabelecidos, a criptografia pode ser ligada
  e desligada dinamicamente passando-se <info>true</info> ou <info>false</info> no parâmetro <strong>$enable</strong>.

<comment>Param:</comment>
  <info>resource</info>       <strong>$stream</strong>          O recurso representando o fluxo.
  <info>bool</info>           <strong>$enable</strong>          Ligar/desligar criptografia no fluxo.
  <info>int|null</info>       <strong>$crypto_method</strong>   Configura a criptografia no fluxo. Métodos válidos são:
                                  <info>STREAM_CRYPTO_METHOD_SSLv2_CLIENT</info><info>STREAM_CRYPTO_METHOD_SSLv3_CLIENT</info><info>STREAM_CRYPTO_METHOD_SSLv23_CLIENT</info><info>STREAM_CRYPTO_METHOD_ANY_CLIENT</info><info>STREAM_CRYPTO_METHOD_TLS_CLIENT</info><info>STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT</info><info>STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT</info><info>STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT</info><info>STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT</info>
                                  (a partir do PHP
                                  7.4.0)<info>STREAM_CRYPTO_METHOD_SSLv2_SERVER</info><info>STREAM_CRYPTO_METHOD_SSLv3_SERVER</info><info>STREAM_CRYPTO_METHOD_SSLv23_SERVER</info><info>STREAM_CRYPTO_METHOD_ANY_SERVER</info><info>STREAM_CRYPTO_METHOD_TLS_SERVER</info><info>STREAM_CRYPTO_METHOD_TLSv1_0_SERVER</info><info>STREAM_CRYPTO_METHOD_TLSv1_1_SERVER</info><info>STREAM_CRYPTO_METHOD_TLSv1_2_SERVER</info><info>STREAM_CRYPTO_METHOD_TLSv1_3_SERVER</info>
                                  (a partir do PHP 7.4.0)
                                  
                                  <info>STREAM_CRYPTO_METHOD_SSLv2_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_SSLv3_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_SSLv23_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_ANY_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLS_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT</info> (a partir do PHP 7.4.0)
                                  
                                  <info>STREAM_CRYPTO_METHOD_SSLv2_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_SSLv3_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_SSLv23_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_ANY_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLS_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_0_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_1_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_2_SERVER</info>
                                  
                                  <info>STREAM_CRYPTO_METHOD_TLSv1_3_SERVER</info> (a partir do PHP 7.4.0)
                                  
                                  Se omitido, a opção de contexto <return>crypto_method</return> no contexto SSL do
                                  fluxo será usado.
  <info>resource|null</info>  <strong>$session_stream</strong>  Alimenta o fluxo com as configurações de <strong>$session_stream</strong>.

<comment>Return:</comment>
  <info>int|bool</info>  Retorna <info>true</info> em caso de sucesso, <info>false</info> se a negociação falhar ou <return>0</return> se não houver dados
            suficientes levando a uma nova tentativa (apenas para sockets em modo de não-bloqueio).

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


id: stream_socket_get_name
type: function
doc:
<comment>Description:</comment>
  Obtém o nome do socket local ou remoto
  
  Retorna o nome local ou remoto de uma conexão socket informada.

<comment>Param:</comment>
  <info>resource</info>  <strong>$socket</strong>  O socket do qual se deseja obter o nome.
  <info>bool</info>      <strong>$remote</strong>  Se definido para <info>true</info>, o nome do socket <return>remoto</return> será retornado, se definido para
                     <info>false</info> o nome do socket <return>local</return> será retornado.

<comment>Return:</comment>
  <info>string|false</info>  O nome do socket, ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>stream_socket_accept()</strong>


id: stream_socket_pair
type: function
doc:
<comment>Description:</comment>
  Cria um par de fluxos de socket conectados e indistinguíveis
    
  
  <strong>stream_socket_pair()</strong> Cria um par de fluxos de socket conectados e indistinguíveis. Esta função é
  normalmente usada em IPC (Comunicação Entre Processos, da sigla em inglês).

<comment>Param:</comment>
  <info>int</info>  <strong>$domain</strong>    A família de protocolos a ser usada: <info>STREAM_PF_INET</info>, <info>STREAM_PF_INET6</info> ou
                  <info>STREAM_PF_UNIX</info>
  <info>int</info>  <strong>$type</strong>      O tipo de comunicação a ser usado: <info>STREAM_SOCK_DGRAM</info>, <info>STREAM_SOCK_RAW</info>,
                  <info>STREAM_SOCK_RDM</info>, <info>STREAM_SOCK_SEQPACKET</info> ou <info>STREAM_SOCK_STREAM</info>
  <info>int</info>  <strong>$protocol</strong>  O protocolo a ser usado: <info>STREAM_IPPROTO_ICMP</info>, <info>STREAM_IPPROTO_IP</info>,
                  <info>STREAM_IPPROTO_RAW</info>, <info>STREAM_IPPROTO_TCP</info> ou <info>STREAM_IPPROTO_UDP</info>

<comment>Return:</comment>
  <info>array|false</info>  Retorna um <info>array</info> com os dois recursos de socket em caso de sucesso, ou <info>false</info> em caso
               de falha.


id: stream_socket_recvfrom
type: function
doc:
<comment>Description:</comment>
  Recebe dados de um socket, conectado ou não
  
  <strong>stream_socket_recvfrom()</strong> aceita dados de um socket remoto até a quantidade de bytes definida por
  <strong>$length</strong>.

<comment>Param:</comment>
  <info>resource</info>     <strong>$socket</strong>   O socket remoto.
  <info>int</info>          <strong>$length</strong>   O número de bytes a receber do <strong>$socket</strong>.
  <info>int</info>          <strong>$flags</strong>    O valor de <strong>$flags</strong> pode ser qualquer combinação das opções a seguir: Valores
                         possíveis para <strong>$flags</strong><info>STREAM_OOB</info> Processa dados fora-de-banda (do inglês OOB
                         <return>out-of-band</return>). <info>STREAM_PEEK</info> Recebe dados do socket, mas não consome o buffer.
                         Chamadas subsequentes a <strong>fread()</strong> ou <strong>stream_socket_recvfrom()</strong> irão ver os
                         mesmos dados.
  <info>string|null</info>  <strong>$address</strong>  Se <strong>$address</strong> for fornecido, será preenchido com o endereço do socket remoto.

<comment>Return:</comment>
  <info>string|false</info>  Retorna os dados lidos, como uma string, ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>stream_socket_sendto()</strong>
   * <strong>stream_socket_client()</strong>
   * <strong>stream_socket_server()</strong>


id: stream_socket_sendto
type: function
doc:
<comment>Description:</comment>
  Envia uma mensagem a um socket, conectado ou não
  
  Envia os dados especificados em <strong>$data</strong> através do <strong>$socket</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$socket</strong>   O socket ao qual serão enviados os dados especificados em <strong>$data</strong>.
  <info>string</info>    <strong>$data</strong>     Os dados a serem enviados.
  <info>int</info>       <strong>$flags</strong>    O valor de <strong>$flags</strong> pode ser qualquer combinação a seguir: Possíveis valores
                      para <strong>$flags</strong><info>STREAM_OOB</info> Processa dados fora-de-banda (do inglês OOB,
                      out-of-band).
  <info>string</info>    <strong>$address</strong>  O endereço especificado quando o fluxo do socket foi criado será usado a menos
                      que um endereço alternativo seja especificado em <strong>$address</strong>.
                      
                      Se especificado, deve estar no formato de quadrante pontilhado (::), ou
                      [ipv6].

<comment>Return:</comment>
  <info>int|false</info>  Retorna um código de resultado, como um inteiro, ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>stream_socket_recvfrom()</strong>
   * <strong>stream_socket_client()</strong>
   * <strong>stream_socket_server()</strong>


id: stream_socket_server
type: function
doc:
<comment>Description:</comment>
  Cria socket de servidor de domínio Internet ou Unix
  
  Cria um socket de fluxo ou datagrama no endereço especificado em <strong>$address</strong>.
  
  Este função apenas cria um socket, para começar a aceitar conexões use <strong>stream_socket_accept()</strong>.

<comment>Param:</comment>
  <info>string</info>         <strong>$address</strong>        O tipo de socket criado é determinado pelo transporte especificado
                                 utilizando-se o formato padrão de URL: <return>transporte://alvo</return>.
                                 
                                 Para sockets do domínio da Internet (<info>AF_INET</info>) como TCP e UDP, a
                                 porção <return>alvo</return> do parâmetro <strong>$remote_socket</strong> deve sonsistir de um nome
                                 de servidor ou endereço IP seguido de dois-pontos e um número de
                                 porta. Para sockets do domínio Unix, a porção <return>alvo</return> deve apontar
                                 para o arquivo de socket do sistema de arquivos.
                                 
                                 Dependendo do ambiente, sockets do domínio Unix podem não estar
                                 disponíveis. Uma lista de transportes disponíveis pode ser obtida
                                 usando a função <strong>stream_get_transports()</strong>. Consulte  para uma lista
                                 de transportes existentes.
  <info>int</info>            <strong>$error_code</strong>     Se or argumentos opcionais <strong>$error_code</strong> e <strong>$error_message</strong> estiverem
                                 presentes, eles serão definidos para indicar o erro real que
                                 ocorreu ocorreu nas chamadas de sistema <return>socket()</return>, <return>bind()</return> e
                                 <return>listen()</return>. Se o valor retornado em <strong>$error_code</strong> for <return>0</return> e a função
                                 retornou <info>false</info>, é um indicativo que o erro ocorreu antes da chamada
                                 a <return>bind()</return>. Isto mais provavelmente será devido a um problema na
                                 inicialização do socket. Note que os argumentos <strong>$error_code</strong> e
                                 <strong>$error_message</strong> serão sempre passados por referência.
  <info>string</info>         <strong>$error_message</strong>  Consulte a descrição para <strong>$error_code</strong>.
  <info>int</info>            <strong>$flags</strong>          Um campo de máscara de bits que pode ser definido para qualquer
                                 combinação de opções de criação de sockets.
                                 
                                 Para sockets UDP, deve ser usado <info>STREAM_SERVER_BIND</info> como o
                                 parâmetro <strong>$flags</strong>.
  <info>resource|null</info>  <strong>$context</strong>        

<comment>Return:</comment>
  <info>resource|false</info>  Retorna o fluxo criado, ou <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * <strong>stream_socket_client()</strong>
   * <strong>stream_set_blocking()</strong>
   * <strong>stream_set_timeout()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetss()</strong>
   * <strong>fwrite()</strong>
   * <strong>fclose()</strong>
   * <strong>feof()</strong>
   * Extensão Curl


id: stream_socket_shutdown
type: function
doc:
<comment>Description:</comment>
  Fecha uma conexão full-duplex
  
  Fecha uma conexão full-duplex (parcialmente ou não).
  
  O buffer ou buffers associados podem ou não ser esvaziados.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Um fluxo aberto (aberto com <strong>stream_socket_client()</strong>, por exemplo)
  <info>int</info>       <strong>$mode</strong>    Uma das constantes a seguir: <info>STREAM_SHUT_RD</info> (desabilita recepções adicionais),
                     <info>STREAM_SHUT_WR</info> (desabilita transmissões adicionais) ou <info>STREAM_SHUT_RDWR</info>
                     (desabilita transmissões e recepções adicionais).

<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>fclose()</strong>


id: stream_supports_lock
type: function
doc:
<comment>Description:</comment>
  Informa se o fluxo suporta travamento
  
  Informa se o fluxo suporta travamento através da função <strong>flock()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O fluxo a ser vetificado.

<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: stream_wrapper_register
type: function
doc:
<comment>Description:</comment>
  Registra um empacotador URL implementado como uma classe PHP
  
  Permite a implementação de manipuladores de protocolo e fluxo do usuário para uso com todas as
  outras funções de sistemas de arquivos (como <strong>fopen()</strong>, <strong>fread()</strong> etc.).

<comment>Param:</comment>
  <info>string</info>  <strong>$protocol</strong>  O nome do empacotador a ser registrado. Nomes de protocolos válidos devem
                     conter somente caracteres alfanuméricos, pontos (.), sinais de adição (+) ou
                     hífens (-).
  <info>string</info>  <strong>$class</strong>     O nome da classe que implementa o protocolo definido no parâmetro <strong>$protocol</strong>.
  <info>int</info>     <strong>$flags</strong>     Deve ser definida para <info>STREAM_IS_URL</info> se <strong>$protocol</strong> for um protocolo URL. O
                     padrão é 0, fluxo local.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
        
        <strong>stream_wrapper_register()</strong> retornará <info>false</info> se <strong>$protocol</strong> já tiver um manipulador.

<comment>See Also:</comment>
   * A classe protótipo 
   * 
   * <strong>stream_wrapper_unregister()</strong>
   * <strong>stream_wrapper_restore()</strong>
   * <strong>stream_get_wrappers()</strong>


id: stream_wrapper_restore
type: function
doc:
<comment>Description:</comment>
  Restaura um empacotador interno anteriormente desregistrado
  
  Restaura um empacotador interno anteriormente desregistrado com <strong>stream_wrapper_unregister()</strong>.

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

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


id: stream_wrapper_unregister
type: function
doc:
<comment>Description:</comment>
  Desregistra um empacotador URL
  
  Permite desabilitar um empacotador de fluxo já definido. Assim que o empacotador tiver sido
  desabilitado, ele pode ser substituído por um empacotador definido pelo usuário usando
  <strong>stream_wrapper_register()</strong>, ou restaurado mais tarde com <strong>stream_wrapper_restore()</strong>.

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

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


id: strftime
type: function
doc:
<comment>Description:</comment>
  Formata uma hora/data de acordo com as configurações locais
  
  Formata uma hora/data local de acordo com a configuração do idioma. Nome do mês e dia da semana e
  outras strings respeitam o idioma corrente definido com a função <strong>setlocale()</strong>.
  
  Nem todas os especificadores de conversão podem ser suportados pela sua biblioteca C, e nestes
  casos eles não serão suportadas pela função do PHP <strong>strftime()</strong>. Além disso, nem todas as
  plataformas suportam timestamps negativos, então sua faixa de datas pode ficar limitada a um valor
  não anterior à época Unix. Isto significa que %e, %T, %R e %D (e possivelmente outras) - assim
  como datas anteriores a <return>1 de janeiro de 1970</return> - não funcionarão no Windows, algumas distribuições
  Linux, e alguns outros sistemas operacionais. Para sistemas Windows, uma visão completa dos
  especificadores de conversão suportados podem ser encontrados em MSDN. No lugar desta função, use
  o método IntlDateFormatter::format.

<comment>Param:</comment>
  <info>string</info>    <strong>$format</strong>     Os seguintes caracteres são reconhecidos na string do parâmetro
                        <strong>$format</strong><strong>$format</strong>DescriçãoExemplo de valores retornadosDia------<return>%a</return>Representação
                        textual abreviada do dia<return>Sun</return> até <return>Sat</return><return>%A</return>Representação textual completa do
                        dia<return>Sunday</return> até <return>Saturday</return><return>%d</return>Dia do mês, com dois dígitos (com zeros à
                        esquerda)<return>01</return> a <return>31</return><return>%e</return> Dia do mês com um dígito, precedido com um espaço. Não
                        implementado como descrito no Windows. Veja abaixo para mais informações. <return> 1</return>
                        a <return>31</return><return>%j</return>Dia do ano, com 3 dígitos e zeros à esquerda<return>001</return> a <return>366</return><return>%u</return>Representação
                        numérica, do dia da semana, compatível com a ISO-8601<return>1</return> (para segunda-feira)
                        até <return>7</return> (para domingo)<return>%w</return>Representação numérica do dia da semana<return>0</return> (para
                        domingo) até <return>6</return> (para sábado)Semana------<return>%U</return>Número da semana de um dado ano,
                        iniciado com o primeiro domingo sendo a primeira semana<return>13</return> (como a 13ª semana
                        completa do ano)<return>%V</return>Número da semana, compatível com a ISO-8601:1988 de um
                        dado ano, iniciada com a primeira semana do ano com pelo menos 4 finais de
                        semana, sendo a segunda-feira como o início da semana.<return>01</return> até <return>53</return> (onde 53 é
                        responsável por uma sobreposição)<return>%W</return>Representação numérica da semana do ano,
                        começando pela primeira segunda-feira como primeira semana<return>46</return> (como a 46ª
                        semana do do ano iniciando na segunda-feira)Mês------<return>%b</return>Nome do mês
                        abreviado, baseado no idioma<return>jan</return> até <return>dez</return><return>%B</return>Nome completo do mês, baseado no
                        idioma<return>janeiro</return> até <return>dezembro</return><return>%h</return>Nome do mês abreviado, baseado no idioma
                        (sinônimo de %b)<return>jan</return> até <return>dez</return><return>%m</return>Representação com dois dígitos do mês<return>01</return> (para
                        janeiro) até <return>12</return> (para dezembro)Ano------<return>%C</return>Representação, com dois dígitos,
                        do século (ano dividido por 100, truncado como inteiro)<return>19</return> para o século
                        20<return>%g</return>Representação do ano, com dois dígitos, seguindo o padrão ISO-8601:1988
                        (veja %V)Exemplo: <return>09</return> de 6 de janeiro de 2009<return>%G</return>Versão de 4 dígitos de
                        %gExemplo: <return>2008</return> de 3 de janeiro de 2009<return>%y</return>Representação, com dois dígitos, do
                        anoExemplo: <return>09</return> de 2009, <return>79</return> de 1979<return>%Y</return>Representação, com quatro dígitos, do
                        anoExemplo: <return>2038</return>Hora------<return>%H</return>Representação, com dois dígitos, da hora no
                        formato 24 horas<return>00</return> até <return>23</return><return>%k</return>Representação da hora no formato 24 horas, com um
                        espaço precedendo dígito único<return> 0</return> até <return>23</return><return>%I</return>Representação, com dois dígitos, da
                        hora no formato 12 horas<return>01</return> até <return>12</return><return>%l ('L' minúsculo)</return>Representação da hora no
                        formato 12 horas, com um espaço precedendo dígito único<return> 1</return> até
                        <return>12</return><return>%M</return>Representação, com dois dígitos, do minuto<return>00</return> até <return>59</return><return>%p</return>'AM' ou 'PM'
                        maiúsculo baseado na hora informadaExemplo: <return>AM</return> para 00:31, <return>PM</return> para 22:23. O
                        resultado exato depende do sistema operacional, e pode retornar variantes em
                        minúsculoas, ou variantes com pontos (como <return>a.m.</return>).<return>%P</return>'am' ou 'pm' maiúsculo
                        baseado na hora informadaExemplo: <return>am</return> para 00:31, <return>pm</return> para 22:23. Não
                        suportado por todos os sistemas operacionais.<return>%r</return>O mesmo que "%I:%M:%S
                        %p"Exemplo: <return>09:34:17 PM</return> de 21:34:17<return>%R</return>O mesmo que "%H:%M"Exemplo: <return>00:35</return> de
                        12:35 AM, <return>16:44</return> de 4:44 PM<return>%S</return>Representação, com dois dígitos, do segundo<return>00</return>
                        até <return>59</return><return>%T</return>O mesmo que "%H:%M:%S"Exemplo: <return>21:34:17</return> para 09:34:17
                        PM<return>%X</return>Representação escolhida baseada no idioma, sem a dataExemplo: <return>03:59:16</return>
                        ou <return>15:59:16</return><return>%z</return>O deslocamento do fuso horário. Não implementado como descrito
                        no Windows. Veja mais informações a seguir.Exemplo: <return>-0500</return> para hora à leste
                        dos EUA<return>%Z</return>A abreviação do fuso horário. Não implementado como descrito no
                        Windows. Veja mais informações a seguir.Exemplo: <return>EST</return> para Eastern
                        TimeCarimbos de Data e Hora------<return>%c</return>Carimbo escolhido de data e hora baseado
                        no idiomaExemplo: <return>Ter Fev  5 00:45:10 2009</return> de February 5, 2009 at 12:45:10
                        AM<return>%D</return>O mesmo que "%m/%d/%y"Exemplo: <return>02/05/09</return> de February 5, 2009<return>%F</return>O mesmo que
                        "%Y-%m-%d" (geralmente utilizado em carimbos de data em bancos de
                        dados)Exemplo: <return>2009-02-05</return> de February 5, 2009<return>%s</return>Timestamp Unix(o mesmo que a
                        função <strong>time()</strong> function)Exemplo: <return>305815200</return> de September 10, 1979 08:40:00
                        AM<return>%x</return>Representação da data baseada na preferência da localidade, sem a
                        horaExemplo: <return>02/05/09</return> de February 5, 2009Miscelânea------<return>%n</return>Uma nova linha
                        ("\n")---<return>%t</return>Um caractere TAB ("\t")---<return>%%</return>Um caractere literal de porcento
                        ("%")---
                        
                        Contrário a ISO-9899:1999, o sistema Sun Solaris começa a semana no Domingo,
                        como 1. Resultando em <return>%u</return> não funcionando como descrito neste manual.
                        
                        Somente no Windows:
                        
                        O modificador <return>%e</return> não possui suporte a implementação desta função no Windows.
                        Para conseguir este valor, o modificador <return>%#d</return> pode ser utilizado em
                        substituição. O exemplo a seguir ilustra como escrever uma função com
                        compatibilidade multiplataforma.
                        
                        Os modificadores <return>%z</return> e <return>%Z</return> retornam o nome do fuso horário em vez do
                        deslocamento ou abreviação do mesmo.
                        
                        macOS and musl only: O modificador <return>%P</return> não é suportado na implementação macOS
                        desta função.
  <info>int|null</info>  <strong>$timestamp</strong>  O parâmetro opcional <strong>$timestamp</strong> é um
                        <info>int</info> de timestamp Unix cujo padrão é a hora local
                        atual se <strong>$timestamp</strong> não for informado ou for <info>null</info>. Em outras
                        palavras, o padrão é o valor de <strong>time()</strong>.

<comment>Return:</comment>
  <info>string|false</info>  Retorna uma string formatada de acordo com o <strong>$format</strong> informado em <strong>$timestamp</strong> ou o
                horário local atual se nenhum timestamp foi informado. Nomes de meses e dia da
                semana, e outras strings dependentes de linguagens respeitam o idioma definido com a
                função <strong>setlocale()</strong>. A função retorna <info>false</info> se <strong>$format</strong> for vazio, contém
                especificadores de conversão não suportados, ou se o comprimento da string retornada
                fosse maior que <return>4095</return>.

<comment>See Also:</comment>
   * IntlDateFormatter::format
   * DateTimeInterface::format
   * Ferramenta online para criação de formatos compatíveis com o strftime()
   * <strong>setlocale()</strong>
   * <strong>mktime()</strong>
   * <strong>strptime()</strong>
   * <strong>gmstrftime()</strong>
   * Especificação Open Group da <strong>strftime()</strong>


id: strip_tags
type: function
doc:
<comment>Description:</comment>
  Retira as tags HTML e PHP de uma string
  
  Esta função tenta retornar uma string com todos os bytes nulos e tags HTML e PHP removidas da
  <strong>$string</strong> informada. Usa a mesma máquina de estados de remoção de tags que a função <strong>fgetss()</strong>.

<comment>Param:</comment>
  <info>string</info>             <strong>$string</strong>        A string de entrada.
  <info>array|string|null</info>  <strong>$allowed_tags</strong>  Pode-se utilizar o segundo parâmetro, que é opcional, para
                                    indicar tags que não devam ser retiradas. Podem ser informadas
                                    como <info>string</info>, ou a partir do PHP 7.4.0, como <info>array</info>. Refira-se ao
                                    exemplo abaixo sobre o formato deste parâmetro.
                                    
                                    Comentários HTML e tags PHP também são retirados. Isto não pode
                                    ser modificado com <strong>$allowed_tags</strong>.
                                    
                                    Tags XHTML com auto-fechamento são ignoradas e apenas tags sem
                                    auto-fechamento devem ser usadas em <strong>$allowed_tags</strong>. Por examplo,
                                    para permitir tanto <return>\<br&gt;</return> quanto <return>\<br/&gt;</return>, deve-se usar:

<comment>Return:</comment>
  <info>string</info>  Retorna a string modificada.

<comment>See Also:</comment>
   * <strong>htmlspecialchars()</strong>


id: stripcslashes
type: function
doc:
<comment>Description:</comment>
  Remove o escape de strings escapadas com addcslashes
  
  Retorna uma string com as barras invertidas retiradas. Reconhece represenações no estilo C <return>\n</return>, <return>\r</return>
  ..., octais e hexadecimais.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string para remover os escapes.

<comment>Return:</comment>
  <info>string</info>  Retorna a string com escapes retirados.

<comment>See Also:</comment>
   * <strong>addcslashes()</strong>


id: stripos
type: function
doc:
<comment>Description:</comment>
  Find the position of the first occurrence of a case-insensitive substring in a string
  
  Find the numeric position of the first occurrence of <strong>$needle</strong> in the <strong>$haystack</strong> string.
  
  Unlike the <strong>strpos()</strong>, <strong>stripos()</strong> is case-insensitive.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  The string to search in.
  <info>string</info>  <strong>$needle</strong>    The string to search for.
                     
                     Antes do PHP 8.0.0, se <strong>$needle</strong> não for uma string, ela será convertida para um
                     número inteiro e aplicada como o valor ordinal de um caractere. Este
                     comportamento tornou-se obsoleto a partir do PHP 7.3.0 e depender dele é
                     altamente desaconselhado. Dependendo do comportamento pretendido, o parâmetro
                     <strong>$needle</strong> deve ser explicitamente convertido em string ou uma chamada explícita
                     para <strong>chr()</strong> deve ser realizada.
  <info>int</info>     <strong>$offset</strong>    If specified, search will start this number of characters counted from the
                     beginning of the string. If the offset is negative, the search will start this
                     number of characters counted from the end of the string.

<comment>Return:</comment>
  <info>int|false</info>  Returns the position of where the needle exists relative to the beginning of the
             <strong>$haystack</strong> string (independent of offset). Also note that string positions start at 0,
             and not 1.
             
             Returns <info>false</info> if the needle was not found.
             
             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>
   * <strong>mb_stripos()</strong>
   * <strong>str_contains()</strong>
   * <strong>str_ends_with()</strong>
   * <strong>str_starts_with()</strong>
   * <strong>strpos()</strong>
   * <strong>strrpos()</strong>
   * <strong>strripos()</strong>
   * <strong>stristr()</strong>
   * <strong>substr()</strong>
   * <strong>str_ireplace()</strong>


id: stripslashes
type: function
doc:
<comment>Description:</comment>
  Desfaz os escapes de uma string escapada
  
  Remove barras invertidas de uma string.
  
  <strong>stripslashes()</strong> pode ser utilizada quando você não esta inserindo estes dados em um lugar (como um
  banco de dados) que precise de escapar. Por exemplo, se você esta usando estes dados para gerar um
  formulário HTML.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string de entrada.

<comment>Return:</comment>
  <info>string</info>  Retorna uma string com as barras invertidas retiradas. (<return>\'</return> se torna <return>'</return> e assim por diante.)
          Duas barras invertidas (<return>\\</return>) se tornam uma (<return>\</return>).

<comment>See Also:</comment>
   * <strong>addslashes()</strong>
   * <strong>get_magic_quotes_gpc()</strong>


id: stristr
type: function
doc:
<comment>Description:</comment>
  Case-insensitive strstr
  
  Returns all of <strong>$haystack</strong> starting from and including the first occurrence of <strong>$needle</strong> to the end.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>       The string to search in
  <info>string</info>  <strong>$needle</strong>         The string to search for.
                          
                          Antes do PHP 8.0.0, se <strong>$needle</strong> não for uma string, ela será convertida
                          para um número inteiro e aplicada como o valor ordinal de um caractere.
                          Este comportamento tornou-se obsoleto a partir do PHP 7.3.0 e depender
                          dele é altamente desaconselhado. Dependendo do comportamento pretendido, o
                          parâmetro <strong>$needle</strong> deve ser explicitamente convertido em string ou uma
                          chamada explícita para <strong>chr()</strong> deve ser realizada.
  <info>bool</info>    <strong>$before_needle</strong>  If <info>true</info>, <strong>stristr()</strong> returns the part of the <strong>$haystack</strong> before the first
                          occurrence of the <strong>$needle</strong> (excluding needle).

<comment>Return:</comment>
  <info>string|false</info>  Returns the matched substring. If <strong>$needle</strong> is not found, returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>strstr()</strong>
   * <strong>strrchr()</strong>
   * <strong>stripos()</strong>
   * <strong>strpbrk()</strong>
   * <strong>preg_match()</strong>


id: strlen
type: function
doc:
<comment>Description:</comment>
  Retorna o tamanho de uma string
  
  Retorna o tamanho da <strong>$string</strong> informada.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A <info>string</info> a ter seu tamanho medido.

<comment>Return:</comment>
  <info>int</info>  O tamanho da <strong>$string</strong> em bytes.

<comment>See Also:</comment>
   * <strong>count()</strong>
   * <strong>grapheme_strlen()</strong>
   * <strong>iconv_strlen()</strong>
   * <strong>mb_strlen()</strong>


id: strnatcasecmp
type: function
doc:
<comment>Description:</comment>
  Comparação de strings insensível a maiúsculas/minúsculas usando o algoritmo de "ordem natural"
  
  Esta função implementa um algoritmo de comparação que ordena strings alfanuméricos da maneira que
  um ser humano faria. O comportamento desta função é similar a <strong>strnatcmp()</strong>, exceto que a comparação
  não é sensível a maiúsculas/minúsculas. Para maiores informações consulte: Comparação de Strings
  em Ordem Natural, de Martin Pool.

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>  A primeira string.
  <info>string</info>  <strong>$string2</strong>  A segunda string.

<comment>Return:</comment>
  <info>int</info>  Similar a outras funções de comparação de strings, esta retorna <return>-1</return> se <strong>$string1</strong> representar
       menos que <strong>$string2</strong> <return>1</return> se <strong>$string1</strong> representar mais que <strong>$string2</strong>, e <return>0</return> se forem iguais.

<comment>See Also:</comment>
   * <strong>preg_match()</strong>
   * <strong>strcmp()</strong>
   * <strong>strcasecmp()</strong>
   * <strong>substr()</strong>
   * <strong>stristr()</strong>
   * <strong>strncasecmp()</strong>
   * <strong>strncmp()</strong>
   * <strong>strstr()</strong>
   * <strong>setlocale()</strong>


id: strnatcmp
type: function
doc:
<comment>Description:</comment>
  String comparisons using a "natural order" algorithm
  
  This function implements a comparison algorithm that orders alphanumeric strings in the way a
  human being would, this is described as a "natural ordering".   Note that this comparison is case
  sensitive.

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>  The first string.
  <info>string</info>  <strong>$string2</strong>  The second string.

<comment>Return:</comment>
  <info>int</info>  Similar to other string comparison functions, this one returns <return>-1</return> if <strong>$string1</strong> is less than
       <strong>$string2</strong>; <return>1</return> if <strong>$string1</strong> is greater than <strong>$string2</strong>, and <return>0</return> if they are equal.

<comment>See Also:</comment>
   * <strong>preg_match()</strong>
   * <strong>strcasecmp()</strong>
   * <strong>substr()</strong>
   * <strong>stristr()</strong>
   * <strong>strcmp()</strong>
   * <strong>strncmp()</strong>
   * <strong>strncasecmp()</strong>
   * <strong>strnatcasecmp()</strong>
   * <strong>strstr()</strong>
   * <strong>natsort()</strong>
   * <strong>natcasesort()</strong>


id: strncasecmp
type: function
doc:
<comment>Description:</comment>
  Comparação binária de strings, insensível a maiúsculas/minúsculas, dos primeiros n caracteres
  
  Esta função é similar a <strong>strcasecmp()</strong>, com a diferença que pode ser especificado o número (limite
  superior) de caracteres de cada string usada na comparação.

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>  A primeira string.
  <info>string</info>  <strong>$string2</strong>  A segunda string.
  <info>int</info>     <strong>$length</strong>   O tamanho das strings, que será usado na comparação.

<comment>Return:</comment>
  <info>int</info>  Retorna <return>-1</return> se <strong>$string1</strong> representa menos que <strong>$string2</strong>; <return>1</return> se <strong>$string1</strong> representa mais que
       <strong>$string2</strong>, e <return>0</return> se são iguais.

<comment>See Also:</comment>
   * <strong>strncmp()</strong>
   * <strong>preg_match()</strong>
   * <strong>substr_compare()</strong>
   * <strong>strcasecmp()</strong>
   * <strong>stristr()</strong>
   * <strong>substr()</strong>


id: strncmp
type: function
doc:
<comment>Description:</comment>
  Binary safe string comparison of the first n characters
  
  This function is similar to <strong>strcmp()</strong>, with the difference that you can specify the (upper limit of
  the) number of characters from each string to be used in the comparison.
  
  Note that this comparison is case sensitive.

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>  The first string.
  <info>string</info>  <strong>$string2</strong>  The second string.
  <info>int</info>     <strong>$length</strong>   Number of characters to use in the comparison.

<comment>Return:</comment>
  <info>int</info>  Returns <return>-1</return> if <strong>$string1</strong> is less than <strong>$string2</strong>; <return>1</return> if <strong>$string1</strong> is greater than <strong>$string2</strong>, and <return>0</return>
       if they are equal.

<comment>See Also:</comment>
   * <strong>strncasecmp()</strong>
   * <strong>preg_match()</strong>
   * <strong>substr_compare()</strong>
   * <strong>strcmp()</strong>
   * <strong>strstr()</strong>
   * <strong>substr()</strong>


id: strpbrk
type: function
doc:
<comment>Description:</comment>
  Procura na string por um dos caracteres de um conjunto
  
  <strong>strpbrk()</strong> busca na <strong>$string</strong> por qualquer caractere contido em <strong>$characters</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>      A string onde <strong>$characters</strong> é procurado.
  <info>string</info>  <strong>$characters</strong>  Este parâmetro é sensível a maiúsculas/minúsculas.

<comment>Return:</comment>
  <info>string|false</info>  Retorna uma string iniciando do caractere encontrado, ou <info>false</info> se nada for
                encontrado.

<comment>See Also:</comment>
   * <strong>strpos()</strong>
   * <strong>strstr()</strong>
   * <strong>preg_match()</strong>


id: strpos
type: function
doc:
<comment>Description:</comment>
  Find the position of the first occurrence of a substring in a string
  
  Find the numeric position of the first occurrence of <strong>$needle</strong> in the <strong>$haystack</strong> string.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  The string to search in.
  <info>string</info>  <strong>$needle</strong>    The string to search for.
                     
                     Antes do PHP 8.0.0, se <strong>$needle</strong> não for uma string, ela será convertida para um
                     número inteiro e aplicada como o valor ordinal de um caractere. Este
                     comportamento tornou-se obsoleto a partir do PHP 7.3.0 e depender dele é
                     altamente desaconselhado. Dependendo do comportamento pretendido, o parâmetro
                     <strong>$needle</strong> deve ser explicitamente convertido em string ou uma chamada explícita
                     para <strong>chr()</strong> deve ser realizada.
  <info>int</info>     <strong>$offset</strong>    If specified, search will start this number of characters counted from the
                     beginning of the string. If the offset is negative, the search will start this
                     number of characters counted from the end of the string.

<comment>Return:</comment>
  <info>int|false</info>  Returns the position of where the needle exists relative to the beginning of the
             <strong>$haystack</strong> string (independent of offset). Also note that string positions start at 0,
             and not 1.
             
             Returns <info>false</info> if the needle was not found.
             
             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>
   * <strong>stripos()</strong>
   * <strong>str_contains()</strong>
   * <strong>str_ends_with()</strong>
   * <strong>str_starts_with()</strong>
   * <strong>strrpos()</strong>
   * <strong>strripos()</strong>
   * <strong>strstr()</strong>
   * <strong>strpbrk()</strong>
   * <strong>substr()</strong>
   * <strong>preg_match()</strong>


id: strptime
type: function
doc:
<comment>Description:</comment>
  Interpreta uma hora/data gerada pela função strftime
      
  
  <strong>strptime()</strong> retorna um array com a <strong>$timestamp</strong> analisada, ou <info>false</info> em caso de erro.
  
  Nomes de meses e semanas, e outras strings que dependem do idioma, respeitam o idioma corrente
  definido com a função <strong>setlocale()</strong> (<info>LC_TIME</info>).

<comment>Param:</comment>
  <info>string</info>  <strong>$timestamp</strong>  A string a ser interpretada (retornada da função <strong>strftime()</strong>).
  <info>string</info>  <strong>$format</strong>     O formato utilizado em <strong>$timestamp</strong> (o mesmo utilizado na função <strong>strftime()</strong>).
                      Note que algumas opções de formato disponíveis na função <strong>strftime()</strong> podem não
                      ter nenhum efeito com <strong>strptime()</strong>; o subconjunto exato que é suportado vai
                      variar por ser baseado no sistema operacional e biblioteca C em uso.
                      
                      Para mais informações sobre as opções de formato, veja a página da função
                      <strong>strftime()</strong>.

<comment>Return:</comment>
  <info>array|false</info>  Retorna um array ou <info>false</info> em caso de falha.
               
               Os seguintes parâmetros são retornados no arrayParâmetroDescrição<return>"tm_sec"</return>Segundos
               após o minuto (0-61)<return>"tm_min"</return>Minutos após a hora (0-59)<return>"tm_hour"</return>Horas passadas desde a
               meia-noite (0-23)<return>"tm_mday"</return>Dia do mês (1-31)<return>"tm_mon"</return>Meses passados desde janeiro
               (0-11)<return>"tm_year"</return>Anos passados desde 1900<return>"tm_wday"</return>Dias passados desde domingo
               (0-6)<return>"tm_yday"</return>Dias passados desde 1º de janeiro 1 (0-365)<return>"unparsed"</return>A parte <strong>$timestamp</strong>
               que não foi reconhecida usando o <strong>$format</strong> especificado

<comment>See Also:</comment>
   * IntlDateFormatter::parse
   * DateTime::createFromFormat
   * <strong>checkdate()</strong>
   * <strong>strftime()</strong>
   * <strong>date_parse_from_format()</strong>


id: strrchr
type: function
doc:
<comment>Description:</comment>
  Find the last occurrence of a character in a string
  
  This function returns the portion of <strong>$haystack</strong> which starts at the last occurrence of <strong>$needle</strong> and
  goes until the end of <strong>$haystack</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>       The string to search in
  <info>string</info>  <strong>$needle</strong>         If <strong>$needle</strong> contains more than one character, only the first is used. This
                          behavior is different from that of <strong>strstr()</strong>.
                          
                          Antes do PHP 8.0.0, se <strong>$needle</strong> não for uma string, ela será convertida
                          para um número inteiro e aplicada como o valor ordinal de um caractere.
                          Este comportamento tornou-se obsoleto a partir do PHP 7.3.0 e depender
                          dele é altamente desaconselhado. Dependendo do comportamento pretendido, o
                          parâmetro <strong>$needle</strong> deve ser explicitamente convertido em string ou uma
                          chamada explícita para <strong>chr()</strong> deve ser realizada.
  <info>bool</info>    <strong>$before_needle</strong>  If <info>true</info>, <strong>strrchr()</strong> returns the part of the <strong>$haystack</strong> before the last
                          occurrence of the <strong>$needle</strong> (excluding the needle).

<comment>Return:</comment>
  <info>string|false</info>  This function returns the portion of string, or <info>false</info> if <strong>$needle</strong> is not found.

<comment>See Also:</comment>
   * <strong>strstr()</strong>
   * <strong>strrpos()</strong>


id: strrev
type: function
doc:
<comment>Description:</comment>
  Reverte uma string
  
  Retorna a <strong>$string</strong> revertida.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string a ser revertida.

<comment>Return:</comment>
  <info>string</info>  Retorna a string revertida.


id: strripos
type: function
doc:
<comment>Description:</comment>
  Find the position of the last occurrence of a case-insensitive substring in a string
  
  Find the numeric position of the last occurrence of <strong>$needle</strong> in the <strong>$haystack</strong> string.
  
  Unlike the <strong>strrpos()</strong>, <strong>strripos()</strong> is case-insensitive.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  The string to search in.
  <info>string</info>  <strong>$needle</strong>    The string to search for.
                     
                     Antes do PHP 8.0.0, se <strong>$needle</strong> não for uma string, ela será convertida para um
                     número inteiro e aplicada como o valor ordinal de um caractere. Este
                     comportamento tornou-se obsoleto a partir do PHP 7.3.0 e depender dele é
                     altamente desaconselhado. Dependendo do comportamento pretendido, o parâmetro
                     <strong>$needle</strong> deve ser explicitamente convertido em string ou uma chamada explícita
                     para <strong>chr()</strong> deve ser realizada.
  <info>int</info>     <strong>$offset</strong>    If zero or positive, the search is performed left to right skipping the first
                     <strong>$offset</strong> bytes of the <strong>$haystack</strong>.
                     
                     If negative, the search is performed right to left skipping the last <strong>$offset</strong>
                     bytes of the <strong>$haystack</strong> and searching for the first occurrence of <strong>$needle</strong>.  This
                     is effectively looking for the last occurrence of <strong>$needle</strong> before the last
                     <strong>$offset</strong> bytes.
                     
                     This is effectively looking for the last occurrence of <strong>$needle</strong> before the last
                     <strong>$offset</strong> bytes.

<comment>Return:</comment>
  <info>int|false</info>  Returns the position where the needle exists relative to the beginnning of the
             <strong>$haystack</strong> string (independent of search direction or offset).  String positions start
             at 0, and not 1.
             
             String positions start at 0, and not 1.
             
             Returns <info>false</info> if the needle was not found.
             
             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>
   * <strong>strpos()</strong>
   * <strong>stripos()</strong>
   * <strong>strrpos()</strong>
   * <strong>strrchr()</strong>
   * <strong>stristr()</strong>
   * <strong>substr()</strong>


id: strrpos
type: function
doc:
<comment>Description:</comment>
  Find the position of the last occurrence of a substring in a string
  
  Find the numeric position of the last occurrence of <strong>$needle</strong> in the <strong>$haystack</strong> string.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  The string to search in.
  <info>string</info>  <strong>$needle</strong>    The string to search for.
                     
                     Antes do PHP 8.0.0, se <strong>$needle</strong> não for uma string, ela será convertida para um
                     número inteiro e aplicada como o valor ordinal de um caractere. Este
                     comportamento tornou-se obsoleto a partir do PHP 7.3.0 e depender dele é
                     altamente desaconselhado. Dependendo do comportamento pretendido, o parâmetro
                     <strong>$needle</strong> deve ser explicitamente convertido em string ou uma chamada explícita
                     para <strong>chr()</strong> deve ser realizada.
  <info>int</info>     <strong>$offset</strong>    If zero or positive, the search is performed left to right skipping the first
                     <strong>$offset</strong> bytes of the <strong>$haystack</strong>.
                     
                     If negative, the search starts <strong>$offset</strong> bytes from the right instead of from the
                     beginning of <strong>$haystack</strong>. The search is performed right to left, searching for
                     the first occurrence of <strong>$needle</strong> from the selected byte.  This is effectively
                     looking for the last occurrence of <strong>$needle</strong> at or before the last <strong>$offset</strong> bytes.
                     
                     This is effectively looking for the last occurrence of <strong>$needle</strong> at or before the
                     last <strong>$offset</strong> bytes.

<comment>Return:</comment>
  <info>int|false</info>  Returns the position where the needle exists relative to the beginning of the <strong>$haystack</strong>
             string (independent of search direction or offset).  String positions start at 0, and
             not 1.
             
             String positions start at 0, and not 1.
             
             Returns <info>false</info> if the needle was not found.
             
             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>
   * <strong>strpos()</strong>
   * <strong>stripos()</strong>
   * <strong>strripos()</strong>
   * <strong>strrchr()</strong>
   * <strong>substr()</strong>


id: strspn
type: function
doc:
<comment>Description:</comment>
  Encontra o comprimento do segmento inicial de uma string composta
     totalmente de caracteres contidos em uma máscara informada
    
  
  Encontra o comprimento do segmento inicial da <strong>$string</strong> que contenha somente caracteres contidos em
  <strong>$characters</strong>.
  
  Se <strong>$offset</strong> e <strong>$length</strong> forem omitidos, então toda a <strong>$string</strong> será examinada. Se forem incluídos, o
  efeito será o mesmo que chamar <return>strspn(substr($string, $offset, $length), $characters)</return> (consulte
  para mais informações).
  
  A linha de código: 
  ]]> atribuirá <return>2</return> para $var, porque a string "42" é o segmento inicial de <strong>$string</strong> que consiste
  somente de caracteres contidos em "1234567890".

<comment>Param:</comment>
  <info>string</info>    <strong>$string</strong>      A primeira a ser examinada.
  <info>string</info>    <strong>$characters</strong>  A lista de caracteres permitidos.
  <info>int</info>       <strong>$offset</strong>      A posição na <strong>$string</strong> para iniciar a pesquisa.
                         
                         Se <strong>$offset</strong> for informado e não negativo, a função <strong>strspn()</strong> começará a
                         examinar a <strong>$string</strong> na posição <strong>$offset</strong>. Por exemplo, na string '<return>abcdef</return>', o
                         caractere na posição <return>0</return> é '<return>a</return>', na posição <return>2</return> é '<return>c</return>', e assim por diante.
                         
                         Se <strong>$offset</strong> for informado e negativo, a função <strong>strspn()</strong> começará a examinar
                         a <strong>$string</strong> na posição <strong>$offset</strong> a partir do final da <strong>$string</strong>.
  <info>int|null</info>  <strong>$length</strong>      O tamanho do segmento da <strong>$string</strong> a ser examinado.
                         
                         Se <strong>$length</strong> for informado e não negativo, a <strong>$string</strong> será examinada pelo
                         número de caracteres em <strong>$length</strong> a partir da posição inicial.
                         
                         Se <strong>$length</strong> for informado e negativo, a <strong>$string</strong> será examinada a partir da
                         posição inicial até o número de caracteres informado em <strong>$length</strong> contados a
                         partir do final da <strong>$string</strong>.

<comment>Return:</comment>
  <info>int</info>  Retorna o comprimento do segmento inicial de <strong>$string</strong> que consistir inteiramente dos
       caracteres definidos em <strong>$characters</strong>.
       
       Quando o parâmetro <strong>$offset</strong> estiver definido, o comprimento retornado é contado iniciando-se
       desta posição, não do início da <strong>$string</strong>.

<comment>See Also:</comment>
   * <strong>strcspn()</strong>


id: strstr
type: function
doc:
<comment>Description:</comment>
  Find the first occurrence of a string
  
  Returns part of <strong>$haystack</strong> string starting from and including the first occurrence of <strong>$needle</strong> to
  the end of <strong>$haystack</strong>.
  
  This function is case-sensitive. For case-insensitive searches, use <strong>stristr()</strong>.
  
  If you only want to determine if a particular <strong>$needle</strong> occurs within <strong>$haystack</strong>, use the faster and
  less memory intensive function <strong>strpos()</strong> instead.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>       The input string.
  <info>string</info>  <strong>$needle</strong>         The string to search for.
                          
                          Antes do PHP 8.0.0, se <strong>$needle</strong> não for uma string, ela será convertida
                          para um número inteiro e aplicada como o valor ordinal de um caractere.
                          Este comportamento tornou-se obsoleto a partir do PHP 7.3.0 e depender
                          dele é altamente desaconselhado. Dependendo do comportamento pretendido, o
                          parâmetro <strong>$needle</strong> deve ser explicitamente convertido em string ou uma
                          chamada explícita para <strong>chr()</strong> deve ser realizada.
  <info>bool</info>    <strong>$before_needle</strong>  If <info>true</info>, <strong>strstr()</strong> returns the part of the <strong>$haystack</strong> before the first
                          occurrence of the <strong>$needle</strong> (excluding the needle).

<comment>Return:</comment>
  <info>string|false</info>  Returns the portion of string, or <info>false</info> if <strong>$needle</strong> is not found.

<comment>See Also:</comment>
   * <strong>stristr()</strong>
   * <strong>strrchr()</strong>
   * <strong>strpos()</strong>
   * <strong>strpbrk()</strong>
   * <strong>preg_match()</strong>


id: strtok
type: function
doc:
<comment>Description:</comment>
  Tokenize string
  
  Alternative signature (not supported with named arguments):
  
  <strong>strtok()</strong> splits a string (<strong>$string</strong>) into smaller strings (tokens), with each token being delimited
  by any character from <strong>$token</strong>. That is, if you have a string like "This is an example string" you
  could tokenize this string into its individual words by using the space character as the <strong>$token</strong>.
  
  Note that only the first call to strtok uses the <strong>$string</strong> argument. Every subsequent call to strtok
  only needs the <strong>$token</strong> to use, as it keeps track of where it is in the current string.  To start
  over, or to tokenize a new string you simply call strtok with the <strong>$string</strong> argument again to
  initialize it.  Note that you may put multiple tokens in the <strong>$token</strong> parameter.  The string will be
  tokenized when any one of the characters in the <strong>$token</strong> argument is found.
  
  This function behaves slightly different from what one may expect being familiar with <strong>explode()</strong>.
  First, a sequence of two or more contiguous <strong>$token</strong> characters in the parsed string is considered
  to be a single delimiter.  Also, a <strong>$token</strong> situated at the start or end of the string is ignored.
  For example, if a string <return>";aaa;;bbb;"</return> is used, successive calls to <strong>strtok()</strong> with <return>";"</return> as a <strong>$token</strong>
  would return strings "aaa" and "bbb", and then <info>false</info>. As a result, the string will be split into
  only two elements, while <return>explode(";", $string)</return> would return an array of 5 elements.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The <info>string</info> being split up into smaller strings (tokens).
  <info>string</info>  <strong>$token</strong>   The delimiter used when splitting up <strong>$string</strong>.

<comment>Return:</comment>
  <info>string|false</info>  A <info>string</info> token, or <info>false</info> if no more tokens are available.

<comment>See Also:</comment>
   * <strong>explode()</strong>


id: strtolower
type: function
doc:
<comment>Description:</comment>
  Converte uma string para minúsculas
  
  Retorna uma <strong>$string</strong> com todos os caracteres alfabéticos ASCII convertidos para minúsculas.
  
  Bytes na faixa <return>"A"</return> (0x41) a <return>"Z"</return> (0x5a) serão convertidos para a letra minúscula correspondente
  pela adição de 32 a cada valor de byte.
  
  Esta função pode ser usada para converter caracteres ASCII em string codificadas com UTF-8, já que
  os caracteres multibyte UTF-8 serão ignorados. Para converter caracteres multibyte não-ASCII, use
  <strong>mb_strtolower()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string de entrada.

<comment>Return:</comment>
  <info>string</info>  Retorna a string minúscula.

<comment>See Also:</comment>
   * <strong>strtoupper()</strong>
   * <strong>ucfirst()</strong>
   * <strong>ucwords()</strong>
   * <strong>mb_strtolower()</strong>


id: strtotime
type: function
doc:
<comment>Description:</comment>
  Interpreta qualquer descrição textual de data/hora em inglês para timestamp Unix
  
  A função espera que seja informada uma string contendo um formato de data em inglês US, e tentará
  interpretá-lo para um timestamp Unix (o número de segundos desde 1º de janeiro de 1970 00:00:00
  GMT), relativo ao timestamp dado em <strong>$baseTimestamp</strong>, ou o horário atual se <strong>$baseTimestamp</strong> não for
  fornecido. A interpretação da string de data está definida em Formatos de Data e Horário, e tem
  várias considerações sutis. Rever os detalhes completos dessas definições é fortemente
  recomendado.
  
  O timestamp Unix que esta função retorna não contém informação sobre fuso horário. Para realizar
  cálculos com informação de data/hora, deve-se usar a classe com mais capacidade <class>DateTimeImmutable</class>.
  
  Cada parâmetro desta função utiliza o fuso horário padrão, a não ser que um fuso horário seja
  especificado neste parâmetro. Tome cuidado para não utilizar fusos horários diferentes em cada um
  dos parâmetros a não ser que seja o pretendido. Veja a função <strong>date_default_timezone_get()</strong> para
  verificar as diversas formas de definir um fuso horário padrão.

<comment>Param:</comment>
  <info>string</info>    <strong>$datetime</strong>       Uma string de data/hora. Os formatos válidos são explicados em Formatos
                            de Data e Hora.
  <info>int|null</info>  <strong>$baseTimestamp</strong>  O timestamp que será utilizado como base no cálculo das datas relativas.

<comment>Return:</comment>
  <info>int|false</info>  Retorna um timestamp em sucesso, <info>false</info> caso contrário.

<comment>See Also:</comment>
   * <class>DateTimeImmutable</class>
   * DateTimeImmutable::createFromFormat
   * Formatos de Data e Hora
   * <strong>checkdate()</strong>
   * <strong>strptime()</strong>


id: strtoupper
type: function
doc:
<comment>Description:</comment>
  Make a string uppercase
  
  Returns <strong>$string</strong> with all ASCII alphabetic characters converted to uppercase.
  
  Bytes in the range <return>"a"</return> (0x61) to <return>"z"</return> (0x7a) will be converted to the corresponding uppercase
  letter by subtracting 32 from each byte value.
  
  This can be used to convert ASCII characters within strings encoded with UTF-8, since multibyte
  UTF-8 characters will be ignored. To convert multibyte non-ASCII characters, use <strong>mb_strtoupper()</strong>.

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

<comment>Return:</comment>
  <info>string</info>  Returns the uppercased string.

<comment>See Also:</comment>
   * <strong>strtolower()</strong>
   * <strong>ucfirst()</strong>
   * <strong>ucwords()</strong>
   * <strong>mb_strtoupper()</strong>


id: strtr
type: function
doc:
<comment>Description:</comment>
  Translate characters or replace substrings
  
  Alternative signature (not supported with named arguments):
  
  If given three arguments, this function returns a copy of <strong>$string</strong> where all occurrences of each
  (single-byte) character in <strong>$from</strong> have been translated to the corresponding character in <strong>$to</strong>, i.e.,
  every occurrence of <return>$from[$n]</return> has been replaced with <return>$to[$n]</return>, where <return>$n</return> is a valid offset in both
  arguments.
  
  If <strong>$from</strong> and <strong>$to</strong> have different lengths, the extra characters in the longer of the two are
  ignored. The length of <strong>$string</strong> will be the same as the return value's.
  
  If given two arguments, the second should be an <info>array</info> in the form <return>array('from' =&gt; 'to', ...)</return>.
  The return value is a <info>string</info> where all the occurrences of the array keys have been replaced by the
  corresponding values. The longest keys will be tried first. Once a substring has been replaced,
  its new value will not be searched again.
  
  In this case, the keys and the values may have any length, provided that there is no empty key;
  additionally, the length of the return value may differ from that of <strong>$string</strong>. However, this
  function will be the most efficient when all the keys have the same size.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>         The <info>string</info> being translated.
  <info>string</info>  <strong>$from</strong>           The <info>string</info> being translated to <strong>$to</strong>.
  <info>string</info>  <strong>$to</strong>             The <info>string</info> replacing <strong>$from</strong>.
  <info>array</info>   <strong>$replace_pairs</strong>  The <strong>$replace_pairs</strong> parameter may be used instead of  <strong>$to</strong> and <strong>$from</strong>, in
                          which case it's an <info>array</info> in the form <return>array('from' =&gt; 'to', ...)</return>.
                          
                          If <strong>$replace_pairs</strong> contains a key which is an empty <info>string</info> (<return>""</return>), the
                          element is ignored; as of PHP 8.0.0 <info>E_WARNING</info> is raised in this case.

<comment>Return:</comment>
  <info>string</info>  Returns the translated <info>string</info>.

<comment>See Also:</comment>
   * <strong>str_replace()</strong>
   * <strong>preg_replace()</strong>


id: strval
type: function
doc:
<comment>Description:</comment>
  Retorna o valor string de uma variável
  
  Obtém o valor string de uma variável. Consulte a documentação sobre <info>string</info> para maiores
  informações sobre conversão para o tipo string.
  
  Esta função não faz nenhuma formatação no valor retornado. Se o objetivo for formatar um valor
  numérico como uma string, favor consultar <strong>sprintf()</strong> ou <strong>number_format()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  A variável que será convertida para o tipo <info>string</info>.
                 
                 <strong>$value</strong> pode ser qualquer tipo escalar, <info>null</info>, ou um objeto (<info>object</info>) que implemente o
                 método __toString(). <strong>strval()</strong> não pode ser usado em arrays ou em objetos que não
                 implementem o método __toString().

<comment>Return:</comment>
  <info>string</info>  O valor em <info>string</info> do parâmetro <strong>$value</strong>.

<comment>See Also:</comment>
   * <strong>boolval()</strong>
   * <strong>floatval()</strong>
   * <strong>intval()</strong>
   * <strong>settype()</strong>
   * <strong>sprintf()</strong>
   * <strong>number_format()</strong>
   * Manipulação de tipos
   * __toString()


id: substr
type: function
doc:
<comment>Description:</comment>
  Retorna parte de uma string
  
  Retorna a parte de <strong>$string</strong> especificada pelo parâmetro <strong>$offset</strong> e <strong>$length</strong>.

<comment>Param:</comment>
  <info>string</info>    <strong>$string</strong>  A string de entrada
  <info>int</info>       <strong>$offset</strong>  Se <strong>$offset</strong> for não-negativo, a string retornada iniciará na posição <strong>$offset</strong> em
                     <strong>$string</strong>, começando em zero. Por exemplo, na string '<return>abcdef</return>', o caractere na
                     posição <return>0</return> é '<return>a</return>', na posição <return>2</return> é '<return>c</return>', e assim por diante.
                     
                     Se <strong>$offset</strong> for negativo, a string retornada irá começar no caractere <strong>$offset</strong>
                     contado a partir do fim da <strong>$string</strong>.
                     
                     Se a <strong>$string</strong> for mais curta que o parâmetro <strong>$offset</strong>, uma string vazia será
                     retornada.
                     
                     Usando um <strong>$offset</strong> negativo
                     ]]>
  <info>int|null</info>  <strong>$length</strong>  Se <strong>$length</strong> for fornecido e for positivo, a string retornada irá conter, no
                     máximo, <strong>$length</strong> caracteres começando em <strong>$offset</strong> (dependendo do tamanho da
                     <strong>$string</strong>).
                     
                     Se <strong>$length</strong> for informado e for negativo, então esta quantidade caracteres será
                     omitida do final da <strong>$string</strong> (após a posicão de inicio ter sido calculada quando
                     <strong>$offset</strong> for negativo). Se <strong>$offset</strong> denota a posição da truncagem ou além, uma
                     string vazia será retornada.
                     
                     Se <strong>$length</strong> for informado e for igual a <return>0</return>, uma string vazia será retornada.
                     
                     Se <strong>$length</strong> for omitido ou <info>null</info>, a substring iniciando em <strong>$offset</strong> será
                     retornada.

<comment>Return:</comment>
  <info>string</info>  Retorna a parte extraída da <strong>$string</strong>, ou uma string vazia.

<comment>See Also:</comment>
   * <strong>strrchr()</strong>
   * <strong>substr_replace()</strong>
   * <strong>preg_match()</strong>
   * <strong>trim()</strong>
   * <strong>mb_substr()</strong>
   * <strong>wordwrap()</strong>
   * Acesso e modificação de strings por caractere


id: substr_compare
type: function
doc:
<comment>Description:</comment>
  Comparação binária de duas strings a partir de uma posição até n caracteres
  
  <strong>substr_compare()</strong> compara <strong>$haystack</strong> a partir da posição <strong>$offset</strong> com <strong>$needle</strong> até <strong>$length</strong> caracteres.

<comment>Param:</comment>
  <info>string</info>    <strong>$haystack</strong>          A string principal a ser comparada.
  <info>string</info>    <strong>$needle</strong>            A string secundária a ser comparada.
  <info>int</info>       <strong>$offset</strong>            A posição inicial para a comparação. Se negativa, inicia contando da
                               final da string.
  <info>int|null</info>  <strong>$length</strong>            O comprimento da comparação. O valor padrão é o maior comprimento
                               entre o comprimento de <strong>$needle</strong> comparado com o comprimento de
                               <strong>$haystack</strong> menos o <strong>$offset</strong>.
  <info>bool</info>      <strong>$case_insensitive</strong>  Se <strong>$case_insensitive</strong> for <info>true</info>, a comparação é insensível a
                               maiúsculas/minúsculas.

<comment>Return:</comment>
  <info>int</info>  Retorna <return>-1</return> se <strong>$haystack</strong> a partir da posição <strong>$offset</strong> for menor que <strong>$needle</strong>, <return>1</return> se for marior
       que <strong>$needle</strong>, e <return>0</return> se forem iguais. Se <strong>$offset</strong> for igual a (antes do PHP 7.2.18, 7.3.5) ou
       maior que o comprimento de <strong>$haystack</strong>, ou <strong>$length</strong> estiver definido e menor que 0,
       <strong>substr_compare()</strong> mostra um alerta e retorna <info>false</info>.

<comment>See Also:</comment>
   * <strong>strncmp()</strong>


id: substr_count
type: function
doc:
<comment>Description:</comment>
  Conta o número de ocorrências de uma substring
  
  <strong>substr_count()</strong> retorna o número de vezes que a substring <strong>$needle</strong> ocorre na string <strong>$haystack</strong>. Note
  que <strong>$needle</strong> faz distinção de maiúscula e minúscula.
  
  Esta função não conta substrings sobrepostas. Veja o exemplo abaixo!

<comment>Param:</comment>
  <info>string</info>    <strong>$haystack</strong>  A string onde será feita a busca
  <info>string</info>    <strong>$needle</strong>    A substring a ser procurada
  <info>int</info>       <strong>$offset</strong>    A posição onde deve-se iniciar a contagem. Se a posição for negativa, a
                       contagem começa do final da string.
  <info>int|null</info>  <strong>$length</strong>    O comprimento máximo depois da posição especificada para buscar pela
                       substring. Mostra um alerta se a posição mais o comprimento for maior que o
                       comprimento de <strong>$haystack</strong>. Um comprimento negativo conta a partir do final de
                       <strong>$haystack</strong>.

<comment>Return:</comment>
  <info>int</info>  Esta função retorna um <info>int</info>.

<comment>See Also:</comment>
   * <strong>count_chars()</strong>
   * <strong>strpos()</strong>
   * <strong>substr()</strong>
   * <strong>strstr()</strong>


id: substr_replace
type: function
doc:
<comment>Description:</comment>
  Substitui o texto dentro de uma parte de uma string
  
  <strong>substr_replace()</strong> substitui uma cópia de <strong>$string</strong> delimitada pelos parâmetros <strong>$offset</strong> e
  (opcionalmente) <strong>$length</strong> com a string informada em <strong>$replace</strong>.

<comment>Param:</comment>
  <info>array|string</info>    <strong>$string</strong>   A string de entrada.
                            
                            Um <info>array</info> de <info>string</info>s pode ser fornecido, e neste caso as substituições
                            irão ocorrer em um string de cada vez. Neste caso, os parâmetros
                            <strong>$replace</strong>, <strong>$offset</strong> e <strong>$length</strong> podem ser fornecidos tanto como valores
                            escalares a ser aplicados a um string de entrada de cada vez, quanto
                            como <info>array</info>s, neste caso o elemento correspondente do array será usado
                            por cada string de entrada.
  <info>array|string</info>    <strong>$replace</strong>  A string substituta.
  <info>array|int</info>       <strong>$offset</strong>   Se <strong>$offset</strong> for não-negativo, a substituição começará na posição <strong>$offset</strong>
                            da <strong>$string</strong>.
                            
                            Se <strong>$offset</strong> for negativo, a substituição começará a partir da posição
                            <strong>$offset</strong> contada a partir do final da <strong>$string</strong>.
  <info>array|int|null</info>  <strong>$length</strong>   Se fornecido e positivo, ele representa o comprimento da porção de
                            <strong>$string</strong> que deve ser substituída. Se negativo, ele representa o número
                            de caracteres do final de <strong>$string</strong> onde parar a substituição. Se ele não
                            for fornecido, o padrão será até strlen( <strong>$string</strong>); isto é, parar a
                            substituição no final de <strong>$string</strong>. Obviamente, se <strong>$length</strong> for zero então
                            esta função irá ter efeito de inserir <strong>$replace</strong> em <strong>$string</strong> na posição
                            fornecida em <strong>$offset</strong>.

<comment>Return:</comment>
  <info>string|array</info>  A string de resultado é retornada. Se <strong>$string</strong> for um array, então um array será
                retornado.

<comment>See Also:</comment>
   * <strong>str_replace()</strong>
   * <strong>substr()</strong>
   * Acesso e modificação de strings por caractere


id: svn_add
type: function
doc:
<comment>Description:</comment>
  Schedules the addition of an item in a working directory
  
  Adds the file, directory or symbolic link at <strong>$path</strong> to the working directory. The item will be
  added to the repository the next time you call <strong>svn_commit()</strong> on the working copy.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>       Path of item to add.
                      
                      Os caminhos relativos serão resolvidos como se o diretório de trabalho atual
                      fosse aquele que contém o binário do PHP. Para usar o diretório de trabalho do
                      script de chamada, use <strong>realpath()</strong> ou dirname(__FILE__).
  <info>bool</info>    <strong>$recursive</strong>  If item is directory, whether or not to recursively add all of its contents.
                      Default is <info>true</info>
  <info>bool</info>    <strong>$force</strong>      If true, Subversion will recurse into already versioned directories in order
                      to add unversioned files that may be hiding in those directories. Default is
                      <info>false</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>
   * SVN documentation on svn add


id: svn_auth_get_parameter
type: function
doc:
<comment>Description:</comment>
  Retrieves authentication parameter
  
  Retrieves authentication parameter at <strong>$key</strong>. For a list of valid keys and their meanings, consult
  the authentication constants list.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  String key name. Use the authentication constants defined by this extension to
                specify a key.

<comment>Return:</comment>
  <info>string</info>  Returns the string value of the parameter at <strong>$key</strong>; returns <info>null</info> if parameter does not
          exist.

<comment>See Also:</comment>
   * <strong>svn_auth_set_parameter()</strong>
   * Authentication constants


id: svn_auth_set_parameter
type: function
doc:
<comment>Description:</comment>
  Sets an authentication parameter
  
  Sets authentication parameter at <strong>$key</strong> to <strong>$value</strong>. For a list of valid keys and their meanings,
  consult the authentication constants list.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    String key name. Use the authentication constants defined by this extension to
                  specify a key.
  <info>string</info>  <strong>$value</strong>  String value to set to parameter at key. Format of value varies with the
                  parameter.

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

<comment>See Also:</comment>
   * <strong>svn_auth_get_parameter()</strong>
   * Authentication constants


id: svn_blame
type: function
doc:
<comment>Description:</comment>
  Get the SVN blame for a file
  
  Get the SVN blame of a file from a repository URL.

<comment>Param:</comment>
  <info>string</info>  <strong>$repository_url</strong>  The repository URL.
  <info>int</info>     <strong>$revision_no</strong>     The revision number.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of SVN blame information separated by line which includes the revision number,
         line number, line of code, author, and date.

<comment>See Also:</comment>
   * <strong>svn_diff()</strong>
   * <strong>svn_logs()</strong>
   * <strong>svn_status()</strong>


id: svn_cat
type: function
doc:
<comment>Description:</comment>
  Returns the contents of a file in a repository
  
  Returns the contents of the URL <strong>$repos_url</strong> to a file in the repository, optionally at revision
  number <strong>$revision_no</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$repos_url</strong>    String URL path to item in a repository.
  <info>int</info>     <strong>$revision_no</strong>  Integer revision number of item to retrieve, default is the HEAD revision.

<comment>Return:</comment>
  <info>string</info>  Returns the string contents of the item from the repository on success, and <info>false</info> on
          failure.

<comment>See Also:</comment>
   * <strong>svn_list()</strong>
   * SVN documentation on svn cat


id: svn_checkout
type: function
doc:
<comment>Description:</comment>
  Checks out a working copy from the repository
  
  Checks out a working copy from the repository at <strong>$repos</strong> to <strong>$targetpath</strong> at revision <strong>$revision</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$repos</strong>       String URL path to directory in repository to check out.
  <info>string</info>  <strong>$targetpath</strong>  String local path to directory to check out in to
                       
                       Os caminhos relativos serão resolvidos como se o diretório de trabalho atual
                       fosse aquele que contém o binário do PHP. Para usar o diretório de trabalho
                       do script de chamada, use <strong>realpath()</strong> ou dirname(__FILE__).
  <info>int</info>     <strong>$revision</strong>    Integer revision number of repository to check out. Default is HEAD, the most
                       recent revision.
  <info>int</info>     <strong>$flags</strong>       Any combination of <info>SVN_NON_RECURSIVE</info> and <info>SVN_IGNORE_EXTERNALS</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>
   * <strong>svn_add()</strong>
   * <strong>svn_commit()</strong>
   * <strong>svn_status()</strong>
   * <strong>svn_update()</strong>
   * SVN documentation on svn checkout


id: svn_cleanup
type: function
doc:
<comment>Description:</comment>
  Recursively cleanup a working copy directory, finishing incomplete operations and removing locks
  
  Recursively cleanup working copy directory <strong>$workingdir</strong>, finishing any incomplete operations and
  removing working copy locks. Use when a working copy is in limbo and needs to be usable again.

<comment>Param:</comment>
  <info>string</info>  <strong>$workingdir</strong>  String path to local working directory to cleanup
                       
                       Os caminhos relativos serão resolvidos como se o diretório de trabalho atual
                       fosse aquele que contém o binário do PHP. Para usar o diretório de trabalho
                       do script de chamada, use <strong>realpath()</strong> ou dirname(__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>
   * <strong>update()</strong>
   * SVN documentation on svn cleanup


id: svn_client_version
type: function
doc:
<comment>Description:</comment>
  Returns the version of the SVN client libraries
  
  Returns the version of the SVN client libraries

<comment>Return:</comment>
  <info>string</info>  String version number, usually in form of x.y.z.


id: svn_commit
type: function
doc:
<comment>Description:</comment>
  Sends changes from the local working copy to the repository
  
  Commits changes made in the local working copy files enumerated in the <strong>$targets</strong> array to the
  repository, with the log message <strong>$log</strong>. Directories in the <strong>$targets</strong> array will be recursively
  committed unless <strong>$recursive</strong> is set to <info>false</info>.
  
  This function does not have any parameters for specifying authentication, so a username and
  password must be set using <strong>svn_auth_set_parameter()</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$log</strong>        String log text to commit
  <info>array</info>   <strong>$targets</strong>    Array of local paths of files to be committed
                      
                      This parameter must be an array, a string for a single target is not
                      acceptable.
                      
                      Os caminhos relativos serão resolvidos como se o diretório de trabalho atual
                      fosse aquele que contém o binário do PHP. Para usar o diretório de trabalho do
                      script de chamada, use <strong>realpath()</strong> ou dirname(__FILE__).
  <info>bool</info>    <strong>$recursive</strong>  Boolean flag to disable recursive committing of directories in the <strong>$targets</strong>
                      array. Default is <info>true</info>.

<comment>Return:</comment>
  <info>array</info>  Returns array in form of:
         
         Returns <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>svn_auth_set_parameter()</strong>
   * SVN documentation on svn commit


id: svn_delete
type: function
doc:
<comment>Description:</comment>
  Delete items from a working copy or repository
  
  Deletes the file, directory or symbolic link at <strong>$path</strong> from the working directory. The item will be
  deleted from the repository the next time you call <strong>svn_commit()</strong> on the working copy.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>   Path of item to delete.
                  
                  Os caminhos relativos serão resolvidos como se o diretório de trabalho atual fosse
                  aquele que contém o binário do PHP. Para usar o diretório de trabalho do script de
                  chamada, use <strong>realpath()</strong> ou dirname(__FILE__).
  <info>bool</info>    <strong>$force</strong>  If <info>true</info>, the file will be deleted even if it has local modifications. Otherwise,
                  local modifications will result in a failure. Default is <info>false</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>
   * SVN documentation on svn
    delete


id: svn_diff
type: function
doc:
<comment>Description:</comment>
  Recursively diffs two paths
  
  Recursively diffs two paths, <strong>$path1</strong> and <strong>$path2</strong>.
  
  This is not a general-purpose diff utility. Only local files that are versioned may be diffed:
  other files will fail.

<comment>Param:</comment>
  <info>string</info>  <strong>$path1</strong>  First path to diff. This can be a URL to a file/directory in an SVN repository or
                  a local file/directory path.
                  
                  Os caminhos relativos serão resolvidos como se o diretório de trabalho atual fosse
                  aquele que contém o binário do PHP. Para usar o diretório de trabalho do script de
                  chamada, use <strong>realpath()</strong> ou dirname(__FILE__).
                  
                  If a local file path has only backslashes and no forward slashes, this extension
                  will fail to find the path. Always replace all backslashes with forward slashes
                  when using this function.
  <info>int</info>     <strong>$rev1</strong>   First path's revision number. Use <info>SVN_REVISION_HEAD</info> to specify the most recent
                  revision.
  <info>string</info>  <strong>$path2</strong>  Second path to diff. See <strong>$path1</strong> for description.
  <info>int</info>     <strong>$rev2</strong>   Second path's revision number. See <strong>$rev1</strong> for description.

<comment>Return:</comment>
  <info>array</info>  Returns an array-list consisting of two streams: the first is the diff output and the
         second contains error stream output. The streams can be read using <strong>fread()</strong>. Returns <info>false</info>
         or <info>null</info> on error.
         
         The diff output will, by default, be in the form of Subversion's custom unified diff
         format, but an external diff engine may be used depending on Subversion's configuration.

<comment>See Also:</comment>
   * SVN documentation on svn diff


id: svn_export
type: function
doc:
<comment>Description:</comment>
  Export the contents of a SVN directory
  
  Export the contents of either a working copy or repository into a 'clean' directory.

<comment>Param:</comment>
  <info>string</info>  <strong>$frompath</strong>      The path to the current repository.
  <info>string</info>  <strong>$topath</strong>        The path to the new repository.
  <info>bool</info>    <strong>$working_copy</strong>  If <info>true</info>, it will export uncommitted files from the working copy.

<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>svn_import()</strong>


id: svn_fs_abort_txn
type: function
doc:
<comment>Description:</comment>
  Aborts a transaction
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Aborts a transaction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$txn</strong>  

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


id: svn_fs_apply_text
type: function
doc:
<comment>Description:</comment>
  Creates and returns a stream that will be used to replace
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Creates and returns a stream that will be used to replace

<comment>Return:</comment>
  <info>resource</info>  


id: svn_fs_begin_txn2
type: function
doc:
<comment>Description:</comment>
  Create a new transaction
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Create a new transaction

<comment>Return:</comment>
  <info>resource</info>  


id: svn_fs_change_node_prop
type: function
doc:
<comment>Description:</comment>
  Return true if everything is ok, false otherwise
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Return true if everything is ok, false otherwise

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


id: svn_fs_check_path
type: function
doc:
<comment>Description:</comment>
  Determines what kind of item lives at path in a given repository fsroot
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Determines what kind of item lives at path in a given repository fsroot

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


id: svn_fs_contents_changed
type: function
doc:
<comment>Description:</comment>
  Return true if content is different, false otherwise
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Return true if content is different, false otherwise

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


id: svn_fs_copy
type: function
doc:
<comment>Description:</comment>
  Copies a file or a directory
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Copies a file or a directory.

<comment>Param:</comment>
  <info>resource</info>  <strong>$from_root</strong>  
  <info>string</info>    <strong>$from_path</strong>  
  <info>resource</info>  <strong>$to_root</strong>    
  <info>string</info>    <strong>$to_path</strong>    

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


id: svn_fs_delete
type: function
doc:
<comment>Description:</comment>
  Deletes a file or a directory
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Deletes a file or a directory.

<comment>Param:</comment>
  <info>resource</info>  <strong>$root</strong>  
  <info>string</info>    <strong>$path</strong>  

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


id: svn_fs_dir_entries
type: function
doc:
<comment>Description:</comment>
  Enumerates the directory entries under path; returns a hash of dir names to file type
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Enumerates the directory entries under path; returns a hash of dir names to file type

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


id: svn_fs_file_contents
type: function
doc:
<comment>Description:</comment>
  Returns a stream to access the contents of a file from a given version of the fs
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Returns a stream to access the contents of a file from a given version of the fs

<comment>Return:</comment>
  <info>resource</info>  


id: svn_fs_file_length
type: function
doc:
<comment>Description:</comment>
  Returns the length of a file from a given version of the fs
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Returns the length of a file from a given version of the fs

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


id: svn_fs_is_dir
type: function
doc:
<comment>Description:</comment>
  Determines if a path points to a directory
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Determines if the given path points to a directory.

<comment>Param:</comment>
  <info>resource</info>  <strong>$root</strong>  
  <info>string</info>    <strong>$path</strong>  

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the path points to a directory, <info>false</info> otherwise.


id: svn_fs_is_file
type: function
doc:
<comment>Description:</comment>
  Determines if a path points to a file
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Determines if the given path points to a file.

<comment>Param:</comment>
  <info>resource</info>  <strong>$root</strong>  
  <info>string</info>    <strong>$path</strong>  

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the path points to a file, <info>false</info> otherwise.


id: svn_fs_make_dir
type: function
doc:
<comment>Description:</comment>
  Creates a new empty directory
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Creates a new empty directory.

<comment>Param:</comment>
  <info>resource</info>  <strong>$root</strong>  
  <info>string</info>    <strong>$path</strong>  

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


id: svn_fs_make_file
type: function
doc:
<comment>Description:</comment>
  Creates a new empty file
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Creates a new empty file.

<comment>Param:</comment>
  <info>resource</info>  <strong>$root</strong>  
  <info>string</info>    <strong>$path</strong>  

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


id: svn_fs_node_created_rev
type: function
doc:
<comment>Description:</comment>
  Returns the revision in which path under fsroot was created
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Returns the revision in which path under fsroot was created

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


id: svn_fs_node_prop
type: function
doc:
<comment>Description:</comment>
  Returns the value of a property for a node
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Returns the value of a property for a node

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


id: svn_fs_props_changed
type: function
doc:
<comment>Description:</comment>
  Return true if props are different, false otherwise
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Return true if props are different, false otherwise

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


id: svn_fs_revision_prop
type: function
doc:
<comment>Description:</comment>
  Fetches the value of a named property
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Fetches the value of a named property

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


id: svn_fs_revision_root
type: function
doc:
<comment>Description:</comment>
  Get a handle on a specific version of the repository root
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Get a handle on a specific version of the repository root

<comment>Return:</comment>
  <info>resource</info>  


id: svn_fs_txn_root
type: function
doc:
<comment>Description:</comment>
  Creates and returns a transaction root
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Creates and returns a transaction root

<comment>Return:</comment>
  <info>resource</info>  


id: svn_fs_youngest_rev
type: function
doc:
<comment>Description:</comment>
  Returns the number of the youngest revision in the filesystem
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Returns the number of the youngest revision in the filesystem

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


id: svn_import
type: function
doc:
<comment>Description:</comment>
  Imports an unversioned path into a repository
  
  Commits unversioned <strong>$path</strong> into repository at <strong>$url</strong>. If <strong>$path</strong> is a directory and <strong>$nonrecursive</strong> is
  <info>false</info>,  the directory will be imported recursively.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>          Path of file or directory to import.
                         
                         Os caminhos relativos serão resolvidos como se o diretório de trabalho
                         atual fosse aquele que contém o binário do PHP. Para usar o diretório de
                         trabalho do script de chamada, use <strong>realpath()</strong> ou dirname(__FILE__).
  <info>string</info>  <strong>$url</strong>           Repository URL to import into.
  <info>bool</info>    <strong>$nonrecursive</strong>  Whether or not to refrain from recursively processing directories.

<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>svn_add()</strong>
   * SVN documentation for svn import


id: svn_log
type: function
doc:
<comment>Description:</comment>
  Returns the commit log messages of a repository URL
  
  <strong>svn_log()</strong> returns the complete history of the item at the repository URL <strong>$repos_url</strong>, or the
  history of a specific revision if <strong>$start_revision</strong> is set. This function is equivalent to svn log
  --verbose -r $start_revision $repos_url.

<comment>Param:</comment>
  <info>string</info>  <strong>$repos_url</strong>       Repository URL of the item to retrieve log history from.
  <info>int</info>     <strong>$start_revision</strong>  Revision number of the first log to retrieve. Use <info>SVN_REVISION_HEAD</info> to
                           retrieve the log from the most recent revision.
  <info>int</info>     <strong>$end_revision</strong>    Revision number of the last log to retrieve. Defaults to <strong>$start_revision</strong>
                           if specified or to <info>SVN_REVISION_INITIAL</info> otherwise.
  <info>int</info>     <strong>$limit</strong>           Number of logs to retrieve.
  <info>int</info>     <strong>$flags</strong>           Any combination of <info>SVN_OMIT_MESSAGES</info>, <info>SVN_DISCOVER_CHANGED_PATHS</info> and
                           <info>SVN_STOP_ON_COPY</info>.

<comment>Return:</comment>
  <info>array</info>  On success, this function returns an array file listing in the format of:  Array, ordered
         most recent (highest) revision first
         ( [rev] => integer revision number [author] => string author name [msg] => string log
         message [date] => string date formatted per ISO 8601, i.e. date('c') [paths] => Array,
         describing changed files ( [0] => Array ( [action] => string letter signifying change
         [path] =>  absolute repository path of changed file ) [1] => ... )
         )
         [1] => ...
         ]]>
         
         The output will always be a numerically indexed array of arrays, even when there are none
         or only one log message(s).
         
         The value of action is a subset of the status output in the first column, where possible
         values are:
         
         If no changes were made to the item, an empty array is returned.

<comment>See Also:</comment>
   * 
      SVN documentation on svn log
     


id: svn_ls
type: function
doc:
<comment>Description:</comment>
  Returns list of directory contents in repository URL, optionally at revision number
  
  This function queries the repository URL and returns a list of files and directories, optionally
  from a specific revision. This is equivalent to svn list $repos_url[@$revision_no]
  
  This function does not work with working copies. <strong>$repos_url</strong> must be a repository URL.

<comment>Param:</comment>
  <info></info>      <strong>$url</strong>       URL of the repository, eg. http://www.example.com/svnroot. To access a local
                   Subversion repository via filesystem, use the file URI scheme, eg.
                   file:///home/user/svn-repos
  <info></info>      <strong>$revision</strong>  Integer revision number to retrieve listing of. When omitted, the HEAD revision
                   is used.
  <info>bool</info>  <strong>$recurse</strong>   Enables recursion.

<comment>Return:</comment>
  <info>array</info>  On success, this function returns an array file listing in the format of:  Array (
         [created_rev] => integer revision number of last edit [last_author] => string author name
         of last edit [size] => integer byte file size of file [time] => string date of last edit in
         form 'M d H:i' or 'M d Y', depending on how old the file is [time_t] => integer unix
         timestamp of last edit [name] => name of file/directory [type] => type, can be 'file' or
         'dir' )
         [1] => ...
         ]]>

<comment>See Also:</comment>
   * SVN documentation on svn list


id: svn_mkdir
type: function
doc:
<comment>Description:</comment>
  Creates a directory in a working copy or repository
  
  Creates a directory in a working copy or repository.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  The path to the working copy or repository.

<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>svn_add()</strong>
   * <strong>svn_copy()</strong>


id: svn_repos_create
type: function
doc:
<comment>Description:</comment>
  Create a new subversion repository at path
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Create a new subversion repository at path

<comment>Return:</comment>
  <info>resource</info>  


id: svn_repos_fs
type: function
doc:
<comment>Description:</comment>
  Gets a handle on the filesystem for a repository
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Gets a handle on the filesystem for a repository

<comment>Return:</comment>
  <info>resource</info>  


id: svn_repos_fs_commit_txn
type: function
doc:
<comment>Description:</comment>
  Commits a transaction and returns the new revision
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Commits a transaction and returns the new revision

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


id: svn_repos_hotcopy
type: function
doc:
<comment>Description:</comment>
  Make a hot-copy of the repos at repospath; copy it to destpath
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Make a hot-copy of the repos at repospath; copy it to destpath

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


id: svn_repos_open
type: function
doc:
<comment>Description:</comment>
  Open a shared lock on a repository
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Open a shared lock on a repository.

<comment>Return:</comment>
  <info>resource</info>  


id: svn_repos_recover
type: function
doc:
<comment>Description:</comment>
  Run recovery procedures on the repository located at path
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Run recovery procedures on the repository located at path.

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


id: svn_revert
type: function
doc:
<comment>Description:</comment>
  Revert changes to the working copy
  
  Revert any local changes to the path in a working copy.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>       The path to the working repository.
  <info>bool</info>    <strong>$recursive</strong>  Optionally make recursive changes.

<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>svn_delete()</strong>
   * <strong>svn_export()</strong>


id: svn_status
type: function
doc:
<comment>Description:</comment>
  Returns the status of working copy files and directories
  
  Returns the status of working copy files and directories, giving modifications, additions,
  deletions and other changes to items in the working copy.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>   Local path to file or directory to retrieve status of.
                  
                  Os caminhos relativos serão resolvidos como se o diretório de trabalho atual fosse
                  aquele que contém o binário do PHP. Para usar o diretório de trabalho do script de
                  chamada, use <strong>realpath()</strong> ou dirname(__FILE__).
  <info>int</info>     <strong>$flags</strong>  Any combination of <info>Svn::NON_RECURSIVE</info>, <info>Svn::ALL</info> (regardless of modification
                  status), <info>Svn::SHOW_UPDATES</info> (entries will be added for items that are out-of-date),
                  <info>Svn::NO_IGNORE</info> (disregard <return>svn:ignore</return> properties when scanning for new files) and
                  <info>Svn::IGNORE_EXTERNALS</info>.

<comment>Return:</comment>
  <info>array</info>  Returns a numerically indexed array of associative arrays detailing the status of items in
         the repository:
         
         The information on the item is an associative array that can contain the following keys:
         
         String path to file/directory of this entry on local filesystem.
         
         Status of item's text. Consulte as constantes de status para obter os valores possíveis.
         
         Status of item's text in repository. Only accurate if <strong>$update</strong> was set to <info>true</info>. Consulte as
         constantes de status para obter os valores possíveis.
         
         Status of item's properties. Consulte as constantes de status para obter os valores
         possíveis.
         
         Status of item's property in repository. Only accurate if <strong>$update</strong> was set to <info>true</info>. Consulte
         as constantes de status para obter os valores possíveis.
         
         Whether or not the item is locked. (Only set if <info>true</info>.)
         
         Whether or not the item was copied (scheduled for addition with history). (Only set if
         <info>true</info>.)
         
         Whether or not the item was switched using the switch command. (Only set if <info>true</info>)
         
         These keys are only set if the item is versioned:
         
         Base name of item in repository.
         
         URL of item in repository.
         
         Base URL of repository.
         
         Integer revision of item in working copy.
         
         Type of item, i.e. file or directory. Consulte as constantes de tipo para obter os valores
         possíveis.
         
         Scheduled action for item, i.e. addition or deletion. Constants for these magic numbers are
         not available, they can be emulated by using:
         
         Whether or not the item was deleted, but parent revision lags behind. (Only set if <info>true</info>.)
         
         Whether or not the item is absent, that is, Subversion knows that there should be something
         there but there isn't. (Only set if <info>true</info>.)
         
         Whether or not the entries file for a directory is incomplete. (Only set if <info>true</info>.)
         
         Integer Unix timestamp of last commit date. (Unaffected by <strong>$update</strong>.)
         
         Integer revision of last commit. (Unaffected by <strong>$update</strong>.)
         
         String author of last commit. (Unaffected by <strong>$update</strong>.)
         
         Integer Unix timestamp of last up-to-date time for properties
         
         Integer Unix timestamp of last up-to-date time for text

<comment>See Also:</comment>
   * <strong>svn_update()</strong>
   * <strong>svn_log()</strong>
   * SVN documentation for svn status


id: svn_update
type: function
doc:
<comment>Description:</comment>
  Update working copy
  
  Update working copy at <strong>$path</strong> to revision <strong>$revno</strong>. If <strong>$recurse</strong> is true, directories will be
  recursively updated.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>     Path to local working copy.
                    
                    Os caminhos relativos serão resolvidos como se o diretório de trabalho atual
                    fosse aquele que contém o binário do PHP. Para usar o diretório de trabalho do
                    script de chamada, use <strong>realpath()</strong> ou dirname(__FILE__).
  <info>int</info>     <strong>$revno</strong>    Revision number to update to, default is <info>SVN_REVISION_HEAD</info>.
  <info>bool</info>    <strong>$recurse</strong>  Whether or not to recursively update directories.

<comment>Return:</comment>
  <info>int</info>  Returns new revision number on success, returns <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>svn_checkout()</strong>
   * <strong>svn_commit()</strong>
   * SVN documentation for svn update


id: swoole_async_dns_lookup
type: function
doc:
<comment>Description:</comment>
  Async and non-blocking hostname to IP lookup

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


id: swoole_async_read
type: function
doc:
<comment>Description:</comment>
  Read file stream 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 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 read from the file.
  <info>string</info>    <strong>$filename</strong>  The name of the file.
  <info>string</info>    <strong>$content</strong>   The content read from the file.

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


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


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


id: swoole_async_writefile
type: function
doc:
<comment>Description:</comment>
  Write data to a file 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>callable</info>  <strong>$callback</strong>  
  <info>int</info>       <strong>$flags</strong>     

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


id: swoole_clear_error
type: function
doc:
<comment>Description:</comment>
  Clear errors in the socket or on the last error code
  
  Clear errors in the socket or on the last error code.

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


id: swoole_client_select
type: function
doc:
<comment>Description:</comment>
  Get the file description which are ready to read/write or error

<comment>Param:</comment>
  <info>array</info>  <strong>$read_array</strong>   
  <info>array</info>  <strong>$write_array</strong>  
  <info>array</info>  <strong>$error_array</strong>  
  <info>float</info>  <strong>$timeout</strong>      

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


id: swoole_cpu_num
type: function
doc:
<comment>Description:</comment>
  Get the number of CPU

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


id: swoole_errno
type: function
doc:
<comment>Description:</comment>
  Get the error code of the latest system call

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


id: swoole_error_log
type: function
doc:
<comment>Description:</comment>
  Output error messages to the log
  
  Output error messages to the log.

<comment>Param:</comment>
  <info>int</info>     <strong>$level</strong>  Log Level, constants can be used: <info>SWOOLE_LOG_DEBUG</info>, <info>SWOOLE_LOG_TRACE</info>,
                  <info>SWOOLE_LOG_INFO</info>, <info>SWOOLE_LOG_NOTICE</info>, <info>SWOOLE_LOG_WARNING</info>, <info>SWOOLE_LOG_ERROR</info>,
                  <info>SWOOLE_LOG_NONE</info>
  <info>string</info>  <strong>$msg</strong>    Message content to be written to the log.

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


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>int</info>       <strong>$events</strong>          

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


id: swoole_event_defer
type: function
doc:
<comment>Description:</comment>
  Add callback function to the next event loop

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  

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


id: swoole_event_del
type: function
doc:
<comment>Description:</comment>
  Remove all event callback functions of a socket

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

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


id: swoole_event_exit
type: function
doc:
<comment>Description:</comment>
  Exit the eventloop, only available at the 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>callable</info>  <strong>$read_callback</strong>   
  <info>callable</info>  <strong>$write_callback</strong>  
  <info>int</info>       <strong>$events</strong>          

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


id: swoole_event_wait
type: function
doc:
<comment>Description:</comment>
  Start the event loop

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


id: swoole_event_write
type: function
doc:
<comment>Description:</comment>
  Write data to a socket

<comment>Param:</comment>
  <info>int</info>     <strong>$fd</strong>    
  <info>string</info>  <strong>$data</strong>  

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


id: swoole_get_local_ip
type: function
doc:
<comment>Description:</comment>
  Get the IPv4 IP addresses of each NIC on the machine

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


id: swoole_last_error
type: function
doc:
<comment>Description:</comment>
  Get the lastest error message

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


id: swoole_load_module
type: function
doc:
<comment>Description:</comment>
  Load a swoole extension

<comment>Return:</comment>
  <info>mixed</info>  


id: swoole_select
type: function
doc:
<comment>Description:</comment>
  Select the file descriptions which are ready to read/write or error in the eventloop

<comment>Param:</comment>
  <info>array</info>  <strong>$read_array</strong>   
  <info>array</info>  <strong>$write_array</strong>  
  <info>array</info>  <strong>$error_array</strong>  
  <info>float</info>  <strong>$timeout</strong>      

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


id: swoole_set_process_name
type: function
doc:
<comment>Description:</comment>
  Set the process name

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

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


id: swoole_strerror
type: function
doc:
<comment>Description:</comment>
  Convert the Errno into error messages

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

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


id: swoole_timer_after
type: function
doc:
<comment>Description:</comment>
  Trigger a one time callback function in the future

<comment>Param:</comment>
  <info>int</info>       <strong>$ms</strong>        
  <info>callable</info>  <strong>$callback</strong>  
  <info>mixed</info>     <strong>$param</strong>     

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


id: swoole_timer_exists
type: function
doc:
<comment>Description:</comment>
  Check if a timer callback function 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>
  Trigger a timer tick callback function by time interval

<comment>Param:</comment>
  <info>int</info>       <strong>$ms</strong>        
  <info>callable</info>  <strong>$callback</strong>  

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


id: swoole_version
type: function
doc:
<comment>Description:</comment>
  Get the version of Swoole

<comment>Return:</comment>
  <info>string</info>  The version of Swoole.


id: symlink
type: function
doc:
<comment>Description:</comment>
  Cria uma ligação simbólica
  
  <strong>symlink()</strong> cria uma ligação simbólica ao alvo existente em <strong>$target</strong> com o nome especificado em
  <strong>$link</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$target</strong>  Alvo da ligação.
  <info>string</info>  <strong>$link</strong>    O nome da ligação.

<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>link()</strong>
   * <strong>readlink()</strong>
   * <strong>linkinfo()</strong>
   * <strong>unlink()</strong>


id: sys_get_temp_dir
type: function
doc:
<comment>Description:</comment>
  Returns directory path used for temporary files
  
  Returns the path of the directory PHP stores temporary files in by default.

<comment>Return:</comment>
  <info>string</info>  Returns the path of the temporary directory.

<comment>See Also:</comment>
   * <strong>tmpfile()</strong>
   * <strong>tempnam()</strong>


id: sys_getloadavg
type: function
doc:
<comment>Description:</comment>
  Obtém a média de carga do sistema
  
  Retorna três amostras representando a carga média do sistema (o número de processos na fila de
  execução do sistema) nos últimos 1, 5 e 15 minutos, respectivamente. Retorna <info>false</info> em caso de
  falha.

<comment>Return:</comment>
  <info>array|false</info>  Retorna um <info>array</info> com três amostras (últimos 1, 5 e 15 minutos).


id: syslog
type: function
doc:
<comment>Description:</comment>
  Generate a system log message
  
  <strong>syslog()</strong> generates a log message that will be distributed by the system logger.
  
  For information on setting up a user defined log handler, see the syslog.conf5 Unix manual page.
  More information on the syslog facilities and option can be found in the man pages for syslog3 on
  Unix machines.

<comment>Param:</comment>
  <info>int</info>     <strong>$priority</strong>  <strong>$priority</strong> is a combination of the facility and the level. Possible values are:
                     <strong>syslog()</strong> Priorities (in descending order)ConstantDescription<info>LOG_EMERG</info>system is
                     unusable<info>LOG_ALERT</info>action must be taken immediately<info>LOG_CRIT</info>critical
                     conditions<info>LOG_ERR</info>error conditions<info>LOG_WARNING</info>warning conditions<info>LOG_NOTICE</info>normal,
                     but significant, condition<info>LOG_INFO</info>informational message<info>LOG_DEBUG</info>debug-level
                     message
  <info>string</info>  <strong>$message</strong>   The message to send.

<comment>Return:</comment>
  <info>true</info>  Sempre retorna <info>true</info>.

<comment>See Also:</comment>
   * <strong>openlog()</strong>
   * <strong>closelog()</strong>
   * syslog.filter INI setting (starting with PHP 7.3)


id: system
type: function
doc:
<comment>Description:</comment>
  Executa um programa externo e mostra a saída
  
  <strong>system()</strong> é igual à versão C desta função, executa o comando informado em <strong>$command</strong> e mostra o
  resultado.
  
  A chamada a <strong>system()</strong> também tenta automaticamente descarregar o buffer de saída do servidor web
  após cada linha de saída se o PHP estiver sendo executado como módulo do servidor.
  
  Se for necessário executar um comando e obter todos os dados do comando passados diretamente sem
  nenhuma interferência, use a função <strong>passthru()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>      O comando que será executado.
  <info>int</info>     <strong>$result_code</strong>  Se o argumento <strong>$result_code</strong> estiver presente, o estado de retorno do comando
                        executado será escrito nesta variável.

<comment>Return:</comment>
  <info>string|false</info>  Retorna a última linha da saída do comando em caso de sucesso, e <info>false</info> em caso de
                falha.

<comment>See Also:</comment>
   * <strong>exec()</strong>
   * <strong>passthru()</strong>
   * <strong>popen()</strong>
   * <strong>escapeshellcmd()</strong>
   * <strong>pcntl_exec()</strong>
   * operador crase


id: taint
type: function
doc:
<comment>Description:</comment>
  Taint a string
  
  Make a string tainted. This is used for testing purpose only.

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

<comment>Return:</comment>
  <info>bool</info>  Return TRUE if the transformation is done. Always return TRUE if the taint extension is not
        enabled.


id: tan
type: function
doc:
<comment>Description:</comment>
  Tangente
  
  <strong>tan()</strong> retorna a tangente do parâmetro <strong>$num</strong>. O argumento <strong>$num</strong> deve estar em radianos.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  O argumento para processar em radianos

<comment>Return:</comment>
  <info>float</info>  A tangente de <strong>$num</strong>

<comment>See Also:</comment>
   * <strong>atan()</strong>
   * <strong>atan2()</strong>
   * <strong>sin()</strong>
   * <strong>cos()</strong>
   * <strong>tanh()</strong>
   * <strong>deg2rad()</strong>


id: tanh
type: function
doc:
<comment>Description:</comment>
  Tangente hiperbólica
  
  Retorna a tangente hiperbólica de <strong>$num</strong>, definida como <return>sinh($num)/cosh($num)</return>.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  O argumento para processar

<comment>Return:</comment>
  <info>float</info>  A tangente hiperbólica de <strong>$num</strong>

<comment>See Also:</comment>
   * <strong>tan()</strong>
   * <strong>atanh()</strong>
   * <strong>sinh()</strong>
   * <strong>cosh()</strong>


id: tcpwrap_check
type: function
doc:
<comment>Description:</comment>
  Performs a tcpwrap check
  
  This function consults the /etc/hosts.allow and  /etc/hosts.deny files to check if access to
  service  <strong>$daemon</strong> should be granted or denied for a client.

<comment>Param:</comment>
  <info>string</info>  <strong>$daemon</strong>   The service name.
  <info>string</info>  <strong>$address</strong>  The client remote address. Can be either an IP address or a domain name.
  <info>string</info>  <strong>$user</strong>     An optional user name.
  <info>bool</info>    <strong>$nodns</strong>    If <strong>$address</strong> looks like domain name then DNS is  used to resolve it to IP
                    address; set <strong>$nodns</strong> to  <info>true</info> to avoid this.

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if access should be granted, <info>false</info> otherwise.


id: tempnam
type: function
doc:
<comment>Description:</comment>
  Cria arquivo com nome único
  
  Cria um arquivo com nome único, com permissões de acesso definidas para 0600, no diretório
  especificado. Se o diretório não existir ou não puder ser escrito, <strong>tempnam()</strong> pode gerar um arquivo
  no diretório temporário do sistema e retornar o caminho completo ao arquivo, incluindo seu nome.

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  O diretório onde o arquivo temporário será criado.
  <info>string</info>  <strong>$prefix</strong>     O prefixo do nome do arquivo temporário gerado.
                      
                      Apenas os primeiros 63 caracteres do prefixo são usados, o restante é
                      ignorado. Windows usa apenas os primeiros três caracteres do prefixo.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o novo nome do arquivo temporário (com caminho), ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>tmpfile()</strong>
   * <strong>sys_get_temp_dir()</strong>
   * <strong>unlink()</strong>


id: textdomain
type: function
doc:
<comment>Description:</comment>
  Sets the default domain
  
  This function sets the domain to search within when calls are made to <strong>gettext()</strong>, usually the named
  after an application.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$domain</strong>  The new message domain, or <info>null</info> to get the current setting without changing
                        it

<comment>Return:</comment>
  <info>string</info>  If successful, this function returns the current message domain, after possibly changing
          it.


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

<comment>Param:</comment>
  <info>string|null</info>        <strong>$filename</strong>        If the <strong>$filename</strong> parameter is given, this function will also
                                      read that file and initialize the object with the file, acting
                                      like <strong>tidy_parse_file()</strong>.
  <info>array|string|null</info>  <strong>$config</strong>          The config <strong>$config</strong> can be passed either as an array or as a
                                      string. If a string is passed, it is interpreted as the name
                                      of the configuration file, otherwise, it is interpreted as the
                                      options themselves.
                                      
                                      For an explanation about each option, visit
                                      http://api.html-tidy.org/#quick-reference.
  <info>string|null</info>        <strong>$encoding</strong>        The <strong>$encoding</strong> parameter sets the encoding for input/output
                                      documents. The possible values for encoding  are:  <return>ascii</return>,
                                      <return>latin0</return>, <return>latin1</return>, <return>raw</return>, <return>utf8</return>, <return>iso2022</return>, <return>mac</return>, <return>win1252</return>, <return>ibm858</return>,
                                      <return>utf16</return>, <return>utf16le</return>, <return>utf16be</return>, <return>big5</return>, and <return>shiftjis</return>.
  <info>bool</info>               <strong>$useIncludePath</strong>  Search for the file in the include_path.

<comment>See Also:</comment>
   * <strong>tidy::parseFile()</strong>
   * <strong>tidy::parseString()</strong>


id: tidy::body
type: function
doc:
<comment>Description:</comment>
  Returns a tidyNode object starting from the  tag of the tidy parse tree
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Returns a <class>tidyNode</class> object starting from the  \<body&gt; tag of the tidy parse tree.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

<comment>Return:</comment>
  <info>tidyNode|null</info>  Returns a <class>tidyNode</class> object starting from the  \<body&gt; tag of the tidy parse tree.

<comment>See Also:</comment>
   * <strong>tidy::head()</strong>
   * <strong>tidy::html()</strong>


id: tidy::cleanRepair
type: function
doc:
<comment>Description:</comment>
  Execute configured cleanup and repair operations on parsed markup
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  This function cleans and repairs the given tidy <strong>$tidy</strong>.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

<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>tidy::repairFile()</strong>
   * <strong>tidy::repairString()</strong>


id: tidy::diagnose
type: function
doc:
<comment>Description:</comment>
  Run configured diagnostics on parsed and repaired markup
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Runs diagnostic tests on the given tidy <strong>$tidy</strong>, adding some more information about the document in
  the error buffer.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

<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>tidy::errorBuffer()</strong>


id: tidy::getConfig
type: function
doc:
<comment>Description:</comment>
  Get current Tidy configuration
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Gets the list of the configuration options in use by the given tidy <strong>$tidy</strong>.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

<comment>Return:</comment>
  <info>array</info>  Returns an array of configuration options.
         
         For an explanation about each option, visit http://api.html-tidy.org/#quick-reference.

<comment>See Also:</comment>
   * <strong>tidy_reset_config()</strong>
   * <strong>tidy_save_config()</strong>


id: tidy::getHtmlVer
type: function
doc:
<comment>Description:</comment>
  Get the Detected HTML version for the specified document
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Returns the detected HTML version for the specified tidy <strong>$tidy</strong>.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

<comment>Return:</comment>
  <info>int</info>  Returns the detected HTML version.
       
       This function is not yet implemented in the Tidylib itself, so it always return <return>0</return>.


id: tidy::getOpt
type: function
doc:
<comment>Description:</comment>
  Returns the value of the specified configuration option for the tidy document
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Returns the value of the specified <strong>$option</strong> for the specified tidy <strong>$tidy</strong>.

<comment>Param:</comment>
  <info>tidy</info>    <strong>$tidy</strong>    Um objeto <class>Tidy</class>.
  <info>string</info>  <strong>$option</strong>  You will find a list with each configuration option and their types at:
                   http://api.html-tidy.org/#quick-reference.

<comment>Return:</comment>
  <info>string|int|bool</info>  Returns the value of the specified <strong>$option</strong>. The return type depends on the type
                   of the specified one.


id: tidy::getOptDoc
type: function
doc:
<comment>Description:</comment>
  Returns the documentation for the given option name
    
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  <strong>tidy_get_opt_doc()</strong> returns the documentation for the given option name.
  
  You need at least libtidy from 25 April, 2005 for this function be available.

<comment>Param:</comment>
  <info>tidy</info>    <strong>$tidy</strong>    Um objeto <class>Tidy</class>.
  <info>string</info>  <strong>$option</strong>  The option name

<comment>Return:</comment>
  <info>string|false</info>  Returns a string if the option exists and has documentation available, or <info>false</info>
                otherwise.

<comment>See Also:</comment>
   * <strong>tidy::getconfig()</strong>
   * <strong>tidy::getopt()</strong>


id: tidy::getRelease
type: function
doc:
<comment>Description:</comment>
  Get release date (version) for Tidy library
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Gets the release date of the Tidy library.

<comment>Return:</comment>
  <info>string</info>  Returns a string with the release date of the Tidy library, which may be 'unknown'.


id: tidy::getStatus
type: function
doc:
<comment>Description:</comment>
  Get status of specified document
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Returns the status for the specified tidy <strong>$tidy</strong>.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

<comment>Return:</comment>
  <info>int</info>  Returns 0 if no error/warning was raised, 1 for warnings or accessibility errors, or 2 for
       errors.


id: tidy::head
type: function
doc:
<comment>Description:</comment>
  Returns a tidyNode object starting from the  tag of the tidy parse tree
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Returns a <class>tidyNode</class> object starting from the \<head&gt; tag of the tidy parse tree.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

<comment>Return:</comment>
  <info>tidyNode|null</info>  Returns the <class>tidyNode</class> object.

<comment>See Also:</comment>
   * <strong>tidy::body()</strong>
   * <strong>tidy::html()</strong>


id: tidy::html
type: function
doc:
<comment>Description:</comment>
  Returns a tidyNode object starting from the  tag of the tidy parse tree
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Returns a <class>tidyNode</class> object starting from the \<html&gt; tag of the tidy parse tree.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

<comment>Return:</comment>
  <info>tidyNode|null</info>  Returns the <class>tidyNode</class> object.

<comment>See Also:</comment>
   * <strong>tidy::body()</strong>
   * <strong>tidy::head()</strong>


id: tidy::isXhtml
type: function
doc:
<comment>Description:</comment>
  Indicates if the document is a XHTML document
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Tells if the document is a XHTML document.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if the specified tidy <strong>$tidy</strong> is a XHTML document, or <info>false</info>
        otherwise.
        
        This function is not yet implemented in the Tidylib itself, so it always return <info>false</info>.


id: tidy::isXml
type: function
doc:
<comment>Description:</comment>
  Indicates if the document is a generic (non HTML/XHTML) XML document
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Tells if the document is a generic (non HTML/XHTML) XML document.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if the specified tidy <strong>$tidy</strong> is a generic XML document (non
        HTML/XHTML), or <info>false</info> otherwise.
        
        This function is not yet implemented in the Tidylib itself, so it always return <info>false</info>.


id: tidy::parseFile
type: function
doc:
<comment>Description:</comment>
  Parse markup in file or URI
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Parses the given file.

<comment>Param:</comment>
  <info>string</info>             <strong>$filename</strong>        If the <strong>$filename</strong> parameter is given, this function will also
                                      read that file and initialize the object with the file, acting
                                      like <strong>tidy_parse_file()</strong>.
  <info>array|string|null</info>  <strong>$config</strong>          The config <strong>$config</strong> can be passed either as an array or as a
                                      string. If a string is passed, it is interpreted as the name
                                      of the configuration file, otherwise, it is interpreted as the
                                      options themselves.
                                      
                                      For an explanation about each option, see
                                      http://api.html-tidy.org/#quick-reference.
  <info>string|null</info>        <strong>$encoding</strong>        The <strong>$encoding</strong> parameter sets the encoding for input/output
                                      documents. The possible values for encoding  are:  <return>ascii</return>,
                                      <return>latin0</return>, <return>latin1</return>, <return>raw</return>, <return>utf8</return>, <return>iso2022</return>, <return>mac</return>, <return>win1252</return>, <return>ibm858</return>,
                                      <return>utf16</return>, <return>utf16le</return>, <return>utf16be</return>, <return>big5</return>, and <return>shiftjis</return>.
  <info>bool</info>               <strong>$useIncludePath</strong>  Search for the file in the include_path.

<comment>Return:</comment>
  <info>bool</info>  tidy::parseFile returns <info>true</info> on success. <strong>tidy_parse_file()</strong> returns a new <class>tidy</class> instance on
        success. Both, the method and the function return <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>tidy::parsestring()</strong>
   * <strong>tidy::repairfile()</strong>
   * <strong>tidy::repairstring()</strong>


id: tidy::parseString
type: function
doc:
<comment>Description:</comment>
  Parse a document stored in a string
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Parses a document stored in a string.

<comment>Param:</comment>
  <info>string</info>             <strong>$string</strong>    The data to be parsed.
  <info>array|string|null</info>  <strong>$config</strong>    The config <strong>$config</strong> can be passed either as an array or as a string.
                                If a string is passed, it is interpreted as the name of the
                                configuration file, otherwise, it is interpreted as the options
                                themselves.
                                
                                For an explanation about each option, visit
                                http://api.html-tidy.org/#quick-reference.
  <info>string|null</info>        <strong>$encoding</strong>  The <strong>$encoding</strong> parameter sets the encoding for input/output
                                documents. The possible values for encoding  are:  <return>ascii</return>, <return>latin0</return>,
                                <return>latin1</return>, <return>raw</return>, <return>utf8</return>, <return>iso2022</return>, <return>mac</return>, <return>win1252</return>, <return>ibm858</return>, <return>utf16</return>, <return>utf16le</return>,
                                <return>utf16be</return>, <return>big5</return>, and <return>shiftjis</return>.

<comment>Return:</comment>
  <info>bool</info>  tidy::parseString returns <info>true</info> on success. <strong>tidy_parse_string()</strong> returns a new <class>tidy</class> instance
        on success. Both, the method and the function return <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>tidy::parseFile()</strong>
   * <strong>tidy::repairFile()</strong>
   * <strong>tidy::repairString()</strong>


id: tidy::repairFile
type: function
doc:
<comment>Description:</comment>
  Repair a file and return it as a string
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Repairs the given file and returns it as a string.

<comment>Param:</comment>
  <info>string</info>             <strong>$filename</strong>        The file to be repaired.
  <info>array|string|null</info>  <strong>$config</strong>          The config <strong>$config</strong> can be passed either as an array or as a
                                      string. If a string is passed, it is interpreted as the name
                                      of the configuration file, otherwise, it is interpreted as the
                                      options themselves.
                                      
                                      Check http://tidy.sourceforge.net/docs/quickref.html for an
                                      explanation about each option.
  <info>string|null</info>        <strong>$encoding</strong>        The <strong>$encoding</strong> parameter sets the encoding for input/output
                                      documents. The possible values for encoding  are:  <return>ascii</return>,
                                      <return>latin0</return>, <return>latin1</return>, <return>raw</return>, <return>utf8</return>, <return>iso2022</return>, <return>mac</return>, <return>win1252</return>, <return>ibm858</return>,
                                      <return>utf16</return>, <return>utf16le</return>, <return>utf16be</return>, <return>big5</return>, and <return>shiftjis</return>.
  <info>bool</info>               <strong>$useIncludePath</strong>  Search for the file in the include_path.

<comment>Return:</comment>
  <info>string|false</info>  Returns the repaired contents as a string,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>tidy::parseFile()</strong>
   * <strong>tidy::parseString()</strong>
   * <strong>tidy::repairString()</strong>


id: tidy::repairString
type: function
doc:
<comment>Description:</comment>
  Repair a string using an optionally provided configuration file
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Repairs the given string.

<comment>Param:</comment>
  <info>string</info>             <strong>$string</strong>    The data to be repaired.
  <info>array|string|null</info>  <strong>$config</strong>    The config <strong>$config</strong> can be passed either as an array or as a string.
                                If a string is passed, it is interpreted as the name of the
                                configuration file, otherwise, it is interpreted as the options
                                themselves.
                                
                                Check http://api.html-tidy.org/#quick-reference for an explanation
                                about each option.
  <info>string|null</info>        <strong>$encoding</strong>  The <strong>$encoding</strong> parameter sets the encoding for input/output
                                documents. The possible values for encoding  are:  <return>ascii</return>, <return>latin0</return>,
                                <return>latin1</return>, <return>raw</return>, <return>utf8</return>, <return>iso2022</return>, <return>mac</return>, <return>win1252</return>, <return>ibm858</return>, <return>utf16</return>, <return>utf16le</return>,
                                <return>utf16be</return>, <return>big5</return>, and <return>shiftjis</return>.

<comment>Return:</comment>
  <info>string|false</info>  Returns the repaired string,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>tidy::parseFile()</strong>
   * <strong>tidy::parseString()</strong>
   * <strong>tidy::repairFile()</strong>


id: tidy::root
type: function
doc:
<comment>Description:</comment>
  Returns a tidyNode object representing the root of the tidy parse tree
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Returns a <class>tidyNode</class> object representing the root of the tidy parse tree.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

<comment>Return:</comment>
  <info>tidyNode|null</info>  Returns the <class>tidyNode</class> object.


id: tidyNode::getParent
type: function
doc:
<comment>Description:</comment>
  Returns the parent node of the current node
  
  Returns the parent node of the current node.

<comment>Return:</comment>
  <info>tidyNode|null</info>  Returns a <info>tidyNode</info> if the node has a parent, or <info>null</info> otherwise.


id: tidyNode::hasChildren
type: function
doc:
<comment>Description:</comment>
  Checks if a node has children
  
  Tells if the node has children.

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


id: tidyNode::hasSiblings
type: function
doc:
<comment>Description:</comment>
  Checks if a node has siblings
  
  Tells if the node has siblings.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the node has siblings, <info>false</info> otherwise.


id: tidyNode::isAsp
type: function
doc:
<comment>Description:</comment>
  Checks if this node is ASP
  
  Tells whether the current node is ASP.

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


id: tidyNode::isComment
type: function
doc:
<comment>Description:</comment>
  Checks if a node represents a comment
  
  Tells if the node is a comment.

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


id: tidyNode::isHtml
type: function
doc:
<comment>Description:</comment>
  Checks if a node is an element node
  
  Tells if the node is an element node, but not the root node of the document.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the node is an element node, but not the root node of the document, <info>false</info>
        otherwise.


id: tidyNode::isJste
type: function
doc:
<comment>Description:</comment>
  Checks if this node is JSTE
  
  Tells if the node is JSTE.

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


id: tidyNode::isPhp
type: function
doc:
<comment>Description:</comment>
  Checks if a node is PHP
  
  Tells if the node is PHP.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the current node is PHP code, <info>false</info> otherwise.


id: tidyNode::isText
type: function
doc:
<comment>Description:</comment>
  Checks if a node represents text (no markup)
  
  Tells if the node represents a text (without any markup).

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the node represent a text, <info>false</info> otherwise.


id: tidy_access_count
type: function
doc:
<comment>Description:</comment>
  Returns the Number of Tidy accessibility warnings encountered for specified document
  
  <strong>tidy_access_count()</strong> returns the number of accessibility warnings found for the specified document.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

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

<comment>See Also:</comment>
   * <strong>tidy_error_count()</strong>
   * <strong>tidy_warning_count()</strong>


id: tidy_config_count
type: function
doc:
<comment>Description:</comment>
  Returns the Number of Tidy configuration errors encountered for specified document
  
  Returns the number of errors encountered in the configuration of the specified tidy <strong>$tidy</strong>.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

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


id: tidy_error_count
type: function
doc:
<comment>Description:</comment>
  Returns the Number of Tidy errors encountered for specified document
  
  Returns the number of Tidy errors encountered for the specified document.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

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

<comment>See Also:</comment>
   * <strong>tidy_access_count()</strong>
   * <strong>tidy_warning_count()</strong>


id: tidy_get_error_buffer
type: function
doc:
<comment>Description:</comment>
  Return warnings and errors which occurred parsing the specified document
  
  Estilo orientado a objetos (property):
  
  Estilo procedural:
  
  Returns warnings and errors which occurred parsing the specified document.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

<comment>Return:</comment>
  <info>string|false</info>  Returns the error buffer as a string, or <info>false</info> if the buffer is empty.

<comment>See Also:</comment>
   * <strong>tidy_access_count()</strong>
   * <strong>tidy_error_count()</strong>
   * <strong>tidy_warning_count()</strong>


id: tidy_get_output
type: function
doc:
<comment>Description:</comment>
  Return a string representing the parsed tidy markup
  
  Gets a string with the repaired html.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

<comment>Return:</comment>
  <info>string</info>  Returns the parsed tidy markup.


id: tidy_warning_count
type: function
doc:
<comment>Description:</comment>
  Returns the Number of Tidy warnings encountered for specified document
  
  Returns the number of Tidy warnings encountered for the specified document.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  Um objeto <class>Tidy</class>.

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

<comment>See Also:</comment>
   * <strong>tidy_error_count()</strong>
   * <strong>tidy_access_count()</strong>


id: time
type: function
doc:
<comment>Description:</comment>
  Retorna o timestamp Unix atual
  
  Retorna o horário atual medido como o número de segundos desde a Época Unix (1 de janeiro de 1970
  00:00:00 GMT).
  
  Timestamps Unix não contêm nenhuma informação sobre fuso horário local. Recomenda-se usar a classe
  <class>DateTimeImmutable</class> para lidar com informações de data e horário para evitar as armadilhas que vêm
  com o uso exclusivo de timestamps Unix.

<comment>Return:</comment>
  <info>int</info>  Retorna o timestamp atual.

<comment>See Also:</comment>
   * <class>DateTimeImmutable</class>
   * <strong>date()</strong>
   * <strong>microtime()</strong>


id: time_nanosleep
type: function
doc:
<comment>Description:</comment>
  Atrasa por um número de segundos e nanossegundos
  
  Atrasa a execução do programa pelo número de segundos informado em <strong>$seconds</strong> e de nanossegundos
  informado em <strong>$nanoseconds</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds</strong>      Deve ser um inteiro não negativo.
  <info>int</info>  <strong>$nanoseconds</strong>  Deve ser um inteiro não negativo menor que um 1 bilhão.
                     
                     No Windows, o sistema pode atrasar mais que o número de nanossegundos
                     informado, dependendo do equipamento.

<comment>Return:</comment>
  <info>array|bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
              
              Se o atraso foi interrompido por um sinal, um array associativo será retornado com os
              componentes: <return>seconds</return> - número de segundos remanescentes no atraso <return>nanoseconds</return> - número
              de nanossegundos remanescentes no atraso
              
              <return>seconds</return> - número de segundos remanescentes no atraso
              
              <return>nanoseconds</return> - número de nanossegundos remanescentes no atraso

<comment>See Also:</comment>
   * <strong>sleep()</strong>
   * <strong>usleep()</strong>
   * <strong>time_sleep_until()</strong>
   * <strong>set_time_limit()</strong>


id: time_sleep_until
type: function
doc:
<comment>Description:</comment>
  Faz o script pausar até o horário especificado
    
  
  Faz o script pausar até o horário especificado em <strong>$timestamp</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$timestamp</strong>  O timestamp que representa o horário no qual o script deve acordar.

<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>sleep()</strong>
   * <strong>usleep()</strong>
   * <strong>time_nanosleep()</strong>
   * <strong>set_time_limit()</strong>


id: timezone_abbreviations_list
type: function
doc:
<comment>Description:</comment>
  Sinônimo de DateTimeZone::listAbbreviations
  
  Esta função é um apelido para:  DateTimeZone::listAbbreviations


id: timezone_identifiers_list
type: function
doc:
<comment>Description:</comment>
  Sinônimo de DateTimeZone::listIdentifiers
  
  Esta função é um apelido para:  DateTimeZone::listIdentifiers


id: timezone_location_get
type: function
doc:
<comment>Description:</comment>
  Sinônimo de DateTimeZone::getLocation
  
  Esta função é um apelido para:  DateTimeZone::getLocation


id: timezone_name_from_abbr
type: function
doc:
<comment>Description:</comment>
  Retorna um nome de fuso horário através da abreviatura e do deslocamento UTC

<comment>Param:</comment>
  <info>string</info>  <strong>$abbr</strong>       A abreviação do fuso horário.
  <info>int</info>     <strong>$utcOffset</strong>  Deslocamento ao Horário de Greenwish(GMT) em segundos. Sendo -1 o padrão, que
                      significa que o primeiro fuso horário correspondente encontrado com <strong>$abbr</strong> é
                      retornado. Caso contrário o deslocamento é buscao, e caso não encontrado, o o
                      primeiro fuso horário, com qualquer deslocamento, é retornado.
  <info>int</info>     <strong>$isDST</strong>      Indicador do horário de verão. O padrão é -1, e informa que tendo o fuso
                      horário horário de verão, ou não, este não será levado em consideração na
                      busca. Se configurado para 1, então <strong>$utcOffset</strong> é utilizado como diferença no
                      horário de verão; se 0, então <strong>$utcOffset</strong> é utilizado sem a diferença do
                      horário de verão. Se <strong>$abbr</strong> não existir, o fuso horário será buscado
                      exclusivamente pelo <strong>$utcOffset</strong> e <strong>$isDST</strong>.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o fuso horário em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>timezone_abbreviations_list()</strong>


id: timezone_name_get
type: function
doc:
<comment>Description:</comment>
  Sinônimo de DateTimeZone::getName
  
  Esta função é um apelido para:  DateTimeZone::getName


id: timezone_offset_get
type: function
doc:
<comment>Description:</comment>
  Sinônimo de DateTimeZone::getOffset
  
  Esta função é um apelido para:  DateTimeZone::getOffset


id: timezone_open
type: function
doc:
<comment>Description:</comment>
  Sinônimo de DateTimeZone::__construct
  
  Esta função é um apelido para:  DateTimeZone::__construct


id: timezone_transitions_get
type: function
doc:
<comment>Description:</comment>
  Sinônimo de DateTimeZone::getTransitions
  
  Esta função é um apelido para:  DateTimeZone::getTransitions


id: timezone_version_get
type: function
doc:
<comment>Description:</comment>
  Obtém a versão do banco de dados de fuso horário.
    
  
  Obtém a versão atual do banco de dados de fuso horário.

<comment>Return:</comment>
  <info>string</info>  Retorna uma <info>string</info> no formato <return>YYYY.incremento</return>, como em <return>2022.2</return>.
          
          Se você tem uma versão de banco de dados de fuso horário que é antiga (por exemplo, ela
          não mostra o ano atual), pode-se atualizar a informação do fuso horário tanto atualizando
          a versão do PHP, ou instalando o pacote PECL timezonedb.
          
          Algumas distribuições Linux alteram o suporte do PHP para data/hora para usar uma fonte
          alternativa de informação de fuso horário. Neste caso, esta função irá retornar <return>0.system</return>.
          Recomenda-se instalar o pacote PECL timezonedb neste caso também.

<comment>See Also:</comment>
   * Lista de fusos horários suportados


id: tmpfile
type: function
doc:
<comment>Description:</comment>
  Cria um arquivo temporário
  
  Cria um arquivo temporário com um nome único em modo de leitura-gravação-binário (w+b) e retorna
  um manipulador do arquivo.
  
  O arquivo é automaticamente removido quando ele é fechado (por exemplo, ao chamar <strong>fclose()</strong>, ou
  quando não há mais referências para o manipulador do arquivo retornado por <strong>tmpfile()</strong>), ou quando o
  script finalizar.
  
  Se o script terminar inesperadamente, o arquivo temporário pode não ser removido.

<comment>Return:</comment>
  <info>resource|false</info>  Retorna o manipulador de arquivo, similar ao que é retornado por <strong>fopen()</strong>, para o
                  novo arquivo ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>tempnam()</strong>
   * <strong>sys_get_temp_dir()</strong>


