# php_manual

id: mysqli_stmt_insert_id
type: function
doc:
<comment>Description:</comment>
  Obtém o ID gerado pela operação INSERT anterior
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: mysqli_stmt_param_count
type: function
doc:
<comment>Description:</comment>
  Retorna o número de parâmetros para uma instrução fornecida
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o número de marcadores de parâmetros presentes na instrução preparada.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>int</info>  Retorna um inteiro que representa o número de parâmetros.

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


id: mysqli_stmt_sqlstate
type: function
doc:
<comment>Description:</comment>
  Retorna o erro SQLSTATE da operação da instrução anterior
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna uma string contento o código de erro SQLSTATE para a função de instrução preparada mais
  recentemente chamada, que possa ter sucesso ou falhar. O código de erro consiste de cinco
  caracteres. <return>'00000'</return> significa que não houve erro. Os valores são especificados pela ANSI SQL e
  pela ODBC. Para uma lista de valores possíveis, consulte
  http://dev.mysql.com/doc/mysql/en/error-handling.html.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>string</info>  Retorna uma string contendo o código de erro SQLSTATE para o último erro. O código de erro
          consiste de cinco caracteres. <return>'00000'</return> significa que não houve erro.

<comment>See Also:</comment>
   * <strong>mysqli_stmt_errno()</strong>
   * <strong>mysqli_stmt_error()</strong>


id: mysqli_thread_id
type: function
doc:
<comment>Description:</comment>
  Retorna o ID da thread para a conexão atual
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  A função <strong>mysqli_thread_id()</strong> retorna o ID da thread para a conexão atual que pode então ser
  eliminada usando a função <strong>mysqli_kill()</strong>. Se a conexão for perdida e você reconectar com
  <strong>mysqli_ping()</strong>, o ID do thread será outro. Portanto, você deve obter o ID do thread somente quando
  precisar dele.
  
  O ID do encadeamento é atribuído conexão por conexão. Portanto, se a conexão for interrompida e
  restabelecida, um novo ID de thread será atribuído.
  
  Para eliminar uma consulta em execução, você pode usar o comando SQL <return>KILL QUERY processid</return>.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>int</info>  Retorna o ID da Thread para a conexão atual.

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


id: mysqli_warning::next
type: function
doc:
<comment>Description:</comment>
  Busca o próximo aviso
  
  Altere as informações de aviso para o próximo aviso, se possível.
  
  Depois que o aviso for definido para o próximo aviso, novos valores de propriedades <return>message</return>,
  <return>sqlstate</return> e <return>errno</return> de <class>mysqli_warning</class> estarão disponíveis.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se o próximo aviso foi obtido com sucesso. Se não houver mais avisos, retornará
        <info>false</info>


id: mysqli_warning_count
type: function
doc:
<comment>Description:</comment>
  Retorna o número de avisos da última consulta para o link fornecido
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o número de avisos da última consulta na conexão.
  
  Para recuperar mensagens de aviso, você pode usar o comando SQL <return>SHOW WARNINGS [limit row_count]</return>.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>int</info>  Número de avisos ou zero se não houver avisos.

<comment>See Also:</comment>
   * <strong>mysqli_errno()</strong>
   * <strong>mysqli_error()</strong>
   * <strong>mysqli_sqlstate()</strong>


id: natcasesort
type: function
doc:
<comment>Description:</comment>
  Ordena um array utilizando o algoritmo da "ordem natural" sem diferenciar maiúsculas e minúsculas
  
  <strong>natcasesort()</strong> é uma versão case-insensitive (não diferencia letras maiúsculas de minúsculas) da
  <strong>natsort()</strong>.
  
  Essa função implementa o algoritmo de ordenação que ordena strings alfanuméricas da forma que os
  humanos fariam mantendo associação de chave/valor. Essa forma de ordenação é denominada "ordenação
  natural".
  
  Se dois elementos são comparados como iguais, eles mantêm sua ordem original. Antes do PHP 8.0.0,
  sua ordem relativa no array ordenado era indefinida.
  
  Redefine o ponteiro interno do array para o primeiro elemento.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  O array de entrada.

<comment>Return:</comment>
  <info>true</info>  Sempre retorna <info>true</info>.

<comment>See Also:</comment>
   * <strong>natsort()</strong>
   * Comparação entre as funções de ordenação de array
   * <strong>strnatcmp()</strong>
   * <strong>strnatcasecmp()</strong>


id: natsort
type: function
doc:
<comment>Description:</comment>
  Ordena um array utilizando o algoritmo de "ordem natural"
  
  Essa função implementa um algoritmo que ordena strings alfanuméricas da forma como um ser humano
  faria enquanto mantém associações de chave/valor. Isto é descrito como "ordenação natural".  Um
  exemplo da diferença entre este algoritmo e o algoritmo de ordenação comum de strings (usado em
  <strong>sort()</strong>) pode ser visto no exemplo abaixo:
  
  Se dois elementos são comparados como iguais, eles mantêm sua ordem original. Antes do PHP 8.0.0,
  sua ordem relativa no array ordenado era indefinida.
  
  Redefine o ponteiro interno do array para o primeiro elemento.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  O array de entrada.

<comment>Return:</comment>
  <info>true</info>  Sempre retorna <info>true</info>.

<comment>See Also:</comment>
   * <strong>natcasesort()</strong>
   * Comparação entre as funções de ordenação de array
   * <strong>strnatcmp()</strong>
   * <strong>strnatcasecmp()</strong>


id: net_get_interfaces
type: function
doc:
<comment>Description:</comment>
  Get network interfaces
  
  Returns an enumeration of network interfaces (adapters) on the local machine.

<comment>Return:</comment>
  <info>array|false</info>  Returns an associative <info>array</info> where the key is the name of the interface and the value
               an associative array of interface attributes, ou <info>false</info> em caso de falha.
               
               Each interface associative array contains: Interface
               attributesNomeDescriçãodescription Optional string value for description of the
               interface. Windows only. mac Optional string value for MAC address of the interface.
               Windows only. mtu Integer value for Maximum transmission unit (MTU) of the interface.
               Windows only. unicast Array of associative arrays, see Unicast attributes below. up
               Boolean status (on/off) for interface.
               
               Unicast attributesNomeDescriçãoflags Integer value. family Integer value. address
               String value for address in either IPv4 or IPv6. netmask String value for netmask in
               either IPv4 or IPv6.


id: next
type: function
doc:
<comment>Description:</comment>
  Avança o ponteiro interno de um array
  
  <strong>next()</strong> funciona de forma semelhante a <strong>current()</strong>, com uma diferença. Ele avança o ponteiro interno
  do array em uma posição antes de retornar o valor do elemento. Isso significa que ela retorna o
  próximo valor do array avançando o ponteiro interno em uma posição.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  O <info>array</info> a ser afetado.

<comment>Return:</comment>
  <info>mixed</info>  Retorna o elemento do array que está na próxima posição que é apontada pelo ponteiro
         interno do array, ou <info>false</info> caso não existam mais elementos.
         
         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>current()</strong>
   * <strong>end()</strong>
   * <strong>prev()</strong>
   * <strong>reset()</strong>
   * <strong>each()</strong>


id: ngettext
type: function
doc:
<comment>Description:</comment>
  Versão plural de gettext
  
  A versão plural de <strong>gettext()</strong>. Algumas línguas têm mais de uma forma para mensagens no plural
  dependendo da quantidade.

<comment>Param:</comment>
  <info>string</info>  <strong>$singular</strong>  O ID da mensagem singular.
  <info>string</info>  <strong>$plural</strong>    O ID da mensagem plural.
  <info>int</info>     <strong>$count</strong>     O número (ex.: contagem de itens) para determinar a translação para o
                     respectivo número gramatical.

<comment>Return:</comment>
  <info>string</info>  Retorna a forma plural correta da mensagem identificada por <strong>$singular</strong> e <strong>$plural</strong> para a
          quantidade em <strong>$count</strong>.


id: nl2br
type: function
doc:
<comment>Description:</comment>
  Inserts HTML line breaks before all newlines in a string
  
  Returns <strong>$string</strong> with \<br /&gt; or  \<br&gt; inserted before all newlines (<return>\r\n</return>, <return>\n\r</return>, <return>\n</return> and <return>\r</return>).

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>     The input string.
  <info>bool</info>    <strong>$use_xhtml</strong>  Whether to use XHTML compatible line breaks or not.

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

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


id: nl_langinfo
type: function
doc:
<comment>Description:</comment>
  Query language and locale information
  
  <strong>nl_langinfo()</strong> is used to access individual elements of the locale categories.  Unlike
  <strong>localeconv()</strong>, which returns all of the elements, <strong>nl_langinfo()</strong> allows you to select any specific
  element.

<comment>Param:</comment>
  <info>int</info>  <strong>$item</strong>  <strong>$item</strong> may be an integer value of the element or the constant name of the element. The
              following is a list of constant names for <strong>$item</strong> that may be used and their
              description. Some of these constants may not be defined or hold no value for certain
              locales. nl_langinfo ConstantsConstantDescriptionLC_TIME Category
              Constants<info>ABDAY_(1-7)</info>Abbreviated name of n-th day of the week.<info>DAY_(1-7)</info>Name of the n-th
              day of the week (DAY_1 = Sunday).<info>ABMON_(1-12)</info>Abbreviated name of the n-th month of the
              year.<info>MON_(1-12)</info>Name of the n-th month of the year.<info>AM_STR</info>String for Ante
              meridian.<info>PM_STR</info>String for Post meridian.<info>D_T_FMT</info>String that can be used as the format
              string for <strong>strftime()</strong> to represent time and date.<info>D_FMT</info>String that can be used as the
              format string for <strong>strftime()</strong> to represent date.<info>T_FMT</info>String that can be used as the
              format string for <strong>strftime()</strong> to represent time.<info>T_FMT_AMPM</info>String that can be used as
              the format string for <strong>strftime()</strong> to represent time in 12-hour format with ante/post
              meridian.<info>ERA</info>Alternate era.<info>ERA_YEAR</info>Year in alternate era format.<info>ERA_D_T_FMT</info>Date and
              time in alternate era format (string can be used in <strong>strftime()</strong>).<info>ERA_D_FMT</info>Date in
              alternate era format (string can be used in <strong>strftime()</strong>).<info>ERA_T_FMT</info>Time in alternate era
              format (string can be used in <strong>strftime()</strong>).LC_MONETARY Category
              Constants<info>INT_CURR_SYMBOL</info>International currency symbol.<info>CURRENCY_SYMBOL</info>Local currency
              symbol.<info>CRNCYSTR</info>Same value as <info>CURRENCY_SYMBOL</info>.<info>MON_DECIMAL_POINT</info>Decimal point
              character.<info>MON_THOUSANDS_SEP</info>Thousands separator (groups of three
              digits).<info>MON_GROUPING</info>Like <return>"grouping"</return> element.<info>POSITIVE_SIGN</info>Sign for positive
              values.<info>NEGATIVE_SIGN</info>Sign for negative values.<info>INT_FRAC_DIGITS</info>International fractional
              digits.<info>FRAC_DIGITS</info>Local fractional digits.<info>P_CS_PRECEDES</info>Returns 1 if <info>CURRENCY_SYMBOL</info>
              precedes a positive value.<info>P_SEP_BY_SPACE</info>Returns 1 if a space separates <info>CURRENCY_SYMBOL</info>
              from a positive value.<info>N_CS_PRECEDES</info>Returns 1 if <info>CURRENCY_SYMBOL</info> precedes a negative
              value.<info>N_SEP_BY_SPACE</info>Returns 1 if a space separates <info>CURRENCY_SYMBOL</info> from a negative
              value.<info>P_SIGN_POSN</info> Returns 0 if parentheses surround the quantity and <info>CURRENCY_SYMBOL</info>.
              Returns 1 if the sign string precedes the quantity and <info>CURRENCY_SYMBOL</info>.  Returns 2 if
              the sign string follows the quantity and <info>CURRENCY_SYMBOL</info>.  Returns 3 if the sign
              string immediately precedes the <info>CURRENCY_SYMBOL</info>.  Returns 4 if the sign string
              immediately follows the <info>CURRENCY_SYMBOL</info>. <info>N_SIGN_POSN</info>LC_NUMERIC Category
              Constants<info>DECIMAL_POINT</info>Decimal point character.<info>RADIXCHAR</info>Same value as
              <info>DECIMAL_POINT</info>.<info>THOUSANDS_SEP</info>Separator character for thousands (groups of three
              digits).<info>THOUSEP</info>Same value as <info>THOUSANDS_SEP</info>.<info>GROUPING</info>LC_MESSAGES Category
              Constants<info>YESEXPR</info>Regex string for matching <return>"yes"</return> input.<info>NOEXPR</info>Regex string for matching
              <return>"no"</return> input.<info>YESSTR</info>Output string for <return>"yes"</return>.<info>NOSTR</info>Output string for <return>"no"</return>.LC_CTYPE Category
              Constants<info>CODESET</info>Return a string with the name of the character encoding.
              
              Returns 0 if parentheses surround the quantity and <info>CURRENCY_SYMBOL</info>.
              
              Returns 1 if the sign string precedes the quantity and <info>CURRENCY_SYMBOL</info>.
              
              Returns 2 if the sign string follows the quantity and <info>CURRENCY_SYMBOL</info>.
              
              Returns 3 if the sign string immediately precedes the <info>CURRENCY_SYMBOL</info>.
              
              Returns 4 if the sign string immediately follows the <info>CURRENCY_SYMBOL</info>.

<comment>Return:</comment>
  <info>string|false</info>  Returns the element as a string, or <info>false</info> if <strong>$item</strong> is not valid.

<comment>See Also:</comment>
   * <strong>setlocale()</strong>
   * <strong>localeconv()</strong>


id: number_format
type: function
doc:
<comment>Description:</comment>
  Format a number with grouped thousands
  
  Formats a number with grouped thousands and optionally decimal digits using the rounding half up
  rule.

<comment>Param:</comment>
  <info>float</info>        <strong>$num</strong>                  The number being formatted.
  <info>int</info>          <strong>$decimals</strong>             Sets the number of decimal digits. If <return>0</return>, the <strong>$decimal_separator</strong>
                                     is omitted from the return value.
  <info>string|null</info>  <strong>$decimal_separator</strong>    Sets the separator for the decimal point.
  <info>string|null</info>  <strong>$thousands_separator</strong>  Sets the thousands separator.

<comment>Return:</comment>
  <info>string</info>  A formatted version of <strong>$num</strong>.

<comment>See Also:</comment>
   * <strong>money_format()</strong>
   * <strong>sprintf()</strong>
   * <strong>printf()</strong>
   * <strong>sscanf()</strong>


id: oauth_get_sbs
type: function
doc:
<comment>Description:</comment>
  Generate a Signature Base String
  
  Generates a Signature Base String according to pecl/oauth.

<comment>Param:</comment>
  <info>string</info>  <strong>$http_method</strong>         The HTTP method.
  <info>string</info>  <strong>$uri</strong>                 URI to encode.
  <info>array</info>   <strong>$request_parameters</strong>  Array of request parameters.

<comment>Return:</comment>
  <info>string</info>  Returns a Signature Base String.


id: oauth_urlencode
type: function
doc:
<comment>Description:</comment>
  Encode a URI to RFC 3986
  
  Encodes a URI to RFC 3986.

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>  URI to encode.

<comment>Return:</comment>
  <info>string</info>  Returns an RFC 3986 encoded string.


id: ob_clean
type: function
doc:
<comment>Description:</comment>
  Limpa (apaga) o buffer de saída
  
  Esta função descarta o conteúdo do buffer de saída.
  
  Esta função não destrói o buffer de saída como a função <strong>ob_end_clean()</strong> faz.
  
  O buffer de saída deve ser iniciado por <strong>ob_start()</strong> com a opção PHP_OUTPUT_HANDLER_CLEANABLE. Caso
  contrário <strong>ob_clean()</strong> não funcionará.

<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>ob_flush()</strong>
   * <strong>ob_end_flush()</strong>
   * <strong>ob_end_clean()</strong>


id: ob_end_clean
type: function
doc:
<comment>Description:</comment>
  Clean (erase) the output buffer and turn off output buffering
  
  This function discards the contents of the topmost output buffer and turns off this output
  buffering. If you want to further process the buffer's contents you have to call <strong>ob_get_contents()</strong>
  before <strong>ob_end_clean()</strong> as the buffer contents are discarded when <strong>ob_end_clean()</strong> is called.
  
  The output buffer must be started by <strong>ob_start()</strong> with PHP_OUTPUT_HANDLER_CLEANABLE and
  PHP_OUTPUT_HANDLER_REMOVABLE flags. Otherwise <strong>ob_end_clean()</strong> will not work.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. Reasons for failure are first
        that you called the function without an active buffer or that for some reason a buffer could
        not be deleted (possible for special buffer).

<comment>See Also:</comment>
   * <strong>ob_start()</strong>
   * <strong>ob_get_contents()</strong>
   * <strong>ob_flush()</strong>


id: ob_end_flush
type: function
doc:
<comment>Description:</comment>
  Flush (send) the output buffer and turn off output buffering
  
  This function will send the contents of the topmost output buffer (if any) and turn this output
  buffer off.  If you want to further process the buffer's contents you have to call
  <strong>ob_get_contents()</strong> before <strong>ob_end_flush()</strong> as the buffer contents are discarded after <strong>ob_end_flush()</strong>
  is called.
  
  The output buffer must be started by <strong>ob_start()</strong> with PHP_OUTPUT_HANDLER_FLUSHABLE and
  PHP_OUTPUT_HANDLER_REMOVABLE flags. Otherwise <strong>ob_end_flush()</strong> will not work.
  
  This function is similar to <strong>ob_get_flush()</strong>, except that <strong>ob_get_flush()</strong> returns the buffer as a
  string.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. Reasons for failure are first
        that you called the function without an active buffer or that for some reason a buffer could
        not be deleted (possible for special buffer).

<comment>See Also:</comment>
   * <strong>ob_start()</strong>
   * <strong>ob_get_contents()</strong>
   * <strong>ob_get_flush()</strong>
   * <strong>ob_flush()</strong>
   * <strong>ob_end_clean()</strong>


id: ob_flush
type: function
doc:
<comment>Description:</comment>
  Descarrega (envia) o buffer de saída
  
  Esta função enviará o conteúdo do buffer de saída (se houver). Se for desejado processamento
  adicional do conteúdo do buffer, deve-se chamar <strong>ob_get_contents()</strong> antes de <strong>ob_flush()</strong> já que o
  conteúdo do buffer é descartado depois que a função <strong>ob_flush()</strong> é chamada.
  
  Esta função não destrói o buffer de saída como a função <strong>ob_end_flush()</strong> faz.

<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>ob_get_contents()</strong>
   * <strong>ob_clean()</strong>
   * <strong>ob_end_flush()</strong>
   * <strong>ob_end_clean()</strong>


id: ob_get_clean
type: function
doc:
<comment>Description:</comment>
  Get current buffer contents and delete current output buffer
  
  Gets the current buffer contents and delete current output buffer.
  
  <strong>ob_get_clean()</strong> essentially executes both <strong>ob_get_contents()</strong> and <strong>ob_end_clean()</strong>.
  
  The output buffer must be started by <strong>ob_start()</strong> with PHP_OUTPUT_HANDLER_CLEANABLE and
  PHP_OUTPUT_HANDLER_REMOVABLE flags. Otherwise <strong>ob_get_clean()</strong> will not work.

<comment>Return:</comment>
  <info>string|false</info>  Returns the contents of the output buffer and end output buffering. If output
                buffering isn't active then <info>false</info> is returned.

<comment>See Also:</comment>
   * <strong>ob_get_contents()</strong>
   * <strong>ob_start()</strong>


id: ob_get_contents
type: function
doc:
<comment>Description:</comment>
  Retorna o conteúdo do buffer de saída
  
  Obtém o conteúdo do buffer de saída sem limpá-lo.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o conteúdo do buffer de saída ou <info>false</info>, se o buffer de saída não estiver
                ativo.

<comment>See Also:</comment>
   * <strong>ob_start()</strong>
   * <strong>ob_get_length()</strong>


id: ob_get_flush
type: function
doc:
<comment>Description:</comment>
  Flush the output buffer, return it as a string and turn off output buffering
  
  <strong>ob_get_flush()</strong> flushes the output buffer, return it as a string and turns off output buffering.
  
  The output buffer must be started by <strong>ob_start()</strong> with PHP_OUTPUT_HANDLER_FLUSHABLE flag. Otherwise
  <strong>ob_get_flush()</strong> will not work.
  
  This function is similar to <strong>ob_end_flush()</strong>, except that this function also returns the buffer as a
  string.

<comment>Return:</comment>
  <info>string|false</info>  Returns the output buffer or <info>false</info> if no buffering is active.

<comment>See Also:</comment>
   * <strong>ob_end_clean()</strong>
   * <strong>ob_end_flush()</strong>
   * <strong>ob_list_handlers()</strong>


id: ob_get_length
type: function
doc:
<comment>Description:</comment>
  Retorna o comprimento do buffer de saída
  
  Esta função retonará o comprimento do conteúdo do buffer de saída, em bytes.

<comment>Return:</comment>
  <info>int|false</info>  Retorna o comprimento do conteúdo do buffer de saída ou <info>false</info> se o buffer não estiver
             ativo.

<comment>See Also:</comment>
   * <strong>ob_start()</strong>
   * <strong>ob_get_contents()</strong>


id: ob_get_level
type: function
doc:
<comment>Description:</comment>
  Return the nesting level of the output buffering mechanism
  
  Returns the nesting level of the output buffering mechanism.

<comment>Return:</comment>
  <info>int</info>  Returns the level of nested output buffering handlers or zero if output buffering is not
       active.

<comment>See Also:</comment>
   * <strong>ob_start()</strong>
   * <strong>ob_get_contents()</strong>


id: ob_get_status
type: function
doc:
<comment>Description:</comment>
  Get status of output buffers
  
  <strong>ob_get_status()</strong> returns status information on either the top level output buffer or all active
  output buffer levels if <strong>$full_status</strong> is set to <info>true</info>.

<comment>Param:</comment>
  <info>bool</info>  <strong>$full_status</strong>  <info>true</info> to return all active output buffer levels. If <info>false</info> or not set, only the
                      top level output buffer is returned.

<comment>Return:</comment>
  <info>array</info>  If called without the <strong>$full_status</strong> parameter or with <strong>$full_status</strong> = <info>false</info> a simple array
         with the following elements is returned:  2 [type] => 0 [status] => 0 [name] =>
         URL-Rewriter [del] => 1
         )
         ]]> Simple <strong>ob_get_status()</strong> resultsKeyValuelevelOutput nesting leveltype<return>0</return> (internal handler)
         or <return>1</return> (user supplied handler)statusOne of <return>PHP_OUTPUT_HANDLER_START</return> (0),
         <return>PHP_OUTPUT_HANDLER_CONT</return> (1) or <return>PHP_OUTPUT_HANDLER_END</return> (2)nameName of active output handler
         or ' default output handler' if none is setdelErase-flag as set by <strong>ob_start()</strong>
         
         If called with <strong>$full_status</strong> = <info>true</info> an array with one element for each active output buffer
         level is returned. The output level is used as key of the top level array and each array
         element itself is another array holding status information on one active output level.
         Array ( [chunk_size] => 0 [size] => 40960 [block_size] => 10240 [type] => 1 [status] => 0
         [name] => default output handler [del] => 1 )
          [1] => Array ( [chunk_size] => 0 [size] => 40960 [block_size] => 10240 [type] => 0
         [buffer_size] => 0 [status] => 0 [name] => URL-Rewriter [del] => 1 )
         
         )
         ]]>
         
         The full output contains these additional elements: Full <strong>ob_get_status()</strong>
         resultsKeyValuechunk_sizeChunk size as set by <strong>ob_start()</strong>size...blocksize...

<comment>See Also:</comment>
   * <strong>ob_get_level()</strong>
   * <strong>ob_list_handlers()</strong>


id: ob_gzhandler
type: function
doc:
<comment>Description:</comment>
  ob_start callback function to gzip output buffer
  
  <strong>ob_gzhandler()</strong> is intended to be used as a callback function for <strong>ob_start()</strong> to help facilitate
  sending gz-encoded data to web browsers that support compressed web pages.   Before <strong>ob_gzhandler()</strong>
  actually sends compressed data, it determines what type of content encoding the browser will
  accept ("gzip", "deflate" or none at all) and will return its output accordingly. All browsers are
  supported since it's up to the browser to send the correct header saying that it accepts
  compressed web pages. If a browser doesn't support compressed pages this function returns <info>false</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>   
  <info>int</info>     <strong>$flags</strong>  

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

<comment>See Also:</comment>
   * <strong>ob_start()</strong>
   * <strong>ob_end_flush()</strong>


id: ob_iconv_handler
type: function
doc:
<comment>Description:</comment>
  Converte codificação de caracteres como manipulador de buffer de saída
  
  Converte a string codificada em <strong>$internal_encoding</strong> em <strong>$output_encoding</strong>.
  
  <strong>$internal_encoding</strong> e <strong>$output_encoding</strong> devem ser definidos no arquivo php.ini ou em
  <strong>iconv_set_encoding()</strong>.

<comment>Return:</comment>
  <info>string</info>  Consulte <strong>ob_start()</strong> para obter informações sobre os valores de retorno desse manipulador.

<comment>See Also:</comment>
   * <strong>iconv_get_encoding()</strong>
   * <strong>iconv_set_encoding()</strong>
   * output-control functions


id: ob_implicit_flush
type: function
doc:
<comment>Description:</comment>
  Turn implicit flush on/off
  
  <strong>ob_implicit_flush()</strong> will turn implicit flushing on or off. Implicit flushing will result in a
  flush operation after every output call, so that explicit calls to <strong>flush()</strong> will no longer be
  needed.

<comment>Param:</comment>
  <info>bool</info>  <strong>$enable</strong>  <info>true</info> to turn implicit flushing on, <info>false</info> otherwise.

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

<comment>See Also:</comment>
   * <strong>flush()</strong>
   * <strong>ob_start()</strong>
   * <strong>ob_end_flush()</strong>


id: ob_list_handlers
type: function
doc:
<comment>Description:</comment>
  List all output handlers in use
  
  Lists all output handlers in use.

<comment>Return:</comment>
  <info>array</info>  This will return an array with the output handlers in use (if any). If output_buffering is
         enabled or an anonymous function was used with <strong>ob_start()</strong>, <strong>ob_list_handlers()</strong> will return
         "default output handler".

<comment>See Also:</comment>
   * <strong>ob_end_clean()</strong>
   * <strong>ob_end_flush()</strong>
   * <strong>ob_get_flush()</strong>
   * <strong>ob_start()</strong>


id: ob_start
type: function
doc:
<comment>Description:</comment>
  Ativa o buffer de saída
  
  Esta função irá ativar o buffer de saída. Enquanto o buffer de saída estiver ativo, não é enviada
  a saída do script (outros que não sejam cabeçalhos), ao invés a saída é guardada em um buffer
  interno.
  
  O conteúdo deste buffer interno pode ser copiado em uma variável usando <strong>ob_get_contents()</strong>. Para
  enviar o que está no buffer interno, use <strong>ob_end_flush()</strong>. Alternativamente, <strong>ob_end_clean()</strong> irá
  silenciosamente descartar o conteúdo do buffer.
  
  Alguns servidores web (Apache, por exemplo) modificam o diretório de trabalho de um script no
  momento da chamada da função de callback. Você pode modificar para o diretório anterior fazendo um
  <return>chdir(dirname($_SERVER['SCRIPT_FILENAME']))</return> no corpo da função callback.
  
  Buffers de saída são empilháveis, ou seja, você pode utilizar <strong>ob_start()</strong> enquanto outro <strong>ob_start()</strong>
  estiver ativo. Apenas tenha certeza que você utiliza <strong>ob_end_flush()</strong> o número apropriado de vezes.
  Se multiplas funções de callback de saída estiverem ativas, a saída será filtrada sequencialmente
  atráves de cada uma delas na ordem de aninhamento.
  
  Se buffer de output estiver ativo quando do escript encerra, o PHP envia os dados automaticamente.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>    Uma função de callback opcional <strong>$callback</strong> também pode ser especificada.
                         Esta função tem um parâmetro string e deve retornar uma string. Esta função
                         será chamada quando o buffer é descarregado (flush), limpo (com <strong>ob_flush()</strong>,
                         <strong>ob_clean()</strong> ou função similar) ou quando o buffer de saída for descarregado
                         ao final da requisição. Quando <strong>$callback</strong> for chamada ela irá receber o
                         conteúdo do buffer como seu parâmetro e é esperado que ela retorne um novo
                         buffer de saída como resultado, o qual será enviado para o navegador. Se
                         <strong>$callback</strong> não é uma função que possa ser chamada, esta função irá retornar
                         <info>false</info>. O callback deve ter a seguinte assinatura:
                         
                         <info>string</info>handler<info>string</info><strong>$buffer</strong><info>int</info><strong>$phase</strong><strong>$buffer</strong> O conteúdo original do buffer.
                         <strong>$phase</strong> Bitmask das constantes <info>PHP_OUTPUT_HANDLER_*</info>.
                         
                         O conteúdo original do buffer.
                         
                         Bitmask das constantes <info>PHP_OUTPUT_HANDLER_*</info>.
                         
                         Se <strong>$callback</strong> retornar <info>false</info> então o buffer original é enviado ao navegador.
                         
                         O parâmetro <strong>$callback</strong> pode ser ignorado informando um <info>null</info> como seu valor.
                         
                         <strong>ob_end_clean()</strong>, <strong>ob_end_flush()</strong>, <strong>ob_clean()</strong>, <strong>ob_flush()</strong> e <strong>ob_start()</strong> não
                         podem ser chamados de dentro da função callback. Se chamá-las dentro da
                         função callback, o comportamento é indefinido. Se você quiser limpar o
                         conteúdo do buffer, retorne "" (a null string) de dentro da função
                         callback. Você não pode chamar outras funções que utilizam o buffer de
                         saída como <return>print_r($expression, true)</return> ou <return>highlight_file($filename, true)</return> de
                         dentro da função callback.
                         
                         A função <strong>ob_gzhandler()</strong> existe para facilitar o envio de dados comprimidos
                         no formato gz à navegadores que suportam páginas web compactadas.
                         <strong>ob_gzhandler()</strong> determina que tipo de codificação de conteúdos os
                         navegadores podem aceitar e retorna o resultado com base nessas
                         informações.
  <info>string</info>    <strong>$buffer</strong>      O conteúdo original do buffer.
  <info>int</info>       <strong>$phase</strong>       Bitmask das constantes <info>PHP_OUTPUT_HANDLER_*</info>.
  <info>int</info>       <strong>$chunk_size</strong>  Se o parâmetro opcional <strong>$chunk_size</strong> é informado, o buffer será descarregado
                         em qualquer ponto de output que cause o buffer ter dados de tamanho igual
                         ou maior que <strong>$chunk_size</strong>. O valor padrão é <return>0</return>, que significa que o função de
                         output só será chamada quando o buffer de saída é fechado.
  <info>int</info>       <strong>$flags</strong>       O parâmetro <strong>$flags</strong> é um bitmask que controla as operações que podem ser
                         realizadas no buffer de saída. O padrão é permitir que o buffer de saída
                         possa ser limpo, descarregado ou removido, o que pode ser configurado
                         explicitamente como <info>PHP_OUTPUT_HANDLER_CLEANABLE</info> |
                         <info>PHP_OUTPUT_HANDLER_FLUSHABLE</info> | <info>PHP_OUTPUT_HANDLER_REMOVABLE</info>, ou pelo atalho
                         <info>PHP_OUTPUT_HANDLER_STDFLAGS</info>.
                         
                         Cada flasg controla o acesso das funções, como descrito a seguir::
                         ConstanteFunções<info>PHP_OUTPUT_HANDLER_CLEANABLE</info><strong>ob_clean()</strong>, <strong>ob_end_clean()</strong> e
                         <strong>ob_get_clean()</strong>. <info>PHP_OUTPUT_HANDLER_FLUSHABLE</info><strong>ob_end_flush()</strong>, <strong>ob_flush()</strong> e
                         <strong>ob_get_flush()</strong>. <info>PHP_OUTPUT_HANDLER_REMOVABLE</info><strong>ob_end_clean()</strong>, <strong>ob_end_flush()</strong>
                         e <strong>ob_get_flush()</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>ob_get_contents()</strong>
   * <strong>ob_end_clean()</strong>
   * <strong>ob_end_flush()</strong>
   * <strong>ob_implicit_flush()</strong>
   * <strong>ob_gzhandler()</strong>
   * <strong>ob_iconv_handler()</strong>
   * <strong>mb_output_handler()</strong>
   * <strong>ob_tidyhandler()</strong>


id: ob_tidyhandler
type: function
doc:
<comment>Description:</comment>
  ob_start callback function to repair the buffer
  
  Callback function for <strong>ob_start()</strong> to repair the buffer.

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

<comment>Return:</comment>
  <info>string</info>  Returns the modified buffer.

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


id: oci_bind_array_by_name
type: function
doc:
<comment>Description:</comment>
  Binds a PHP array to an Oracle PL/SQL array parameter
  
  Binds the PHP array <strong>$var</strong> to the Oracle placeholder <strong>$param</strong>, which points to an Oracle PL/SQL array.
  Whether it will be used for input or output will be determined at run-time.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>         A valid OCI statement identifier.
  <info>string</info>    <strong>$param</strong>             The Oracle placeholder.
  <info>array</info>     <strong>$var</strong>               An array.
  <info>int</info>       <strong>$max_array_length</strong>  Sets the maximum length both for incoming and result arrays.
  <info>int</info>       <strong>$max_item_length</strong>   Sets maximum length for array items. If not specified or equals to
                               -1, <strong>oci_bind_array_by_name()</strong> will find the longest element in the
                               incoming array and will use it as the maximum length.
  <info>int</info>       <strong>$type</strong>              Should be used to set the type of PL/SQL array items. See list of
                               available types below:
                               
                               <info>SQLT_NUM</info> - for arrays of NUMBER. <info>SQLT_INT</info> - for arrays of INTEGER
                               (Note: INTEGER it is actually a synonym for NUMBER(38), but <info>SQLT_NUM</info>
                               type won't work in this case even though they are synonyms). <info>SQLT_FLT</info>
                               - for arrays of FLOAT. <info>SQLT_AFC</info> - for arrays of CHAR. <info>SQLT_CHR</info> - for
                               arrays of VARCHAR2. <info>SQLT_VCS</info> - for arrays of VARCHAR. <info>SQLT_AVC</info> - for
                               arrays of CHARZ. <info>SQLT_STR</info> - for arrays of STRING. <info>SQLT_LVC</info> - for
                               arrays of LONG VARCHAR. <info>SQLT_ODT</info> - for arrays of DATE.
                               
                               <info>SQLT_NUM</info> - for arrays of NUMBER.
                               
                               <info>SQLT_INT</info> - for arrays of INTEGER (Note: INTEGER it is actually a
                               synonym for NUMBER(38), but <info>SQLT_NUM</info> type won't work in this case
                               even though they are synonyms).
                               
                               <info>SQLT_FLT</info> - for arrays of FLOAT.
                               
                               <info>SQLT_AFC</info> - for arrays of CHAR.
                               
                               <info>SQLT_CHR</info> - for arrays of VARCHAR2.
                               
                               <info>SQLT_VCS</info> - for arrays of VARCHAR.
                               
                               <info>SQLT_AVC</info> - for arrays of CHARZ.
                               
                               <info>SQLT_STR</info> - for arrays of STRING.
                               
                               <info>SQLT_LVC</info> - for arrays of LONG VARCHAR.
                               
                               <info>SQLT_ODT</info> - for arrays of DATE.

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


id: oci_bind_by_name
type: function
doc:
<comment>Description:</comment>
  Binds a PHP variable to an Oracle placeholder
  
  Binds a PHP variable <strong>$var</strong> to the Oracle bind variable placeholder <strong>$param</strong>.  Binding is important
  for Oracle database performance and also as a way to avoid SQL Injection security issues.
  
  Binding allows the database to reuse the statement context and caches from previous executions of
  the statement, even if another user or process originally executed it.  Binding reduces SQL
  Injection concerns because the data associated with a bind variable is never treated as part of
  the SQL statement.  It does not need quoting or escaping.
  
  PHP variables that have been bound can be changed and the statement re-executed without needing to
  re-parse the statement or re-bind.
  
  In Oracle, bind variables are commonly divided into <return>IN</return> binds for values that are passed into the
  database, and <return>OUT</return> binds for values that are returned to PHP.  A bind variable may be both <return>IN</return> and
  <return>OUT</return>.  Whether a bind variable will be used for input or output is determined at run-time.
  
  You must specify <strong>$max_length</strong> when using an <return>OUT</return> bind so that PHP allocates enough memory to hold
  the returned value.
  
  For <return>IN</return> binds it is recommended to set the <strong>$max_length</strong> length if the statement is re-executed
  multiple times with different values for the PHP variable.  Otherwise Oracle may truncate data to
  the length of the initial PHP variable value.  If you don't know what the maximum length will be,
  then re-call <strong>oci_bind_by_name()</strong> with the current data size prior to each <strong>oci_execute()</strong> call.
  Binding an unnecessarily large length will have an impact on process memory in the database.
  
  A bind call tells Oracle which memory address to read data from. For <return>IN</return> binds that address needs
  to contain valid data when <strong>oci_execute()</strong> is called.  This means that the variable bound must
  remain in scope until execution.  If it doesn't, unexpected results or errors such as "ORA-01460:
  unimplemented or unreasonable conversion requested" may occur.  For <return>OUT</return> binds one symptom is no
  value being set in the PHP variable.
  
  For a statement that is repeatedly executed, binding values that never change may reduce the
  ability of the Oracle optimizer to choose the best statement execution plan.  Long running
  statements that are rarely re-executed may not benefit from binding.  However in both cases,
  binding might be safer than joining strings into a SQL statement, as this can be a security risk
  if unfiltered user text is concatenated.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>   A valid OCI8 statement identifier.
  <info>string</info>    <strong>$param</strong>       The colon-prefixed bind variable placeholder used in the statement.  The
                         colon is optional in <strong>$param</strong>. Oracle does not use question marks for
                         placeholders.
  <info>mixed</info>     <strong>$var</strong>         The PHP variable to be associated with <strong>$param</strong>
  <info>int</info>       <strong>$max_length</strong>  Sets the maximum length for the data. If you set it to -1, this function
                         will use the current length of <strong>$var</strong> to set the maximum length. In this case
                         the <strong>$var</strong> must exist and contain data when <strong>oci_bind_by_name()</strong> is called.
  <info>int</info>       <strong>$type</strong>        The datatype that Oracle will treat the data as.  The default <strong>$type</strong> used is
                         <info>SQLT_CHR</info>. Oracle will convert the data between this type and the database
                         column (or PL/SQL variable type), when possible.
                         
                         If you need to bind an abstract datatype (LOB/ROWID/BFILE) you need to
                         allocate it first using the <strong>oci_new_descriptor()</strong> function. The <strong>$length</strong> is
                         not used for abstract datatypes and should be set to -1.
                         
                         Possible values for <strong>$type</strong> are: <info>SQLT_BFILEE</info> or <info>OCI_B_BFILE</info>  - for BFILEs;
                         <info>SQLT_CFILEE</info> or <info>OCI_B_CFILEE</info> - for CFILEs; <info>SQLT_CLOB</info> or <info>OCI_B_CLOB</info> - for
                         CLOBs; <info>SQLT_BLOB</info> or <info>OCI_B_BLOB</info> - for BLOBs; <info>SQLT_RDD</info> or <info>OCI_B_ROWID</info> - for
                         ROWIDs; <info>SQLT_NTY</info> or <info>OCI_B_NTY</info> - for named datatypes; <info>SQLT_INT</info> or <info>OCI_B_INT</info>
                         - for integers; <info>SQLT_CHR</info> - for VARCHARs; <info>SQLT_BIN</info> or <info>OCI_B_BIN</info> - for RAW
                         columns; <info>SQLT_LNG</info> - for LONG columns; <info>SQLT_LBI</info> - for LONG RAW columns;
                         <info>SQLT_RSET</info> - for cursors created with <strong>oci_new_cursor()</strong>; <info>SQLT_BOL</info> or
                         <info>OCI_B_BOL</info> - for PL/SQL BOOLEANs (Requires Oracle Database 12c)
                         
                         <info>SQLT_BFILEE</info> or <info>OCI_B_BFILE</info>  - for BFILEs;
                         
                         <info>SQLT_CFILEE</info> or <info>OCI_B_CFILEE</info> - for CFILEs;
                         
                         <info>SQLT_CLOB</info> or <info>OCI_B_CLOB</info> - for CLOBs;
                         
                         <info>SQLT_BLOB</info> or <info>OCI_B_BLOB</info> - for BLOBs;
                         
                         <info>SQLT_RDD</info> or <info>OCI_B_ROWID</info> - for ROWIDs;
                         
                         <info>SQLT_NTY</info> or <info>OCI_B_NTY</info> - for named datatypes;
                         
                         <info>SQLT_INT</info> or <info>OCI_B_INT</info> - for integers;
                         
                         <info>SQLT_CHR</info> - for VARCHARs;
                         
                         <info>SQLT_BIN</info> or <info>OCI_B_BIN</info> - for RAW columns;
                         
                         <info>SQLT_LNG</info> - for LONG columns;
                         
                         <info>SQLT_LBI</info> - for LONG RAW columns;
                         
                         <info>SQLT_RSET</info> - for cursors created with <strong>oci_new_cursor()</strong>;
                         
                         <info>SQLT_BOL</info> or <info>OCI_B_BOL</info> - for PL/SQL BOOLEANs (Requires Oracle Database 12c)

<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>oci_bind_array_by_name()</strong>
   * <strong>oci_parse()</strong>


id: oci_cancel
type: function
doc:
<comment>Description:</comment>
  Cancels reading from cursor
  
  Invalidates a cursor, freeing all associated resources and cancels the ability to read from it.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  An OCI statement.

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


id: oci_client_version
type: function
doc:
<comment>Description:</comment>
  Returns the Oracle client library version
  
  Returns a string containing the version number of the Oracle C client library that PHP is linked
  with.

<comment>Return:</comment>
  <info>string</info>  Returns the version number as a <info>string</info>.

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


id: oci_close
type: function
doc:
<comment>Description:</comment>
  Closes an Oracle connection
  
  Unsets <strong>$connection</strong>.  The underlying database connection is closed if no other resources are using
  it and if it was created with <strong>oci_connect()</strong> or <strong>oci_new_connect()</strong>.
  
  It is recommended to close connections that are no longer needed because this makes database
  resources available for other users.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>  An Oracle connection identifier returned by  <strong>oci_connect()</strong>, <strong>oci_pconnect()</strong>,
                         or <strong>oci_new_connect()</strong>.

<comment>Return:</comment>
  <info>bool|null</info>  Returns <info>null</info> when oci8.old_oci_close_semantics is enabled, or <info>true</info> otherwise.

<comment>See Also:</comment>
   * <strong>oci_connect()</strong>
   * <strong>oci_free_statement()</strong>


id: oci_commit
type: function
doc:
<comment>Description:</comment>
  Commits the outstanding database transaction
  
  Commits the outstanding transaction for the Oracle <strong>$connection</strong>.  A commit ends the current
  transaction and makes permanent all changes.  It releases all locks held.
  
  A transaction begins when the first SQL statement that changes data is executed with <strong>oci_execute()</strong>
  using the <info>OCI_NO_AUTO_COMMIT</info> flag.  Further data changes made by other statements become part of
  the same transaction.  Data changes made in a transaction are temporary until the transaction is
  committed or rolled back.  Other users of the database will not see the changes until they are
  committed.
  
  When inserting or updating data, using transactions is recommended for relational data consistency
  and for performance reasons.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>  An Oracle connection identifier, returned by <strong>oci_connect()</strong>, <strong>oci_pconnect()</strong>,
                         or <strong>oci_new_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>oci_execute()</strong>
   * <strong>oci_rollback()</strong>


id: oci_connect
type: function
doc:
<comment>Description:</comment>
  Connect to an Oracle database
  
  Returns a connection identifier needed for most other OCI8 operations.
  
  For performance, most applications should use persistent connections with <strong>oci_pconnect()</strong> instead
  of <strong>oci_connect()</strong>. See Connection Handling for general information on connection management and
  connection pooling.
  
  The second and subsequent calls to <strong>oci_connect()</strong> with the same parameters will return the
  connection handle returned from the first call. This means that transactions in one handle are
  also in the other handles, because they use the same underlying database connection. If two
  handles need to be transactionally isolated from each other, use <strong>oci_new_connect()</strong> instead.

<comment>Param:</comment>
  <info>string</info>       <strong>$username</strong>           The Oracle user name.
  <info>string</info>       <strong>$password</strong>           The password for <strong>$username</strong>.
  <info>string|null</info>  <strong>$connection_string</strong>  Contém
                                   a <return>instância do Oracle</return> à qual se conectar. Pode ser
                                   uma string Easy
                                   Connect ou um Connect Name do
                                   arquivo tnsnames.ora ou o nome de uma instância
                                   local do Oracle.
                                   
                                   Se não especificado ou <info>null</info>, o PHP usará
                                   variáveis de ambiente como <info>TWO_TASK</info> (no Linux)
                                   ou <info>LOCAL</info> (no Windows)
                                   e <info>ORACLE_SID</info> para determinar a
                                   <return>instância do Oracle</return> à qual se conectar.
                                   
                                   Para usar o método de nomenclatura Easy Connect, o PHP precisa
                                   ter sido compilado com as bibliotecas
                                   Oracle Client 10g ou superiores. A string Easy Connect para o
                                   Oracle
                                   10g tem o formato:
                                   [//]nome_do_servidor[:porta][/nome_do_servico]. A partir do
                                   Oracle
                                   11g a sintaxe é:
                                   
                                   [//]nome_do_servidor[:porta][/nome_do_servico][:tipo_de_servidor][/nome_da_instancia].
                                   Outras opções foram introduzidas com o Oracle 19c, incluindo as
                                   configurações de timeout
                                   e keep-alive. Consulte a documentação do Oracle. Os nomes dos
                                   serviços podem ser encontrados executando
                                   o utilitário Oracle <return>lsnrctl status</return> na máquina do servidor de
                                   banco de dados.
                                   
                                   O arquivo tnsnames.ora pode estar no caminho de pesquisa Oracle
                                   Net,
                                   que
                                   inclui /seu/caminho/para/instantclient/network/admin,
                                   $ORACLE_HOME/network/admin
                                   e /etc. Como alternativa, defina <return>TNS_ADMIN</return>
                                   para que $TNS_ADMIN/tnsnames.ora possa ser lido. Certifique-se de
                                   que o servidor
                                   web tem acesso de leitura ao arquivo.
  <info>string</info>       <strong>$encoding</strong>           Determina
                                   o conjunto de caracteres usado pelas bibliotecas Oracle Client. O
                                   conjunto de
                                   caracteres não precisa corresponder ao conjunto de caracteres
                                   usado pelo banco de dados. Se
                                   não corresponderem, o Oracle fará o possível para converter os
                                   dados de e para
                                   o conjunto de caracteres do banco de dados. Dependendo dos
                                   conjuntos de caracteres, isso pode
                                   não fornecer resultados utilizáveis. A conversão também adiciona
                                   alguma sobrecarga de tempo.
                                   
                                   Se não for especificado, as
                                   bibliotecas Oracle Client determinam um conjunto de caracteres a
                                   partir da
                                   variável de ambiente <info>NLS_LANG</info>.
                                   
                                   Passar este parâmetro pode
                                   reduzir o tempo necessário para conectar.
  <info>int</info>          <strong>$session_mode</strong>       Este
                                   parâmetro está disponível a partir do PHP 5 (PECL OCI8 1.1) e
                                   aceita os
                                   seguintes valores: <info>OCI_DEFAULT</info>,
                                   <info>OCI_SYSOPER</info> e <info>OCI_SYSDBA</info>.
                                   Se <info>OCI_SYSOPER</info> ou
                                   <info>OCI_SYSDBA</info> forem especificadas, esta função tentará
                                   estabelecer uma conexão privilegiada usando credenciais externas.
                                   Conexões privilegiadas estão desabilitadas por padrão. Para
                                   habilitá-las
                                   é preciso configurar oci8.privileged_connect
                                   para <return>On</return>.
                                   
                                   O PHP 5.3 (PECL OCI8 1.3.4) introduziu o valor
                                   de modo <info>OCI_CRED_EXT</info>. Ele informa ao Oracle para usar
                                   autenticação External ou OS, que deve ser configurada no
                                   banco de dados. A flag <info>OCI_CRED_EXT</info> só pode ser usada
                                   com o usuário "/" e uma senha vazia.
                                   oci8.privileged_connect
                                   pode ser <return>On</return> ou <return>Off</return>.
                                   
                                   <info>OCI_CRED_EXT</info> pode ser combinado com os modos
                                   <info>OCI_SYSOPER</info> ou
                                   <info>OCI_SYSDBA</info>.
                                   
                                   <info>OCI_CRED_EXT</info> não é suportado no Windows por
                                   razões de segurança.

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

<comment>See Also:</comment>
   * <strong>oci_pconnect()</strong>
   * <strong>oci_new_connect()</strong>
   * <strong>oci_close()</strong>


id: oci_define_by_name
type: function
doc:
<comment>Description:</comment>
  Associates a PHP variable with a column for query fetches
  
  Associates a PHP variable with a column for query fetches using <strong>oci_fetch()</strong>.
  
  The <strong>oci_define_by_name()</strong> call must occur before executing <strong>oci_execute()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  Um identificador de declaração OCI8
                        válida criada por <strong>oci_parse()</strong> e executada
                        por <strong>oci_execute()</strong> ou um identificador de declaração <return>REF
                        CURSOR</return>.
  <info>string</info>    <strong>$column</strong>     The column name used in the query.
                        
                        Use uppercase for Oracle's default, non-case sensitive column names.  Use
                        the exact column name case for case-sensitive column names.
  <info>mixed</info>     <strong>$var</strong>        The PHP variable that will contain the returned column value.
  <info>int</info>       <strong>$type</strong>       The data type to be returned.  Generally not needed.  Note that Oracle-style
                        data conversions are not performed.  For example, <return>SQLT_INT</return> will be ignored
                        and the returned data type will still be <return>SQLT_CHR</return>.
                        
                        You can optionally use <strong>oci_new_descriptor()</strong> to allocate LOB/ROWID/BFILE
                        descriptors.

<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>oci_fetch()</strong>
   * <strong>oci_new_descriptor()</strong>


id: oci_error
type: function
doc:
<comment>Description:</comment>
  Returns the last error found
  
  Returns the last error found.
  
  The function should be called immediately after an error occurs. Errors are cleared by a
  successful statement.

<comment>Param:</comment>
  <info>resource|null</info>  <strong>$connection_or_statement</strong>  For most errors, <strong>$connection_or_statement</strong> is the resource
                                           handle that was passed to the failing function call. For
                                           connection errors with <strong>oci_connect()</strong>, <strong>oci_new_connect()</strong>
                                           or  <strong>oci_pconnect()</strong> <info>null</info> should be passed.

<comment>Return:</comment>
  <info>array|false</info>  If no error is found, <strong>oci_error()</strong> returns <info>false</info>. Otherwise, <strong>oci_error()</strong> returns the
               error information as an associative array.
               
               <strong>oci_error()</strong> Array DescriptionArray keyTypeDescrição<return>code</return><info>int</info> The Oracle error number.
               <return>message</return><info>string</info> The Oracle error text. <return>offset</return><info>int</info> The byte position of an error in the
               SQL statement.  If there was no statement, this is <return>0</return> <return>sqltext</return><info>string</info> The SQL statement
               text.  If there was no statement, this is an empty string.


id: oci_execute
type: function
doc:
<comment>Description:</comment>
  Executes a statement
  
  Executes a <strong>$statement</strong> previously returned from <strong>oci_parse()</strong>.
  
  After execution, statements like <return>INSERT</return> will have data committed to the database by default.  For
  statements like <return>SELECT</return>, execution performs the logic of the query. Query results can subsequently
  be fetched in PHP with functions like <strong>oci_fetch_array()</strong>.
  
  Each parsed statement may be executed multiple times, saving the cost of re-parsing.  This is
  commonly used for <return>INSERT</return> statements when data is bound with <strong>oci_bind_by_name()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  A valid OCI statement identifier.
  <info>int</info>       <strong>$mode</strong>       An optional second parameter can be one of the following constants:
                        Execution ModesConstantDescription<info>OCI_COMMIT_ON_SUCCESS</info>Automatically commit
                        all outstanding changes for this connection when the statement has
                        succeeded. This is the default.<info>OCI_DESCRIBE_ONLY</info>Make query meta data
                        available to functions like <strong>oci_field_name()</strong> but do not create a result set.
                        Any subsequent fetch call such as <strong>oci_fetch_array()</strong> will
                        fail.<info>OCI_NO_AUTO_COMMIT</info>Do not automatically commit changes.
                        
                        Using <info>OCI_NO_AUTO_COMMIT</info> mode starts or continues a transaction.
                        Transactions are automatically rolled back when the connection is closed, or
                        when the script ends.  Explicitly call <strong>oci_commit()</strong> to commit a transaction,
                        or <strong>oci_rollback()</strong> to abort it.
                        
                        When inserting or updating data, using transactions is recommended for
                        relational data consistency and for performance reasons.
                        
                        If <info>OCI_NO_AUTO_COMMIT</info> mode is used for any statement including queries, and
                        <strong>oci_commit()</strong> or <strong>oci_rollback()</strong> is not subsequently called, then OCI8 will
                        perform a rollback at the end of the script even if no data was changed.  To
                        avoid an unnecessary rollback, many scripts do not use <info>OCI_NO_AUTO_COMMIT</info>
                        mode for queries or PL/SQL.  Be careful to ensure the appropriate
                        transactional consistency for the application when using <strong>oci_execute()</strong> with
                        different modes in the same 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>oci_parse()</strong>


id: oci_fetch
type: function
doc:
<comment>Description:</comment>
  Fetches the next row from a query into internal buffers
  
  Fetches the next row from a query into internal buffers accessible either with <strong>oci_result()</strong>, or by
  using variables previously defined with <strong>oci_define_by_name()</strong>.
  
  See <strong>oci_fetch_array()</strong> for general information about fetching data.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  Um identificador de declaração OCI8
                        válida criada por <strong>oci_parse()</strong> e executada
                        por <strong>oci_execute()</strong> ou um identificador de declaração <return>REF
                        CURSOR</return>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> if there are no more rows in the <strong>$statement</strong>.

<comment>See Also:</comment>
   * <strong>oci_define_by_name()</strong>
   * <strong>oci_fetch_all()</strong>
   * <strong>oci_fetch_array()</strong>
   * <strong>oci_fetch_assoc()</strong>
   * <strong>oci_fetch_object()</strong>
   * <strong>oci_fetch_row()</strong>
   * <strong>oci_result()</strong>


id: oci_fetch_all
type: function
doc:
<comment>Description:</comment>
  Fetches multiple rows from a query into a two-dimensional array
  
  Fetches multiple rows from a query into a two-dimensional array. By default, all rows are
  returned.
  
  This function can be called only once for each query executed with <strong>oci_execute()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  Um identificador de declaração OCI8
                        válida criada por <strong>oci_parse()</strong> e executada
                        por <strong>oci_execute()</strong> ou um identificador de declaração <return>REF
                        CURSOR</return>.
  <info>array</info>     <strong>$output</strong>     The variable to contain the returned rows.
                        
                        LOB columns are returned as strings, where Oracle supports conversion.
                        
                        See <strong>oci_fetch_array()</strong> for more information on how data and types are
                        fetched.
  <info>int</info>       <strong>$offset</strong>     The number of initial rows to discard when fetching the result. The default
                        value is 0, so the first row onwards is returned.
  <info>int</info>       <strong>$limit</strong>      The number of rows to return.  The default is -1 meaning return all the rows
                        from <strong>$offset</strong> + 1 onwards.
  <info>int</info>       <strong>$flags</strong>      Parameter <strong>$flags</strong> indicates the array structure and whether associative
                        arrays should be used. <strong>oci_fetch_all()</strong> Array Structure
                        ModesConstantDescription<info>OCI_FETCHSTATEMENT_BY_ROW</info>The outer array will
                        contain one sub-array per query row.<info>OCI_FETCHSTATEMENT_BY_COLUMN</info>The outer
                        array will contain one sub-array per query column. This is the default.
                        
                        Arrays can be indexed either by column heading or numerically. Only one
                        index mode will be returned. <strong>oci_fetch_all()</strong> Array Index
                        ModesConstantDescription<info>OCI_NUM</info>Numeric indexes are used for each column's
                        array.<info>OCI_ASSOC</info>Associative indexes are used for each column's array. This is
                        the default.
                        
                        Use the addition operator "+" to choose a combination of array structure and
                        index modes.
                        
                        Oracle's default, non-case sensitive column names will have uppercase array
                        keys.  Case-sensitive column names will have array keys using the exact
                        column case. Use <strong>var_dump()</strong> on <strong>$output</strong> to verify the appropriate case to use
                        for each query.
                        
                        Queries that have more than one column with the same name should use column
                        aliases.  Otherwise only one of the columns will appear in an associative
                        array.

<comment>Return:</comment>
  <info>int</info>  Returns the number of rows in <strong>$output</strong>, which may be 0 or more.

<comment>See Also:</comment>
   * <strong>oci_fetch()</strong>
   * <strong>oci_fetch_array()</strong>
   * <strong>oci_fetch_assoc()</strong>
   * <strong>oci_fetch_object()</strong>
   * <strong>oci_fetch_row()</strong>
   * <strong>oci_set_prefetch()</strong>


id: oci_fetch_array
type: function
doc:
<comment>Description:</comment>
  Returns the next row from a query as an associative or numeric array
    
  
  Returns an array containing the next result-set row of a query. Each array entry corresponds to a
  column of the row.  This function is typically called in a loop until it returns <info>false</info>, indicating
  no more rows exist.
  
  If <strong>$statement</strong> corresponds to a PL/SQL block returning Oracle Database Implicit Result Sets, then
  rows from all sets are consecutively fetched. If <strong>$statement</strong> is returned by
  <strong>oci_get_implicit_resultset()</strong>, then only the subset of rows for one child query are returned.
  
  Para obter detalhes sobre o mapeamento dos tipos de dados realizado pela
  extensão OCI8, consulte os tipos de dados
  suportados pelo driver.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  Um identificador de declaração OCI8
                        válida criada por <strong>oci_parse()</strong> e executada
                        por <strong>oci_execute()</strong> ou um identificador de declaração <return>REF
                        CURSOR</return>.
                        
                        Can also be a statement identifier returned by <strong>oci_get_implicit_resultset()</strong>.
  <info>int</info>       <strong>$mode</strong>       An optional second parameter can be any combination of the following
                        constants: <strong>oci_fetch_array()</strong> ModesConstantDescription<info>OCI_BOTH</info>Returns an
                        array with both associative and numeric indices. This is the same as
                        <info>OCI_ASSOC</info> + <info>OCI_NUM</info> and is the default behavior.<info>OCI_ASSOC</info>Returns an
                        associative array.<info>OCI_NUM</info>Returns a numeric array.<info>OCI_RETURN_NULLS</info>Creates
                        elements for <info>null</info> fields.  The element values will be a PHP <info>null</info>.
                        <info>OCI_RETURN_LOBS</info>Returns the contents of LOBs instead of the LOB descriptors.
                        
                        The default <strong>$mode</strong> is <info>OCI_BOTH</info>.
                        
                        Use the addition operator "+" to specify more than one mode at a time.

<comment>Return:</comment>
  <info>array|false</info>  Returns an array with associative and/or numeric indices. If there are no more rows
               in the <strong>$statement</strong> then <info>false</info> is returned.
               
               By default, <return>LOB</return> columns are returned as LOB descriptors.
               
               <return>DATE</return> columns are returned as strings formatted to the current date format.  The
               default format can be changed with Oracle environment variables such as <return>NLS_LANG</return> or
               by a previously executed <return>ALTER SESSION SET NLS_DATE_FORMAT</return> command.
               
               Oracle's default, non-case sensitive column names will have uppercase associative
               indices in the result array.  Case-sensitive column names will have array indices
               using the exact column case. Use <strong>var_dump()</strong> on the result array to verify the
               appropriate case to use for each query.
               
               The table name is not included in the array index.  If your query contains two
               different columns with the same name, use <info>OCI_NUM</info> or add a column alias to the query
               to ensure name uniqueness, see example #7. Otherwise only one column will be returned
               via PHP.

<comment>See Also:</comment>
   * <strong>oci_fetch()</strong>
   * <strong>oci_fetch_all()</strong>
   * <strong>oci_fetch_assoc()</strong>
   * <strong>oci_fetch_object()</strong>
   * <strong>oci_fetch_row()</strong>
   * <strong>oci_set_prefetch()</strong>


id: oci_fetch_assoc
type: function
doc:
<comment>Description:</comment>
  Returns the next row from a query as an associative array
  
  Returns an associative array containing the next result-set row of a query. Each array entry
  corresponds to a column of the row.  This function is typically called in a loop until it returns
  <info>false</info>, indicating no more rows exist.
  
  Calling <strong>oci_fetch_assoc()</strong> is identical to calling <strong>oci_fetch_array()</strong> with <info>OCI_ASSOC</info> +
  <info>OCI_RETURN_NULLS</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  Um identificador de declaração OCI8
                        válida criada por <strong>oci_parse()</strong> e executada
                        por <strong>oci_execute()</strong> ou um identificador de declaração <return>REF
                        CURSOR</return>.

<comment>Return:</comment>
  <info>array|false</info>  Returns an associative array. If there are no more rows in the <strong>$statement</strong> then <info>false</info>
               is returned.

<comment>See Also:</comment>
   * <strong>oci_fetch()</strong>
   * <strong>oci_fetch_all()</strong>
   * <strong>oci_fetch_array()</strong>
   * <strong>oci_fetch_object()</strong>
   * <strong>oci_fetch_row()</strong>


id: oci_fetch_object
type: function
doc:
<comment>Description:</comment>
  Returns the next row from a query as an object
  
  Returns an object containing the next result-set row of a query. Each attribute of the object
  corresponds to a column of the row. This function is typically called in a loop until it returns
  <info>false</info>, indicating no more rows exist.
  
  Para obter detalhes sobre o mapeamento dos tipos de dados realizado pela
  extensão OCI8, consulte os tipos de dados
  suportados pelo driver.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  Um identificador de declaração OCI8
                        válida criada por <strong>oci_parse()</strong> e executada
                        por <strong>oci_execute()</strong> ou um identificador de declaração <return>REF
                        CURSOR</return>.

<comment>Return:</comment>
  <info>stdClass|false</info>  Returns an object.  Each attribute of the object corresponds to a column of the
                  row.  If there are no more rows in the <strong>$statement</strong> then <info>false</info> is returned.
                  
                  Any <return>LOB</return> columns are returned as LOB descriptors.
                  
                  <return>DATE</return> columns are returned as strings formatted to the current date format.  The
                  default format can be changed with Oracle environment variables such as <return>NLS_LANG</return>
                  or by a previously executed <return>ALTER SESSION SET NLS_DATE_FORMAT</return> command.
                  
                  Oracle's default, non-case sensitive column names will have uppercase attribute
                  names.  Case-sensitive column names will have attribute names using the exact
                  column case. Use <strong>var_dump()</strong> on the result object to verify the appropriate case
                  for attribute access.
                  
                  Attribute values will be <info>null</info> for any <return>NULL</return> data fields.

<comment>See Also:</comment>
   * <strong>oci_fetch()</strong>
   * <strong>oci_fetch_all()</strong>
   * <strong>oci_fetch_assoc()</strong>
   * <strong>oci_fetch_array()</strong>
   * <strong>oci_fetch_row()</strong>


id: oci_fetch_row
type: function
doc:
<comment>Description:</comment>
  Returns the next row from a query as a numeric array
  
  Returns a numerically indexed array containing the next result-set row of a query. Each array
  entry corresponds to a column of the row.  This function is typically called in a loop until it
  returns <info>false</info>, indicating no more rows exist.
  
  Calling <strong>oci_fetch_row()</strong> is identical to calling <strong>oci_fetch_array()</strong> with <info>OCI_NUM</info> + <info>OCI_RETURN_NULLS</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  Um identificador de declaração OCI8
                        válida criada por <strong>oci_parse()</strong> e executada
                        por <strong>oci_execute()</strong> ou um identificador de declaração <return>REF
                        CURSOR</return>.

<comment>Return:</comment>
  <info>array|false</info>  Returns a numerically indexed array.  If there are no more rows in the <strong>$statement</strong>
               then <info>false</info> is returned.

<comment>See Also:</comment>
   * <strong>oci_fetch()</strong>
   * <strong>oci_fetch_all()</strong>
   * <strong>oci_fetch_array()</strong>
   * <strong>oci_fetch_assoc()</strong>
   * <strong>oci_fetch_object()</strong>


id: oci_field_is_null
type: function
doc:
<comment>Description:</comment>
  Checks if a field in the currently fetched row is null
  
  Checks if the given <strong>$column</strong> from the current row of <strong>$statement</strong> is <info>null</info>.

<comment>Param:</comment>
  <info>resource</info>    <strong>$statement</strong>  A valid OCI statement identifier.
  <info>string|int</info>  <strong>$column</strong>     Can be the field's index (1-based) or name.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$column</strong> is <info>null</info>, <info>false</info> otherwise.


id: oci_field_name
type: function
doc:
<comment>Description:</comment>
  Returns the name of a field from the statement
  
  Returns the name of the <strong>$column</strong>.

<comment>Param:</comment>
  <info>resource</info>    <strong>$statement</strong>  A valid OCI statement identifier.
  <info>string|int</info>  <strong>$column</strong>     Can be the field's index (1-based) or name.

<comment>Return:</comment>
  <info>string|false</info>  Returns the name as a string, ou <info>false</info> em caso de falha

<comment>See Also:</comment>
   * <strong>oci_num_fields()</strong>
   * <strong>oci_field_type()</strong>
   * <strong>oci_field_size()</strong>


id: oci_field_precision
type: function
doc:
<comment>Description:</comment>
  Tell the precision of a field
  
  Returns precision of the <strong>$column</strong>.
  
  For FLOAT columns, precision is nonzero and scale is -127. If precision is 0, then column is
  NUMBER. Else it's NUMBER(precision, scale).

<comment>Param:</comment>
  <info>resource</info>    <strong>$statement</strong>  A valid OCI statement identifier.
  <info>string|int</info>  <strong>$column</strong>     Can be the field's index (1-based) or name.

<comment>Return:</comment>
  <info>int|false</info>  Returns the precision as an integer, ou <info>false</info> em caso de falha

<comment>See Also:</comment>
   * <strong>oci_field_scale()</strong>
   * <strong>oci_field_type()</strong>


id: oci_field_scale
type: function
doc:
<comment>Description:</comment>
  Tell the scale of the field
  
  Returns the scale of the column with <strong>$column</strong> index.
  
  For FLOAT columns, precision is nonzero and scale is -127. If precision is 0, then column is
  NUMBER. Else it's NUMBER(precision, scale).

<comment>Param:</comment>
  <info>resource</info>    <strong>$statement</strong>  A valid OCI statement identifier.
  <info>string|int</info>  <strong>$column</strong>     Can be the field's index (1-based) or name.

<comment>Return:</comment>
  <info>int|false</info>  Returns the scale as an integer, ou <info>false</info> em caso de falha

<comment>See Also:</comment>
   * <strong>oci_field_precision()</strong>
   * <strong>oci_field_type()</strong>


id: oci_field_size
type: function
doc:
<comment>Description:</comment>
  Returns field's size
  
  Returns the size of a <strong>$column</strong>.

<comment>Param:</comment>
  <info>resource</info>    <strong>$statement</strong>  A valid OCI statement identifier.
  <info>string|int</info>  <strong>$column</strong>     Can be the field's index (1-based) or name.

<comment>Return:</comment>
  <info>int|false</info>  Returns the size of a <strong>$column</strong> in bytes, ou <info>false</info> em caso de falha

<comment>See Also:</comment>
   * <strong>oci_num_fields()</strong>
   * <strong>oci_field_name()</strong>


id: oci_field_type
type: function
doc:
<comment>Description:</comment>
  Returns a field's data type name
  
  Returns a field's data type name.

<comment>Param:</comment>
  <info>resource</info>    <strong>$statement</strong>  A valid OCI statement identifier.
  <info>string|int</info>  <strong>$column</strong>     Can be the field's index (1-based) or name.

<comment>Return:</comment>
  <info>string|int|false</info>  Returns the field data type as a <info>string</info> or an <info>int</info>, ou <info>false</info> em caso de falha

<comment>See Also:</comment>
   * <strong>oci_num_fields()</strong>
   * <strong>oci_field_name()</strong>
   * <strong>oci_field_size()</strong>


id: oci_field_type_raw
type: function
doc:
<comment>Description:</comment>
  Tell the raw Oracle data type of the field
  
  Returns Oracle's raw "SQLT" data type of the <strong>$column</strong>.
  
  If you want a field's type name, then use <strong>oci_field_type()</strong> instead.

<comment>Param:</comment>
  <info>resource</info>    <strong>$statement</strong>  A valid OCI statement identifier.
  <info>string|int</info>  <strong>$column</strong>     Can be the field's index (1-based) or name.

<comment>Return:</comment>
  <info>int|false</info>  Returns Oracle's raw data type as a number, ou <info>false</info> em caso de falha


id: oci_free_descriptor
type: function
doc:
<comment>Description:</comment>
  Frees a descriptor
  
  Frees a descriptor allocated by <strong>oci_new_descriptor()</strong>.

<comment>Param:</comment>
  <info></info>  <strong>$descriptor</strong>  Descriptor allocated by <strong>oci_new_descriptor()</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>
   * OCILOB::free


id: oci_free_statement
type: function
doc:
<comment>Description:</comment>
  Frees all resources associated with statement or cursor
  
  Frees resources associated with Oracle's cursor or statement, which was received from as a result
  of <strong>oci_parse()</strong> or obtained from Oracle.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  A valid OCI statement identifier.

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


id: oci_get_implicit_resultset
type: function
doc:
<comment>Description:</comment>
  Returns the next child statement resource from a parent statement resource that has Oracle
  Database
  Implicit Result Sets
    
  
  Used to fetch consectutive sets of query results after the execution of a stored or anonymous
  Oracle PL/SQL block where that block returns query results with the Oracle Database 12 (or later)
  DBMS_SQL.RETURN_RESULT PL/SQL function.  This allows PL/SQL blocks to easily return query results.
  
  The child statement can be used with any of the OCI8 fetching functions: <strong>oci_fetch()</strong>,
  <strong>oci_fetch_all()</strong>, <strong>oci_fetch_array()</strong>, <strong>oci_fetch_object()</strong>, <strong>oci_fetch_assoc()</strong> or <strong>oci_fetch_row()</strong>
  
  Child statements inherit their parent statement's prefetch value, or it can be explicitly set with
  <strong>oci_set_prefetch()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  A valid OCI8 statement identifier created by <strong>oci_parse()</strong> and executed by
                        <strong>oci_execute()</strong>.  The statement identifier may or may not be associated with a
                        SQL statement that returns Implicit Result Sets.

<comment>Return:</comment>
  <info>resource|false</info>  Returns a statement handle for the next child statement available on <strong>$statement</strong>.
                  Returns <info>false</info> when child statements do not exist, or all child statements have
                  been returned by previous calls to <strong>oci_get_implicit_resultset()</strong>.


id: oci_internal_debug
type: function
doc:
<comment>Description:</comment>
  Enables or disables internal debug output
  
  Enables or disables internal debug output.

<comment>Param:</comment>
  <info>bool</info>  <strong>$onoff</strong>  Set this to <info>false</info> to turn debug output off or <info>true</info> to turn it on.

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


id: oci_lob_copy
type: function
doc:
<comment>Description:</comment>
  Copies large object
  
  Copies a large object or a part of a large object to another large object. Old LOB-recipient data
  will be overwritten.
  
  If you need to copy a particular part of a LOB to a particular position of a LOB, use
  <strong>OCILob::seek()</strong> to move LOB internal pointers.

<comment>Param:</comment>
  <info>OCILob</info>    <strong>$to</strong>      The destination LOB.
  <info>OCILob</info>    <strong>$from</strong>    The copied LOB.
  <info>int|null</info>  <strong>$length</strong>  Indicates the length of data to be copied.

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


id: oci_lob_is_equal
type: function
doc:
<comment>Description:</comment>
  Compares two LOB/FILE locators for equality
  
  Compares two LOB/FILE locators.

<comment>Param:</comment>
  <info>OCILob</info>  <strong>$lob1</strong>  A LOB identifier.
  <info>OCILob</info>  <strong>$lob2</strong>  A LOB identifier.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if these objects are equal, <info>false</info> otherwise.


id: oci_new_collection
type: function
doc:
<comment>Description:</comment>
  Allocates new collection object
  
  Allocates a new collection object.

<comment>Param:</comment>
  <info>resource</info>     <strong>$connection</strong>  An Oracle connection identifier, returned by  <strong>oci_connect()</strong> or
                            <strong>oci_pconnect()</strong>.
  <info>string</info>       <strong>$type_name</strong>   Should be a valid named type (uppercase).
  <info>string|null</info>  <strong>$schema</strong>      Should point to the scheme, where the named type was created. The name
                            of the current user is used when <info>null</info> is passed.

<comment>Return:</comment>
  <info>OCICollection|false</info>  Returns a new <class>OCICollection</class> object or <info>false</info> on error.


id: oci_new_connect
type: function
doc:
<comment>Description:</comment>
  Connect to the Oracle server using a unique connection
  
  Establishes a new connection to an Oracle server and logs on.
  
  Unlike <strong>oci_connect()</strong> and  <strong>oci_pconnect()</strong>, <strong>oci_new_connect()</strong> does not cache connections and will
  always return a brand-new freshly opened connection handle. This is useful if your application
  needs transactional isolation between two sets of queries.

<comment>Param:</comment>
  <info>string</info>       <strong>$username</strong>           The Oracle user name.
  <info>string</info>       <strong>$password</strong>           The password for <strong>$username</strong>.
  <info>string|null</info>  <strong>$connection_string</strong>  Contém
                                   a <return>instância do Oracle</return> à qual se conectar. Pode ser
                                   uma string Easy
                                   Connect ou um Connect Name do
                                   arquivo tnsnames.ora ou o nome de uma instância
                                   local do Oracle.
                                   
                                   Se não especificado ou <info>null</info>, o PHP usará
                                   variáveis de ambiente como <info>TWO_TASK</info> (no Linux)
                                   ou <info>LOCAL</info> (no Windows)
                                   e <info>ORACLE_SID</info> para determinar a
                                   <return>instância do Oracle</return> à qual se conectar.
                                   
                                   Para usar o método de nomenclatura Easy Connect, o PHP precisa
                                   ter sido compilado com as bibliotecas
                                   Oracle Client 10g ou superiores. A string Easy Connect para o
                                   Oracle
                                   10g tem o formato:
                                   [//]nome_do_servidor[:porta][/nome_do_servico]. A partir do
                                   Oracle
                                   11g a sintaxe é:
                                   
                                   [//]nome_do_servidor[:porta][/nome_do_servico][:tipo_de_servidor][/nome_da_instancia].
                                   Outras opções foram introduzidas com o Oracle 19c, incluindo as
                                   configurações de timeout
                                   e keep-alive. Consulte a documentação do Oracle. Os nomes dos
                                   serviços podem ser encontrados executando
                                   o utilitário Oracle <return>lsnrctl status</return> na máquina do servidor de
                                   banco de dados.
                                   
                                   O arquivo tnsnames.ora pode estar no caminho de pesquisa Oracle
                                   Net,
                                   que
                                   inclui /seu/caminho/para/instantclient/network/admin,
                                   $ORACLE_HOME/network/admin
                                   e /etc. Como alternativa, defina <return>TNS_ADMIN</return>
                                   para que $TNS_ADMIN/tnsnames.ora possa ser lido. Certifique-se de
                                   que o servidor
                                   web tem acesso de leitura ao arquivo.
  <info>string</info>       <strong>$encoding</strong>           Determina
                                   o conjunto de caracteres usado pelas bibliotecas Oracle Client. O
                                   conjunto de
                                   caracteres não precisa corresponder ao conjunto de caracteres
                                   usado pelo banco de dados. Se
                                   não corresponderem, o Oracle fará o possível para converter os
                                   dados de e para
                                   o conjunto de caracteres do banco de dados. Dependendo dos
                                   conjuntos de caracteres, isso pode
                                   não fornecer resultados utilizáveis. A conversão também adiciona
                                   alguma sobrecarga de tempo.
                                   
                                   Se não for especificado, as
                                   bibliotecas Oracle Client determinam um conjunto de caracteres a
                                   partir da
                                   variável de ambiente <info>NLS_LANG</info>.
                                   
                                   Passar este parâmetro pode
                                   reduzir o tempo necessário para conectar.
  <info>int</info>          <strong>$session_mode</strong>       Este
                                   parâmetro está disponível a partir do PHP 5 (PECL OCI8 1.1) e
                                   aceita os
                                   seguintes valores: <info>OCI_DEFAULT</info>,
                                   <info>OCI_SYSOPER</info> e <info>OCI_SYSDBA</info>.
                                   Se <info>OCI_SYSOPER</info> ou
                                   <info>OCI_SYSDBA</info> forem especificadas, esta função tentará
                                   estabelecer uma conexão privilegiada usando credenciais externas.
                                   Conexões privilegiadas estão desabilitadas por padrão. Para
                                   habilitá-las
                                   é preciso configurar oci8.privileged_connect
                                   para <return>On</return>.
                                   
                                   O PHP 5.3 (PECL OCI8 1.3.4) introduziu o valor
                                   de modo <info>OCI_CRED_EXT</info>. Ele informa ao Oracle para usar
                                   autenticação External ou OS, que deve ser configurada no
                                   banco de dados. A flag <info>OCI_CRED_EXT</info> só pode ser usada
                                   com o usuário "/" e uma senha vazia.
                                   oci8.privileged_connect
                                   pode ser <return>On</return> ou <return>Off</return>.
                                   
                                   <info>OCI_CRED_EXT</info> pode ser combinado com os modos
                                   <info>OCI_SYSOPER</info> ou
                                   <info>OCI_SYSDBA</info>.
                                   
                                   <info>OCI_CRED_EXT</info> não é suportado no Windows por
                                   razões de segurança.

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

<comment>See Also:</comment>
   * <strong>oci_connect()</strong>
   * <strong>oci_pconnect()</strong>


id: oci_new_cursor
type: function
doc:
<comment>Description:</comment>
  Allocates and returns a new cursor (statement handle)
  
  Allocates a new statement handle on the specified connection.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>  An Oracle connection identifier, returned by  <strong>oci_connect()</strong> or
                         <strong>oci_pconnect()</strong>.

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


id: oci_new_descriptor
type: function
doc:
<comment>Description:</comment>
  Initializes a new empty LOB or FILE descriptor
  
  Allocates resources to hold descriptor or LOB locator.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>  An Oracle connection identifier, returned by  <strong>oci_connect()</strong> or
                         <strong>oci_pconnect()</strong>.
  <info>int</info>       <strong>$type</strong>        Valid values for <strong>$type</strong> are:  <info>OCI_DTYPE_FILE</info>, <info>OCI_DTYPE_LOB</info> and
                         <info>OCI_DTYPE_ROWID</info>.

<comment>Return:</comment>
  <info>OCILob|null</info>  Returns a new LOB or FILE descriptor on success, or <info>null</info> on failure.

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


id: oci_num_fields
type: function
doc:
<comment>Description:</comment>
  Returns the number of result columns in a statement
  
  Gets the number of columns in the given <strong>$statement</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  A valid OCI statement identifier.

<comment>Return:</comment>
  <info>int</info>  Returns the number of columns as an <info>int</info>.


id: oci_num_rows
type: function
doc:
<comment>Description:</comment>
  Returns number of rows affected during statement execution
  
  Gets the number of rows affected during statement execution.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  A valid OCI statement identifier.

<comment>Return:</comment>
  <info>int|false</info>  Returns the number of rows affected as an integer, ou <info>false</info> em caso de falha


id: oci_parse
type: function
doc:
<comment>Description:</comment>
  Prepares an Oracle statement for execution
  
  Prepares <strong>$sql</strong> using <strong>$connection</strong> and returns the statement identifier, which can be used with
  <strong>oci_bind_by_name()</strong>,  <strong>oci_execute()</strong> and other functions.
  
  Statement identifiers can be freed with <strong>oci_free_statement()</strong> or by setting the variable to <info>null</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>  An Oracle connection identifier, returned by  <strong>oci_connect()</strong>,
                         <strong>oci_pconnect()</strong>, or <strong>oci_new_connect()</strong>.
  <info>string</info>    <strong>$sql</strong>         The SQL or PL/SQL statement.
                         
                         SQL statements should not end with a semi-colon (";").  PL/SQL statements
                         should end with a semi-colon (";").

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

<comment>See Also:</comment>
   * <strong>oci_execute()</strong>
   * <strong>oci_free_statement()</strong>


id: oci_password_change
type: function
doc:
<comment>Description:</comment>
  Changes password of Oracle's user
  
  Changes password for user with <strong>$username</strong>.
  
  The <strong>oci_password_change()</strong> function is most useful for PHP command-line scripts, or when
  non-persistent connections are used throughout the PHP application.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>     An Oracle connection identifier, returned by  <strong>oci_connect()</strong> or
                            <strong>oci_pconnect()</strong>.
  <info>string</info>    <strong>$username</strong>       The Oracle user name.
  <info>string</info>    <strong>$old_password</strong>   The old password.
  <info>string</info>    <strong>$new_password</strong>   The new password to be set.
  <info>string</info>    <strong>$database_name</strong>  The database name.

<comment>Return:</comment>
  <info>bool</info>  When <strong>$database_name</strong> is provided, <strong>oci_password_change()</strong> returns <info>true</info> on success, ou <info>false</info> em
        caso de falha. When <strong>$connection</strong> is provided, <strong>oci_password_change()</strong> returns the connection
        resource on success, ou <info>false</info> em caso de falha.


id: oci_pconnect
type: function
doc:
<comment>Description:</comment>
  Connect to an Oracle database using a persistent connection
  
  Creates a persistent connection to an Oracle server and logs on.
  
  Persistent connections are cached and re-used between requests, resulting in reduced overhead on
  each page load; a typical PHP application will have a single persistent connection open against an
  Oracle server per Apache child process (or PHP FPM process). See the OCI8 Connection Handling and
  Connection Pooling section for more information.

<comment>Param:</comment>
  <info>string</info>       <strong>$username</strong>           The Oracle user name.
  <info>string</info>       <strong>$password</strong>           The password for <strong>$username</strong>.
  <info>string|null</info>  <strong>$connection_string</strong>  Contém
                                   a <return>instância do Oracle</return> à qual se conectar. Pode ser
                                   uma string Easy
                                   Connect ou um Connect Name do
                                   arquivo tnsnames.ora ou o nome de uma instância
                                   local do Oracle.
                                   
                                   Se não especificado ou <info>null</info>, o PHP usará
                                   variáveis de ambiente como <info>TWO_TASK</info> (no Linux)
                                   ou <info>LOCAL</info> (no Windows)
                                   e <info>ORACLE_SID</info> para determinar a
                                   <return>instância do Oracle</return> à qual se conectar.
                                   
                                   Para usar o método de nomenclatura Easy Connect, o PHP precisa
                                   ter sido compilado com as bibliotecas
                                   Oracle Client 10g ou superiores. A string Easy Connect para o
                                   Oracle
                                   10g tem o formato:
                                   [//]nome_do_servidor[:porta][/nome_do_servico]. A partir do
                                   Oracle
                                   11g a sintaxe é:
                                   
                                   [//]nome_do_servidor[:porta][/nome_do_servico][:tipo_de_servidor][/nome_da_instancia].
                                   Outras opções foram introduzidas com o Oracle 19c, incluindo as
                                   configurações de timeout
                                   e keep-alive. Consulte a documentação do Oracle. Os nomes dos
                                   serviços podem ser encontrados executando
                                   o utilitário Oracle <return>lsnrctl status</return> na máquina do servidor de
                                   banco de dados.
                                   
                                   O arquivo tnsnames.ora pode estar no caminho de pesquisa Oracle
                                   Net,
                                   que
                                   inclui /seu/caminho/para/instantclient/network/admin,
                                   $ORACLE_HOME/network/admin
                                   e /etc. Como alternativa, defina <return>TNS_ADMIN</return>
                                   para que $TNS_ADMIN/tnsnames.ora possa ser lido. Certifique-se de
                                   que o servidor
                                   web tem acesso de leitura ao arquivo.
  <info>string</info>       <strong>$encoding</strong>           Determina
                                   o conjunto de caracteres usado pelas bibliotecas Oracle Client. O
                                   conjunto de
                                   caracteres não precisa corresponder ao conjunto de caracteres
                                   usado pelo banco de dados. Se
                                   não corresponderem, o Oracle fará o possível para converter os
                                   dados de e para
                                   o conjunto de caracteres do banco de dados. Dependendo dos
                                   conjuntos de caracteres, isso pode
                                   não fornecer resultados utilizáveis. A conversão também adiciona
                                   alguma sobrecarga de tempo.
                                   
                                   Se não for especificado, as
                                   bibliotecas Oracle Client determinam um conjunto de caracteres a
                                   partir da
                                   variável de ambiente <info>NLS_LANG</info>.
                                   
                                   Passar este parâmetro pode
                                   reduzir o tempo necessário para conectar.
  <info>int</info>          <strong>$session_mode</strong>       Este
                                   parâmetro está disponível a partir do PHP 5 (PECL OCI8 1.1) e
                                   aceita os
                                   seguintes valores: <info>OCI_DEFAULT</info>,
                                   <info>OCI_SYSOPER</info> e <info>OCI_SYSDBA</info>.
                                   Se <info>OCI_SYSOPER</info> ou
                                   <info>OCI_SYSDBA</info> forem especificadas, esta função tentará
                                   estabelecer uma conexão privilegiada usando credenciais externas.
                                   Conexões privilegiadas estão desabilitadas por padrão. Para
                                   habilitá-las
                                   é preciso configurar oci8.privileged_connect
                                   para <return>On</return>.
                                   
                                   O PHP 5.3 (PECL OCI8 1.3.4) introduziu o valor
                                   de modo <info>OCI_CRED_EXT</info>. Ele informa ao Oracle para usar
                                   autenticação External ou OS, que deve ser configurada no
                                   banco de dados. A flag <info>OCI_CRED_EXT</info> só pode ser usada
                                   com o usuário "/" e uma senha vazia.
                                   oci8.privileged_connect
                                   pode ser <return>On</return> ou <return>Off</return>.
                                   
                                   <info>OCI_CRED_EXT</info> pode ser combinado com os modos
                                   <info>OCI_SYSOPER</info> ou
                                   <info>OCI_SYSDBA</info>.
                                   
                                   <info>OCI_CRED_EXT</info> não é suportado no Windows por
                                   razões de segurança.

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

<comment>See Also:</comment>
   * <strong>oci_connect()</strong>
   * <strong>oci_new_connect()</strong>


id: oci_register_taf_callback
type: function
doc:
<comment>Description:</comment>
  Register a user-defined callback function for Oracle Database TAF
  
  Registers a user-defined callback function to <strong>$connection</strong>. If <strong>$connection</strong> fails due to instance or
  network failure, the registered callback function will be invoked for several times during
  failover. See OCI8 Transparent Application Failover (TAF) Support for information.
  
  When <strong>oci_register_taf_callback()</strong> is called multiple times, each registration overwrites the
  previous one.
  
  Use <strong>oci_unregister_taf_callback()</strong> to explicitly unregister a user-defined callback.
  
  TAF callback registration will NOT be saved across persistent connections, therefore the callback
  needs to be re-registered for a new persistent connection.

<comment>Param:</comment>
  <info>resource</info>       <strong>$connection</strong>  An Oracle connection identifier.
  <info>callable|null</info>  <strong>$callback</strong>    A user-defined callback to register for Oracle TAF. It can be a string
                              of the function name or a Closure (anonymous function).
                              
                              The interface of a TAF user-defined callback function is as follows:
                              
                              See the parameter description and an example on  OCI8 Transparent
                              Application Failover (TAF) Support page.

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


id: oci_result
type: function
doc:
<comment>Description:</comment>
  Returns field's value from the fetched row
  
  Returns the data from <strong>$column</strong> in the current row, fetched by <strong>oci_fetch()</strong>.
  
  Para obter detalhes sobre o mapeamento dos tipos de dados realizado pela
  extensão OCI8, consulte os tipos de dados
  suportados pelo driver.

<comment>Param:</comment>
  <info>resource</info>    <strong>$statement</strong>  
  <info>string|int</info>  <strong>$column</strong>     Can be either use the column number (1-based) or the column name. The case
                          of the column name must be the case that Oracle meta data describes the
                          column as, which is uppercase for columns created case insensitively.

<comment>Return:</comment>
  <info>mixed</info>  Returns everything as strings except for abstract types (ROWIDs, LOBs and FILEs). Returns
         <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>oci_fetch_array()</strong>
   * <strong>oci_fetch_assoc()</strong>
   * <strong>oci_fetch_object()</strong>
   * <strong>oci_fetch_row()</strong>
   * <strong>oci_fetch_all()</strong>


id: oci_rollback
type: function
doc:
<comment>Description:</comment>
  Rolls back the outstanding database transaction
  
  Reverts all uncommitted changes for the Oracle <strong>$connection</strong> and ends the transaction.  It releases
  all locks held.  All Oracle <return>SAVEPOINTS</return> are erased.
  
  A transaction begins when the first SQL statement that changes data is executed with <strong>oci_execute()</strong>
  using the <info>OCI_NO_AUTO_COMMIT</info> flag.  Further data changes made by other statements become part of
  the same transaction.  Data changes made in a transaction are temporary until the transaction is
  committed or rolled back.  Other users of the database will not see the changes until they are
  committed.
  
  When inserting or updating data, using transactions is recommended for relational data consistency
  and for performance reasons.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>  An Oracle connection identifier, returned by <strong>oci_connect()</strong>, <strong>oci_pconnect()</strong>
                         or <strong>oci_new_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>oci_commit()</strong>
   * <strong>oci_execute()</strong>


id: oci_server_version
type: function
doc:
<comment>Description:</comment>
  Returns the Oracle Database version
  
  Returns a string with the Oracle Database version and available options

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

<comment>Return:</comment>
  <info>string|false</info>  Returns the version information as a string or <info>false</info> on error.

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


id: oci_set_action
type: function
doc:
<comment>Description:</comment>
  Sets the action name
  
  Sets the action name for Oracle tracing.
  
  The action name is registered with the database when the next 'round-trip' from PHP to the
  database occurs, typically when an SQL statement is executed.
  
  The action name can subsequently be queried from database administration views such as <return>V$SESSION</return>.
  It can be used for tracing and monitoring such as with <return>V$SQLAREA</return> and
  <return>DBMS_MONITOR.SERV_MOD_ACT_STAT_ENABLE</return>.
  
  The value may be retained across persistent connections.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>  Um identificador de conexão Oracle,
                         retornado por <strong>oci_connect()</strong>, <strong>oci_pconnect()</strong>
                         ou <strong>oci_new_connect()</strong>.
  <info>string</info>    <strong>$action</strong>      User chosen string up to 32 bytes long.

<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>oci_set_module_name()</strong>
   * <strong>oci_set_client_info()</strong>
   * <strong>oci_set_client_identifier()</strong>
   * <strong>oci_set_db_operation()</strong>


id: oci_set_call_timeout
type: function
doc:
<comment>Description:</comment>
  Sets a millisecond timeout for database calls
  
  Sets a timeout limiting the maxium time a database round-trip using this connection may take.
  
  Each OCI8 operation may make zero or more calls to Oracle's client library.  These internal calls
  may then may make zero or more round-trips to Oracle Database.  If any one of those round-trips
  takes more than <return>time_out</return> milliseconds, then the operation is cancelled and an error is returned to
  the application.
  
  The <return>time_out</return> value applies to each round-trip individually, not to the sum of all round-trips.
  Time spent processing in PHP OCI8 before or after the completion of each round-trip is not
  counted.
  
  When a call is interrupted, Oracle will attempt to clean up the connection for reuse.  This
  operation is allowed to run for another <return>time_out</return> period.  Depending on the outcome of the cleanup,
  the connection may or may not be reusable.
  
  When persistent connections are used, the timeout value will be retained across PHP requests.
  
  The <strong>oci_set_call_timeout()</strong> function is available when OCI8 uses Oracle 18 (or later) Client
  libraries.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>  Um identificador de conexão Oracle,
                         retornado por <strong>oci_connect()</strong>, <strong>oci_pconnect()</strong>
                         ou <strong>oci_new_connect()</strong>.
  <info>int</info>       <strong>$timeout</strong>     The maximum time in milliseconds that any single round-trip between PHP and
                         Oracle Database may take.

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


id: oci_set_client_identifier
type: function
doc:
<comment>Description:</comment>
  Sets the client identifier
  
  Sets the client identifier used by various database components to identify lightweight application
  users who authenticate as the same database user.
  
  The client identifier is registered with the database when the next 'round-trip' from PHP to the
  database occurs, typically when an SQL statement is executed.
  
  The identifier can subsequently be queried, for example with <return>SELECT
  SYS_CONTEXT('USERENV','CLIENT_IDENTIFIER') FROM DUAL</return>.  Database administration views such as
  <return>V$SESSION</return> will also contain the value.  It can be used with <return>DBMS_MONITOR.CLIENT_ID_TRACE_ENABLE</return>
  for tracing and can also be used for auditing.
  
  The value may be retained across page requests that use the same persistent connection.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>  Um identificador de conexão Oracle,
                         retornado por <strong>oci_connect()</strong>, <strong>oci_pconnect()</strong>
                         ou <strong>oci_new_connect()</strong>.
  <info>string</info>    <strong>$client_id</strong>   User chosen string up to 64 bytes long.

<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>oci_set_module_name()</strong>
   * <strong>oci_set_action()</strong>
   * <strong>oci_set_client_info()</strong>
   * <strong>oci_set_db_operation()</strong>


id: oci_set_client_info
type: function
doc:
<comment>Description:</comment>
  Sets the client information
  
  Sets the client information for Oracle tracing.
  
  The client information is registered with the database when the next 'round-trip' from PHP to the
  database occurs, typically when an SQL statement is executed.
  
  The client information can subsequently be queried from database  administration views such as
  <return>V$SESSION</return>.
  
  The value may be retained across persistent connections.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>   Um identificador de conexão Oracle,
                          retornado por <strong>oci_connect()</strong>, <strong>oci_pconnect()</strong>
                          ou <strong>oci_new_connect()</strong>.
  <info>string</info>    <strong>$client_info</strong>  User chosen string up to 64 bytes long.

<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>oci_set_module_name()</strong>
   * <strong>oci_set_action()</strong>
   * <strong>oci_set_client_identifier()</strong>
   * <strong>oci_set_db_operation()</strong>


id: oci_set_db_operation
type: function
doc:
<comment>Description:</comment>
  Sets the database operation
  
  Sets the DBOP for Oracle tracing.
  
  The database operation name is registered with the database when the next 'round-trip' from PHP to
  the database occurs, typically when a SQL statement is executed.
  
  The database operation can subsequently be queried from database administration views such as
  <return>V$SQL_MONITOR</return>.
  
  The <strong>oci_set_db_operation()</strong> function is available when OCI8 uses Oracle 12 (or later) Client
  libraries and Oracle Database 12 (or later).

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>  Um identificador de conexão Oracle,
                         retornado por <strong>oci_connect()</strong>, <strong>oci_pconnect()</strong>
                         ou <strong>oci_new_connect()</strong>.
  <info>string</info>    <strong>$action</strong>      User chosen string.

<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>oci_set_action()</strong>
   * <strong>oci_set_module_name()</strong>
   * <strong>oci_set_client_info()</strong>
   * <strong>oci_set_client_identifier()</strong>


id: oci_set_edition
type: function
doc:
<comment>Description:</comment>
  Sets the database edition
  
  Sets the database "edition" of objects to be used by a subsequent connections.
  
  Oracle Editions allow concurrent versions of applications to run using the same schema and object
  names.  This is useful for upgrading live systems.
  
  Call <strong>oci_set_edition()</strong> before calling <strong>oci_connect()</strong>, <strong>oci_pconnect()</strong> or <strong>oci_new_connect()</strong>.
  
  If an edition is set that is not valid in the database, connection will fail even if
  <strong>oci_set_edition()</strong> returns success.
  
  When using persistent connections, if a connection with the requested edition setting already
  exists, it is reused.  Otherwise, a different persistent connection is created

<comment>Param:</comment>
  <info>string</info>  <strong>$edition</strong>  Oracle Database edition name previously created with the SQL "<return>CREATE EDITION</return>"
                    command.

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


id: oci_set_module_name
type: function
doc:
<comment>Description:</comment>
  Sets the module name
  
  Sets the module name for Oracle tracing.
  
  The module name is registered with the database when the next 'round-trip' from PHP to the
  database occurs, typically when an SQL statement is executed.
  
  The name can subsequently be queried from database administration views such as <return>V$SESSION</return>.  It can
  be used for tracing and monitoring such as with <return>V$SQLAREA</return> and
  <return>DBMS_MONITOR.SERV_MOD_ACT_STAT_ENABLE</return>.
  
  The value may be retained across persistent connections.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>  Um identificador de conexão Oracle,
                         retornado por <strong>oci_connect()</strong>, <strong>oci_pconnect()</strong>
                         ou <strong>oci_new_connect()</strong>.
  <info>string</info>    <strong>$name</strong>        User chosen <info>string</info> up to 48 bytes long.

<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>oci_set_action()</strong>
   * <strong>oci_set_client_info()</strong>
   * <strong>oci_set_client_identifier()</strong>
   * <strong>oci_set_db_operation()</strong>


id: oci_set_prefetch
type: function
doc:
<comment>Description:</comment>
  Sets number of rows to be prefetched by queries
  
  Sets the number of rows to be buffered by the Oracle Client libraries after a successful query
  call to <strong>oci_execute()</strong> and for each subsequent internal fetch request to the database.  For queries
  returning a large number of rows, performance can be significantly improved by increasing the
  prefetch count above the default oci8.default_prefetch value.
  
  Prefetching is Oracle's efficient way of returning more than one data row from the database in
  each network request.  This can result in better network and CPU utilization.  The buffering of
  rows is internal to OCI8 and the behavior of OCI8 fetching functions is unchanged regardless of
  the prefetch count. For example, <strong>oci_fetch_row()</strong> will always return one row.  The prefetch buffer
  is per-statement and is not used by re-executed statements or by other connections.
  
  Call <strong>oci_set_prefetch()</strong> before calling <strong>oci_execute()</strong>.
  
  A tuning goal is to set the prefetch value to a reasonable size for the network and database to
  handle.  For queries returning a very large number of rows, overall system efficiency might be
  better if rows are retrieved from the database in several chunks (i.e set the prefetch value
  smaller than the number of rows).  This allows the database to handle other users' statements
  while the PHP script is processing the current set of rows.
  
  Query prefetching was introduced in Oracle 8i.  REF CURSOR prefetching was introduced in Oracle
  11gR2 and occurs when PHP is linked with Oracle 11gR2 (or later) Client libraries. Nested cursor
  prefetching was introduced in Oracle 11gR2 and requires both the Oracle Client libraries and the
  database to be version 11gR2 or greater.
  
  Prefetching is not supported when queries contain LONG or LOB columns.  The prefetch value is
  ignored and single-row fetches will be used in all the situations when prefetching is not
  supported.
  
  When using Oracle Database 12c, the prefetch value set by PHP can be overridden by Oracle's client
  <return>oraaccess.xml</return> configuration file.  Refer to Oracle documentation for more detail.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  Um identificador de declaração OCI8
                        válida criada por <strong>oci_parse()</strong> e executada
                        por <strong>oci_execute()</strong> ou um identificador de declaração <return>REF
                        CURSOR</return>.
  <info>int</info>       <strong>$rows</strong>       The number of rows to be prefetched, &gt;= 0

<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>
   * oci8.default_prefetch
     ini option
    


id: oci_set_prefetch_lob
type: function
doc:
<comment>Description:</comment>
  Sets the amount of data prefetched for each CLOB or BLOB.
  
  Sets the internal buffer size used to fetch each CLOB or BLOB value when the implementation gets
  the internal Oracle LOB locator from the database after a successful query call to <strong>oci_execute()</strong>
  and for each subsequent internal fetch request to the database.  Increasing this value can improve
  the performance of fetching smaller LOBs by reducing round-trips between PHP and the database.
  Memory usage will change.
  
  The value affects LOBs returned as OCILob instances and also those returned using <info>OCI_RETURN_LOBS</info>.
  
  Call <strong>oci_set_prefetch_lob()</strong> before calling <strong>oci_execute()</strong>.  If it is not called, the value of
  oci8.prefetch_lob_size is used.
  
  The LOB prefetch value should only be set with Oracle Database 12.2 or later.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>          Um identificador de declaração OCI8
                                válida criada por <strong>oci_parse()</strong> e executada
                                por <strong>oci_execute()</strong> ou um identificador de declaração <return>REF
                                CURSOR</return>.
  <info>int</info>       <strong>$prefetch_lob_size</strong>  The number of bytes of each LOB to be prefetched, &gt;= 0

<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>
   * oci8.prefetch_lob_size
     ini option
    


id: oci_statement_type
type: function
doc:
<comment>Description:</comment>
  Returns the type of a statement
  
  Returns a keyword identifying the type of the OCI8 <strong>$statement</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  A valid OCI8 statement identifier from <strong>oci_parse()</strong>.

<comment>Return:</comment>
  <info>string|false</info>  Returns the type of <strong>$statement</strong> as one of the following strings. Statement typeReturn
                StringNotes<return>ALTER</return><return>BEGIN</return><return>CALL</return><return>CREATE</return><return>DECLARE</return><return>DELETE</return><return>DROP</return><return>INSERT</return><return>SELECT</return><return>UPDATE</return><return>UNKNOWN</return>
                
                Returns <info>false</info> on error.


id: oci_unregister_taf_callback
type: function
doc:
<comment>Description:</comment>
  Unregister a user-defined callback function for Oracle Database TAF
  
  Unregister the user-defined callback function registered to <strong>$connection </strong> by
  <strong>oci_register_taf_callback()</strong>. See OCI8 Transparent Application Failover (TAF) Support  for
  information.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>  An Oracle connection identifier.

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


id: ocibindbyname
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_bind_by_name
  
  Sinônimo de <strong>oci_bind_by_name()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicancel
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_cancel
  
  Sinônimo de <strong>oci_cancel()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicloselob
type: function
doc:
<comment>Description:</comment>
  Sinônimo de OCILob::close
  
  Sinônimo de <strong>OCILob::close()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicollappend
type: function
doc:
<comment>Description:</comment>
  Sinônimo de OCICollection::append
  
  Sinônimo de <strong>OCICollection::append()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicollassign
type: function
doc:
<comment>Description:</comment>
  Sinônimo de OCICollection::assign
  
  Sinônimo de <strong>OCICollection::assign()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicollassignelem
type: function
doc:
<comment>Description:</comment>
  Sinônimo de OCICollection::assignElem
  
  Sinônimo de <strong>OCICollection::assignElem()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicollgetelem
type: function
doc:
<comment>Description:</comment>
  Sinônimo de OCICollection::getElem
  
  Sinônimo de <strong>OCICollection::getElem()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicollmax
type: function
doc:
<comment>Description:</comment>
  Sinônimo de OCICollection::max
  
  Sinônimo de <strong>OCICollection::max()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicollsize
type: function
doc:
<comment>Description:</comment>
  Sinônimo de OCICollection::size
  
  Sinônimo de <strong>OCICollection::size()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicolltrim
type: function
doc:
<comment>Description:</comment>
  Sinônimo de OCICollection::trim
  
  Sinônimo de <strong>OCICollection::trim()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicolumnisnull
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_field_is_null
  
  Sinônimo de <strong>oci_field_is_null()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicolumnname
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_field_name
  
  Sinônimo de <strong>oci_field_name()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicolumnprecision
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_field_precision
  
  Sinônimo de <strong>oci_field_precision()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicolumnscale
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_field_scale
  
  Sinônimo de <strong>oci_field_scale()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicolumnsize
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_field_size
  
  Sinônimo de <strong>oci_field_size()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicolumntype
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_field_type
  
  Sinônimo de <strong>oci_field_type()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicolumntyperaw
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_field_type_raw
  
  Sinônimo de <strong>oci_field_type_raw()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocicommit
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_commit
  
  Sinônimo de <strong>oci_commit()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocidefinebyname
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_define_by_name
  
  Sinônimo de <strong>oci_define_by_name()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocierror
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_error
  
  Sinônimo de <strong>oci_error()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ociexecute
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_execute
  
  Sinônimo de <strong>oci_execute()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocifetch
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_fetch
  
  Sinônimo de <strong>oci_fetch()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocifetchinto
type: function
doc:
<comment>Description:</comment>
  Variante obsoleta de oci_fetch_array, oci_fetch_object,
     oci_fetch_assoc e
     oci_fetch_row
  
  Variante obsoleta de <strong>oci_fetch_array()</strong>, <strong>oci_fetch_object()</strong>, <strong>oci_fetch_assoc()</strong> e <strong>oci_fetch_row()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocifetchstatement
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_fetch_all
  
  Sinônimo de <strong>oci_fetch_all()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocifreecollection
type: function
doc:
<comment>Description:</comment>
  Sinônimo de OCICollection::free
  
  Sinônimo de <strong>OCICollection::free()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocifreecursor
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_free_statement
  
  Sinônimo de <strong>oci_free_statement()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocifreedesc
type: function
doc:
<comment>Description:</comment>
  Sinônimo de OCILob::free
  
  Sinônimo de <strong>OCILob::free()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ociinternaldebug
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_internal_debug
  
  Sinônimo de <strong>oci_internal_debug()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ociloadlob
type: function
doc:
<comment>Description:</comment>
  Sinônimo de OCILob::load
  
  Sinônimo de <strong>OCILob::load()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocilogoff
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_close
  
  Sinônimo de <strong>oci_close()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocilogon
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_connect
  
  Sinônimo de <strong>oci_connect()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocinewcollection
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_new_collection
  
  Sinônimo de <strong>oci_new_collection()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocinewcursor
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_new_cursor
  
  Sinônimo de <strong>oci_new_cursor()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocinewdescriptor
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_new_descriptor
  
  Sinônimo de <strong>oci_new_descriptor()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocinlogon
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_new_connect
  
  Sinônimo de <strong>oci_new_connect()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocinumcols
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_num_fields
  
  Sinônimo de <strong>oci_num_fields()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ociparse
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_parse
  
  Sinônimo de <strong>oci_parse()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ociplogon
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_pconnect
  
  Sinônimo de <strong>oci_pconnect()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ociresult
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_result
  
  Sinônimo de <strong>oci_result()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocirollback
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_rollback
  
  Sinônimo de <strong>oci_rollback()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocirowcount
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_num_rows
  
  Sinônimo de <strong>oci_num_rows()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocisavelob
type: function
doc:
<comment>Description:</comment>
  Sinônimo de OCILob::save
  
  Sinônimo de <strong>OCILob::save()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocisavelobfile
type: function
doc:
<comment>Description:</comment>
  Sinônimo de OCILob::import
  
  Sinônimo de <strong>OCILob::import()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ociserverversion
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_server_version
  
  Sinônimo de <strong>oci_server_version()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocisetprefetch
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_set_prefetch
  
  Sinônimo de <strong>oci_set_prefetch()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ocistatementtype
type: function
doc:
<comment>Description:</comment>
  Sinônimo de oci_statement_type
  
  Sinônimo de <strong>oci_statement_type()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ociwritelobtofile
type: function
doc:
<comment>Description:</comment>
  Sinônimo de OCILob::export
  
  Sinônimo de <strong>OCILob::export()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: ociwritetemporarylob
type: function
doc:
<comment>Description:</comment>
  Sinônimo de OCILob::writeTemporary
  
  Sinônimo de <strong>OCILob::writeTemporary()</strong>
  
  Este apelido tornou-se OBSOLETO a partir do PHP 5.4.0. O uso
  deste apelido é fortemente desencorajado.


id: octdec
type: function
doc:
<comment>Description:</comment>
  Octal para decimal
  
  Retorna o decimal equivalente do número octal representado pelo argumento <strong>$octal_string</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$octal_string</strong>  A string octal a ser convertida. Quaisquer caracteres inválidos em
                         <strong>$octal_string</strong> são ignorados silenciosamente. A partir do PHP 7.4.0,
                         informar caracteres inválidos está defasado.

<comment>Return:</comment>
  <info>int|float</info>  A representação decimal de <strong>$octal_string</strong>

<comment>See Also:</comment>
   * <strong>decoct()</strong>
   * <strong>bindec()</strong>
   * <strong>hexdec()</strong>
   * <strong>base_convert()</strong>


id: odbc_autocommit
type: function
doc:
<comment>Description:</comment>
  Toggle autocommit behaviour
  
  Toggles autocommit behaviour.
  
  By default, auto-commit is on for a connection.  Disabling auto-commit is equivalent with starting
  a transaction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$odbc</strong>    O identificador da conexão ODBC.
                     Consulte <strong>odbc_connect()</strong> para obter detalhes.
  <info>bool</info>      <strong>$enable</strong>  If <strong>$enable</strong> is <info>true</info>, auto-commit is enabled, if it is <info>false</info> auto-commit is
                     disabled. If <info>null</info> is passed, this function returns the auto-commit status for
                     <strong>$odbc</strong>.

<comment>Return:</comment>
  <info>int|bool</info>  Without the <strong>$enable</strong> parameter, this function returns auto-commit status for <strong>$odbc</strong>.
            Non-zero is returned if auto-commit is on, 0 if it is off, or <info>false</info> if an error occurs.
            
            If <strong>$enable</strong> is set, this function returns <info>true</info> on success and <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>odbc_commit()</strong>
   * <strong>odbc_rollback()</strong>


id: odbc_binmode
type: function
doc:
<comment>Description:</comment>
  Handling of binary column data
  
  Controls handling of binary column data. ODBC SQL types affected are <return>BINARY</return>, <return>VARBINARY</return>, and
  <return>LONGVARBINARY</return>. The default mode can be set using the uodbc.defaultbinmode php.ini directive.
  
  When binary SQL data is converted to character C data (<info>ODBC_BINMODE_CONVERT</info>), each byte (8 bits)
  of source data is represented as two ASCII characters. These characters are the ASCII character
  representation of the number in its hexadecimal form. For example, a binary <return>00000001</return> is converted
  to <return>"01"</return> and a binary <return>11111111</return> is converted to <return>"FF"</return>.
  
  While the handling of <return>BINARY</return> and <return>VARBINARY</return> columns only depend on the binmode, the handling of
  <return>LONGVARBINARY</return> columns also depends on the longreadlen as well: LONGVARBINARY
  handlingbinmodelongreadlenresult<info>ODBC_BINMODE_PASSTHRU</info>0passthru<info>ODBC_BINMODE_RETURN</info>0passthru<info>ODBC_BINMODE_CONVERT</info>0passthru<info>ODBC_BINMODE_PASSTHRU</info>&gt;0passthru<info>ODBC_BINMODE_RETURN</info>&gt;0return
  as is<info>ODBC_BINMODE_CONVERT</info>&gt;0return as char
  
  If <strong>odbc_fetch_into()</strong> is used, passthru means that an empty string is returned for these columns.
  If <strong>odbc_result()</strong> is used, passthru means that the data are sent directly to the client (i.e.
  printed).

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  The result identifier.
                        
                        If <strong>$statement</strong> is <return>0</return>, the settings apply as default for new results.
  <info>int</info>       <strong>$mode</strong>       Possible values for <strong>$mode</strong> are: <info>ODBC_BINMODE_PASSTHRU</info>: Passthru BINARY data
                        <info>ODBC_BINMODE_RETURN</info>: Return as is <info>ODBC_BINMODE_CONVERT</info>: Convert to char and
                        return   Handling of binary long columns is also affected by
                        <strong>odbc_longreadlen()</strong>.
                        
                        <info>ODBC_BINMODE_PASSTHRU</info>: Passthru BINARY data
                        
                        <info>ODBC_BINMODE_RETURN</info>: Return as is
                        
                        <info>ODBC_BINMODE_CONVERT</info>: Convert to char and return
                        
                        Handling of binary long columns is also affected by <strong>odbc_longreadlen()</strong>.

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


id: odbc_close
type: function
doc:
<comment>Description:</comment>
  Close an ODBC connection
  
  Closes down the connection to the database server.

<comment>Param:</comment>
  <info>resource</info>  <strong>$odbc</strong>  O identificador da conexão ODBC.
                   Consulte <strong>odbc_connect()</strong> para obter detalhes.

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


id: odbc_close_all
type: function
doc:
<comment>Description:</comment>
  Close all ODBC connections
  
  <strong>odbc_close_all()</strong> will close down all connections to database server(s).

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


id: odbc_columnprivileges
type: function
doc:
<comment>Description:</comment>
  Lists columns and associated privileges for the given table
  
  Lists columns and associated privileges for the given table.

<comment>Param:</comment>
  <info>resource</info>     <strong>$odbc</strong>     O identificador da conexão ODBC.
                         Consulte <strong>odbc_connect()</strong> para obter detalhes.
  <info>string|null</info>  <strong>$catalog</strong>  O catálogo ('qualifier' na linguagem ODBC 2).
  <info>string</info>       <strong>$schema</strong>   O esquema ('owner' na linguagem ODBC 2). Este parâmetro aceita os seguintes
                         padrões de pesquisa:
                         <return>%</return> para corresponder a zero ou mais caracteres
                         e <return>_</return> para corresponder a um único caractere.
  <info>string</info>       <strong>$table</strong>    The table name. Este parâmetro aceita os seguintes padrões de pesquisa:
                         <return>%</return> para corresponder a zero ou mais caracteres
                         e <return>_</return> para corresponder a um único caractere.
  <info>string</info>       <strong>$column</strong>   The column name. Este parâmetro aceita os seguintes padrões de pesquisa:
                         <return>%</return> para corresponder a zero ou mais caracteres
                         e <return>_</return> para corresponder a um único caractere.

<comment>Return:</comment>
  <info>resource|false</info>  Returns an ODBC result identifier ou <info>false</info> em caso de falha. This result
                  identifier can be used to fetch a list of columns and associated privileges.
                  
                  The result set has the following columns:
                  <return>TABLE_CAT</return><return>TABLE_SCHEM</return><return>TABLE_NAME</return><return>COLUMN_NAME</return><return>GRANTOR</return><return>GRANTEE</return><return>PRIVILEGE</return><return>IS_GRANTABLE</return>
                  Drivers podem listar colunas adicionais.
                  
                  <return>TABLE_CAT</return>
                  
                  <return>TABLE_SCHEM</return>
                  
                  <return>TABLE_NAME</return>
                  
                  <return>COLUMN_NAME</return>
                  
                  <return>GRANTOR</return>
                  
                  <return>GRANTEE</return>
                  
                  <return>PRIVILEGE</return>
                  
                  <return>IS_GRANTABLE</return>
                  
                  The result set is ordered by <return>TABLE_CAT</return>, <return>TABLE_SCHEM</return>, <return>TABLE_NAME</return>, <return>COLUMN_NAME</return> and
                  <return>PRIVILEGE</return>.


id: odbc_columns
type: function
doc:
<comment>Description:</comment>
  Lists the column names in specified tables
  
  Lists all columns in the requested range.

<comment>Param:</comment>
  <info>resource</info>     <strong>$odbc</strong>     O identificador da conexão ODBC.
                         Consulte <strong>odbc_connect()</strong> para obter detalhes.
  <info>string|null</info>  <strong>$catalog</strong>  O catálogo ('qualifier' na linguagem ODBC 2).
  <info>string|null</info>  <strong>$schema</strong>   O esquema ('owner' na linguagem ODBC 2). Este parâmetro aceita os seguintes
                         padrões de pesquisa:
                         <return>%</return> para corresponder a zero ou mais caracteres
                         e <return>_</return> para corresponder a um único caractere.
  <info>string|null</info>  <strong>$table</strong>    The table name. Este parâmetro aceita os seguintes padrões de pesquisa:
                         <return>%</return> para corresponder a zero ou mais caracteres
                         e <return>_</return> para corresponder a um único caractere.
  <info>string|null</info>  <strong>$column</strong>   The column name. Este parâmetro aceita os seguintes padrões de pesquisa:
                         <return>%</return> para corresponder a zero ou mais caracteres
                         e <return>_</return> para corresponder a um único caractere.

<comment>Return:</comment>
  <info>resource|false</info>  Returns an ODBC result identifier ou <info>false</info> em caso de falha.
                  
                  The result set has the following columns:
                  <return>TABLE_CAT</return><return>TABLE_SCHEM</return><return>TABLE_NAME</return><return>COLUMN_NAME</return><return>DATA_TYPE</return><return>TYPE_NAME</return><return>COLUMN_SIZE</return><return>BUFFER_LENGTH</return><return>DECIMAL_DIGITS</return><return>NUM_PREC_RADIX</return><return>NULLABLE</return><return>REMARKS</return><return>COLUMN_DEF</return><return>SQL_DATA_TYPE</return><return>SQL_DATETIME_SUB</return><return>CHAR_OCTET_LENGTH</return><return>ORDINAL_POSITION</return><return>IS_NULLABLE</return>
                  Drivers podem listar colunas adicionais.
                  
                  <return>TABLE_CAT</return>
                  
                  <return>TABLE_SCHEM</return>
                  
                  <return>TABLE_NAME</return>
                  
                  <return>COLUMN_NAME</return>
                  
                  <return>DATA_TYPE</return>
                  
                  <return>TYPE_NAME</return>
                  
                  <return>COLUMN_SIZE</return>
                  
                  <return>BUFFER_LENGTH</return>
                  
                  <return>DECIMAL_DIGITS</return>
                  
                  <return>NUM_PREC_RADIX</return>
                  
                  <return>NULLABLE</return>
                  
                  <return>REMARKS</return>
                  
                  <return>COLUMN_DEF</return>
                  
                  <return>SQL_DATA_TYPE</return>
                  
                  <return>SQL_DATETIME_SUB</return>
                  
                  <return>CHAR_OCTET_LENGTH</return>
                  
                  <return>ORDINAL_POSITION</return>
                  
                  <return>IS_NULLABLE</return>
                  
                  The result set is ordered by <return>TABLE_CAT</return>, <return>TABLE_SCHEM</return>, <return>TABLE_NAME</return> and
                  <return>ORDINAL_POSITION</return>.

<comment>See Also:</comment>
   * <strong>odbc_columnprivileges()</strong>
   * <strong>odbc_procedurecolumns()</strong>


id: odbc_commit
type: function
doc:
<comment>Description:</comment>
  Commit an ODBC transaction
  
  Commits all pending transactions on the connection.

<comment>Param:</comment>
  <info>resource</info>  <strong>$odbc</strong>  O identificador da conexão ODBC.
                   Consulte <strong>odbc_connect()</strong> para obter detalhes.

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


id: odbc_connect
type: function
doc:
<comment>Description:</comment>
  Connect to a datasource
  
  The connection id returned by this functions is needed by other ODBC functions. You can have
  multiple connections open at once as long as they either use different db or different
  credentials.
  
  With some ODBC drivers, executing a complex stored procedure may fail with an error similar to:
  "Cannot open a cursor on a stored procedure that has anything other than a single select statement
  in it".  Using SQL_CUR_USE_ODBC may avoid that error. Also, some drivers don't support the
  optional row_number parameter in <strong>odbc_fetch_row()</strong>. SQL_CUR_USE_ODBC might help in that case, too.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>            The database source name for the connection. Alternatively, a DSN-less
                          connection string can be used.
  <info>string</info>  <strong>$user</strong>           The username.
  <info>string</info>  <strong>$password</strong>       The password.
  <info>int</info>     <strong>$cursor_option</strong>  This sets the type of cursor to be used for this connection. This
                          parameter is not normally needed, but can be useful for working around
                          problems with some ODBC drivers.
                          
                          The following constants are defined for cursortype:
                          
                           SQL_CUR_USE_IF_NEEDED  SQL_CUR_USE_ODBC  SQL_CUR_USE_DRIVER 
                          
                          SQL_CUR_USE_IF_NEEDED
                          
                          SQL_CUR_USE_ODBC
                          
                          SQL_CUR_USE_DRIVER

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

<comment>See Also:</comment>
   * For persistent connections: <strong>odbc_pconnect()</strong>


id: odbc_connection_string_is_quoted
type: function
doc:
<comment>Description:</comment>
  Determines if an ODBC connection string value is quoted
  
  Determines if a string is properly quoted for an ODBC connection string value. ODBC connection
  string quoting is performed using curly braces, and ending braces within a string must be escaped
  through repeating them twice, similar to SQL quoting.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  The string to check for quoting.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if quoted properly, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>odbc_connection_string_quote()</strong>
   * <strong>odbc_connection_string_should_quote()</strong>


id: odbc_connection_string_quote
type: function
doc:
<comment>Description:</comment>
  Quotes an ODBC connection string value
  
  Quotes a value for a connection string, according to ODBC rules. That is, it will be surrounded by
  quotes, and any ending curly braces will be escaped. This should be done for any connection string
  values that come from user input. Not doing so can lead to issues with parsing the connection
  string, or values being injected into the connection string.
  
  Note that this function does not check if the string is already quoted, nor if the string needs
  quoting. For that, call <strong>odbc_connection_string_is_quoted()</strong> and
  <strong>odbc_connection_string_should_quote()</strong>.

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

<comment>Return:</comment>
  <info>string</info>  A quoted string, surrounded by curly braces, and properly escaped.

<comment>See Also:</comment>
   * <strong>odbc_connection_string_is_quoted()</strong>
   * <strong>odbc_connection_string_should_quote()</strong>


id: odbc_connection_string_should_quote
type: function
doc:
<comment>Description:</comment>
  Determines if an ODBC connection string value should be quoted
  
  Determines if a string needs to be quoted for an ODBC connection string value; that is, if it
  contains special characters.
  
  Note that this does not check if the string is already quoted; an already quoted string will
  contain characters that will make this function return true. You should call
  <strong>odbc_connection_string_is_quoted()</strong> to check.

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

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the string should be quoted; <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>odbc_connection_string_quote()</strong>
   * <strong>odbc_connection_string_is_quoted()</strong>


id: odbc_cursor
type: function
doc:
<comment>Description:</comment>
  Obtém o nome do cursor
  
  Obtém o nome do cursor de um dado result_id.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  O identificador de resultado.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o nome do cursor, como uma string,  ou <info>false</info> em caso de falha.


id: odbc_data_source
type: function
doc:
<comment>Description:</comment>
  Returns information about available DSNs
  
  This function will return the list of available DSN (after calling it several times).

<comment>Param:</comment>
  <info>resource</info>  <strong>$odbc</strong>        O identificador da conexão ODBC.
                         Consulte <strong>odbc_connect()</strong> para obter detalhes.
  <info>int</info>       <strong>$fetch_type</strong>  The <strong>$fetch_type</strong> can be one of two constant types: <info>SQL_FETCH_FIRST</info>,
                         <info>SQL_FETCH_NEXT</info>. Use <info>SQL_FETCH_FIRST</info> the first time this function is called,
                         thereafter use the <info>SQL_FETCH_NEXT</info>.

<comment>Return:</comment>
  <info>array|false</info>  Returns <info>false</info> on error, an <info>array</info> upon success, and <info>null</info> after fetching the last
               available DSN.


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


id: odbc_error
type: function
doc:
<comment>Description:</comment>
  Get the last error code
  
  Returns a six-digit ODBC state, or an empty string if there has been no errors.

<comment>Param:</comment>
  <info>resource|null</info>  <strong>$odbc</strong>  O identificador da conexão ODBC.
                        Consulte <strong>odbc_connect()</strong> para obter detalhes.

<comment>Return:</comment>
  <info>string</info>  If <strong>$odbc</strong> is specified, the last state of that connection is returned, else the last state
          of any connection is returned.
          
          This function returns meaningful value only if last odbc query failed (i.e. <strong>odbc_exec()</strong>
          returned <info>false</info>).

<comment>See Also:</comment>
   * <strong>odbc_errormsg()</strong>
   * <strong>odbc_exec()</strong>


id: odbc_errormsg
type: function
doc:
<comment>Description:</comment>
  Get the last error message
  
  Returns a string containing the last ODBC error message, or an empty string if there has been no
  errors.

<comment>Param:</comment>
  <info>resource|null</info>  <strong>$odbc</strong>  O identificador da conexão ODBC.
                        Consulte <strong>odbc_connect()</strong> para obter detalhes.

<comment>Return:</comment>
  <info>string</info>  If <strong>$odbc</strong> is specified, the last state of that connection is returned, else the last state
          of any connection is returned.
          
          This function returns meaningful value only if last odbc query failed (i.e. <strong>odbc_exec()</strong>
          returned <info>false</info>).

<comment>See Also:</comment>
   * <strong>odbc_error()</strong>
   * <strong>odbc_exec()</strong>


id: odbc_exec
type: function
doc:
<comment>Description:</comment>
  Directly execute an SQL statement
  
  Sends an SQL statement to the database server.

<comment>Param:</comment>
  <info>resource</info>  <strong>$odbc</strong>   O identificador da conexão ODBC.
                    Consulte <strong>odbc_connect()</strong> para obter detalhes.
  <info>string</info>    <strong>$query</strong>  The SQL statement.

<comment>Return:</comment>
  <info>resource|false</info>  Returns an ODBC result identifier if the SQL command was executed successfully, or
                  <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>odbc_prepare()</strong>
   * <strong>odbc_execute()</strong>


id: odbc_execute
type: function
doc:
<comment>Description:</comment>
  Executa um comando preparado
  
  Executa um comando preparado com <strong>odbc_prepare()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  O result id <info>resource</info>, de <strong>odbc_prepare()</strong>.
  <info>array</info>     <strong>$params</strong>     Parâmetros em <strong>$params</strong> serão substituídos por marcadores na ordem no comando
                        preparado. Elementos desta matriz serão convertidos para strings ao chamar
                        esta função.
                        
                        Quaisquer parâmetros em <strong>$params</strong> que iniciam e finalizam com aspas simples
                        serão considerados como o nome de um arquivo para ler e enviar ao servidor
                        de banco de dados como os dados para o espaço reservado apropriado.
                        
                        Se você quiser guardar uma string que comece e termine com aspas simples,
                        você deve adicionar um espaço ou outro caractere que não seja aspas simples
                        no início ou no final do parâmetro, o qual irá evitar que o parâmetro seja
                        considerado um nome de arquivo. Se isto não for uma opção, então você deve
                        usar outro mecanismo para guardar a string, como executar a consulta
                        diretamente com <strong>odbc_exec()</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>odbc_prepare()</strong>


id: odbc_fetch_array
type: function
doc:
<comment>Description:</comment>
  Obtém uma linha do resultado como um array associativo
  
  Obtém um <info>array</info> associativo de uma consulta ODBC.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  O recurso de resultado de <strong>odbc_exec()</strong>.
  <info>int</info>       <strong>$row</strong>        Opcionalmente escolha o número da linha que você quer obter.

<comment>Return:</comment>
  <info>array|false</info>  Retorna um array que corresponde a linha obtida, ou <info>false</info> se não houverem mais
               linhas.

<comment>See Also:</comment>
   * <strong>odbc_fetch_row()</strong>
   * <strong>odbc_fetch_object()</strong>
   * <strong>odbc_num_rows()</strong>


id: odbc_fetch_into
type: function
doc:
<comment>Description:</comment>
  Fetch one result row into array
  
  Fetch one result row into <info>array</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  The result <info>resource</info>.
  <info>array</info>     <strong>$array</strong>      The result <info>array</info> that can be of any type since it will be converted to type
                        array. The array will contain the column values starting at array index 0.
  <info>int</info>       <strong>$row</strong>        The row number.

<comment>Return:</comment>
  <info>int|false</info>  Returns the number of columns in the result; <info>false</info> on error.


id: odbc_fetch_object
type: function
doc:
<comment>Description:</comment>
  Obtém um conjunto de resultados como um objeto
  
  Obtém um <info>object</info> a partir de uma consulta ODBC.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  O recurso do resultado de <strong>odbc_exec()</strong>.
  <info>int</info>       <strong>$row</strong>        Opcionalmente escolha o número da linha a qual obter.

<comment>Return:</comment>
  <info>stdClass|false</info>  Retorna um objeto que corresponde a linha obitida, ou <info>false</info> se não houverem mais
                  linhas.

<comment>See Also:</comment>
   * <strong>odbc_fetch_row()</strong>
   * <strong>odbc_fetch_array()</strong>
   * <strong>odbc_num_rows()</strong>


id: odbc_fetch_row
type: function
doc:
<comment>Description:</comment>
  Obtém uma linha
  
  Obtém uma linha de dados que foi retornada pela <strong>odbc_do()</strong> ou <strong>odbc_exec()</strong>. Depois de
  <strong>odbc_fetch_row()</strong> ser chamada, os campos desta linha podem ser acessados com <strong>odbc_result()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  O identificador de resultado.
  <info>int|null</info>  <strong>$row</strong>        Se <strong>$row</strong> não for especificado, <strong>odbc_fetch_row()</strong> irá tentar obter a próxima
                        linha no conjunto de resultados. Chamadas para <strong>odbc_fetch_row()</strong> com ou sem
                        <strong>$row</strong> podem ser misturadas.
                        
                        Para caminhar através do conjunto de resultados mais de uma vez, você pode
                        usar <strong>odbc_fetch_row()</strong> com <strong>$row</strong> 1, e então continuar fazendo <strong>odbc_fetch_row()</strong>
                        sem <strong>$row</strong> para ver os resultados. Se um driver não suportar a obtenção de
                        linhas por números, o parâmetro <strong>$row</strong> é ignorado.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se houver uma linha, <info>false</info> caso contrário.


id: odbc_field_len
type: function
doc:
<comment>Description:</comment>
  Obtém o tamanho (precisão) de um campo
  
  Obtém o tamanho do campo referenciado pelo número no dado identificador de resultado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  O identificador do resultado.
  <info>int</info>       <strong>$field</strong>      O número do campo. A numeração dos campos inicia em 0.

<comment>Return:</comment>
  <info>int|false</info>  Retorna o tamanho do campo, ou <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * <strong>odbc_field_scale()</strong> para obter a precisão de um
    número de ponto flutuante


id: odbc_field_name
type: function
doc:
<comment>Description:</comment>
  Obtém o nome da coluna
  
  Obtém o nome do campo ocupando o número da coluna em um dado identificador de resultado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  O identificador de resultado.
  <info>int</info>       <strong>$field</strong>      O número do campo. A numeração de campos iniciam em 1.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o nome do campo como uma string, ou <info>false</info> em erro.


id: odbc_field_num
type: function
doc:
<comment>Description:</comment>
  Retorna o número da coluna
  
  Obtém o número da coluna que corresponde ao nome do campo no dado identificador de resultado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  O identificador de resultado.
  <info>string</info>    <strong>$field</strong>      O nome do campo.

<comment>Return:</comment>
  <info>int|false</info>  Retorna o número do campo como um inteiro, ou <info>false</info> em erro. A numeração dos campos
             iniciam em 1.


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

<comment>See Also:</comment>
   * <strong>odbc_field_scale()</strong> para obter a precisão
    de números de ponto flutuante.


id: odbc_field_scale
type: function
doc:
<comment>Description:</comment>
  Obtém a precisão de um campo
  
  Obtém a precisão do campo referenciado pelo número em um dado identificador de resultado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  O identificador de resultado.
  <info>int</info>       <strong>$field</strong>      O número do campo. A numeração do campo inicia em 1.

<comment>Return:</comment>
  <info>int|false</info>  Retorna a precisão do campo como um inteiro, ou <info>false</info> em erro.


id: odbc_field_type
type: function
doc:
<comment>Description:</comment>
  Tipo de dados de um campo
  
  Obtém o tipo SQL do campo referenciado pelo número num dado identificador de resultado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  O identificador de resultado.
  <info>int</info>       <strong>$field</strong>      O número do campo. Campos numerados a partir de 1.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o tipo do campo como uma string, ou <info>false</info> em erro.


id: odbc_foreignkeys
type: function
doc:
<comment>Description:</comment>
  Retrieves a list of foreign keys
  
  Retrieves a list of foreign keys in the specified table or a list of foreign keys in other tables
  that refer to the primary key in the specified table

<comment>Param:</comment>
  <info>resource</info>     <strong>$odbc</strong>        O identificador da conexão ODBC.
                            Consulte <strong>odbc_connect()</strong> para obter detalhes.
  <info>string|null</info>  <strong>$pk_catalog</strong>  The catalog ('qualifier' in ODBC 2 parlance) of the primary key table.
  <info>string</info>       <strong>$pk_schema</strong>   The schema ('owner' in ODBC 2 parlance) of the primary key table.
  <info>string</info>       <strong>$pk_table</strong>    The primary key table.
  <info>string</info>       <strong>$fk_catalog</strong>  The catalog ('qualifier' in ODBC 2 parlance) of the foreign key table.
  <info>string</info>       <strong>$fk_schema</strong>   The schema ('owner' in ODBC 2 parlance) of the foreign key table.
  <info>string</info>       <strong>$fk_table</strong>    The foreign key table.

<comment>Return:</comment>
  <info>resource|false</info>  Returns an ODBC result identifier ou <info>false</info> em caso de falha.
                  
                  The result set has the following columns:
                  <return>PKTABLE_CAT</return><return>PKTABLE_SCHEM</return><return>PKTABLE_NAME</return><return>PKCOLUMN_NAME</return><return>FKTABLE_CAT</return><return>FKTABLE_SCHEM</return><return>FKTABLE_NAME</return><return>FKCOLUMN_NAME</return><return>KEY_SEQ</return><return>UPDATE_RULE</return><return>DELETE_RULE</return><return>FK_NAME</return><return>PK_NAME</return><return>DEFERRABILITY</return>
                  Drivers podem listar colunas adicionais.
                  
                  <return>PKTABLE_CAT</return>
                  
                  <return>PKTABLE_SCHEM</return>
                  
                  <return>PKTABLE_NAME</return>
                  
                  <return>PKCOLUMN_NAME</return>
                  
                  <return>FKTABLE_CAT</return>
                  
                  <return>FKTABLE_SCHEM</return>
                  
                  <return>FKTABLE_NAME</return>
                  
                  <return>FKCOLUMN_NAME</return>
                  
                  <return>KEY_SEQ</return>
                  
                  <return>UPDATE_RULE</return>
                  
                  <return>DELETE_RULE</return>
                  
                  <return>FK_NAME</return>
                  
                  <return>PK_NAME</return>
                  
                  <return>DEFERRABILITY</return>
                  
                  If the foreign keys associated with a primary key are requested, the result set is
                  ordered by <return>FKTABLE_CAT</return>, <return>FKTABLE_SCHEM</return>, <return>FKTABLE_NAME</return> and <return>KEY_SEQ</return>. If the primary
                  keys associated with a foreign key are requested, the result set is ordered by
                  <return>PKTABLE_CAT</return>, <return>PKTABLE_SCHEM</return>, <return>PKTABLE_NAME</return> and <return>KEY_SEQ</return>.
                  
                  If <strong>$pk_table</strong> contains a table name, <strong>odbc_foreignkeys()</strong> returns a result set
                  containing the primary key of the specified table and all of the foreign keys that
                  refer to it.
                  
                  If <strong>$fk_table</strong> contains a table name, <strong>odbc_foreignkeys()</strong> returns a result set
                  containing all of the foreign keys in the specified table and the primary keys (in
                  other tables) to which they refer.
                  
                  If both <strong>$pk_table</strong> and <strong>$fk_table</strong> contain table names, <strong>odbc_foreignkeys()</strong> returns
                  the foreign keys in the table specified in <strong>$fk_table</strong> that refer to the primary key
                  of the table specified in <strong>$pk_table</strong>. This should be one key at most.

<comment>See Also:</comment>
   * <strong>odbc_tables()</strong>
   * <strong>odbc_primarykeys()</strong>


id: odbc_free_result
type: function
doc:
<comment>Description:</comment>
  Libera os recursos associados a um resultado
  
  Libera o recursos associados com o resultado.
  
  <strong>odbc_free_result()</strong> somente necessita ser chamado se você está com problema pelo fato de usar muita
  memória quando seu script é executado. Toda memória de resultado irá automaticamente ser liberada
  quando o script é terminado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  The result identifier.

<comment>Return:</comment>
  <info>bool</info>  Sempre retorna <info>true</info>.


id: odbc_gettypeinfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about data types supported by the data source
  
  Retrieves information about data types supported by the data source.

<comment>Param:</comment>
  <info>resource</info>  <strong>$odbc</strong>       O identificador da conexão ODBC.
                        Consulte <strong>odbc_connect()</strong> para obter detalhes.
  <info>int</info>       <strong>$data_type</strong>  The data type, which can be used to restrict the information to a single
                        data type.

<comment>Return:</comment>
  <info>resource|false</info>  Returns an ODBC result identifier or <info>false</info> on failure.
                  
                  The result set has the following columns:
                  TYPE_NAMEDATA_TYPEPRECISIONLITERAL_PREFIXLITERAL_SUFFIXCREATE_PARAMSNULLABLECASE_SENSITIVESEARCHABLEUNSIGNED_ATTRIBUTEMONEYAUTO_INCREMENTLOCAL_TYPE_NAMEMINIMUM_SCALEMAXIMUM_SCALE
                  
                  TYPE_NAME
                  
                  DATA_TYPE
                  
                  PRECISION
                  
                  LITERAL_PREFIX
                  
                  LITERAL_SUFFIX
                  
                  CREATE_PARAMS
                  
                  NULLABLE
                  
                  CASE_SENSITIVE
                  
                  SEARCHABLE
                  
                  UNSIGNED_ATTRIBUTE
                  
                  MONEY
                  
                  AUTO_INCREMENT
                  
                  LOCAL_TYPE_NAME
                  
                  MINIMUM_SCALE
                  
                  MAXIMUM_SCALE
                  
                  The result set is ordered by DATA_TYPE and TYPE_NAME.


id: odbc_longreadlen
type: function
doc:
<comment>Description:</comment>
  Manipulação de colunas LONG
  
  Controla a manipulação das colunas <return>LONG</return>, <return>LONGVARCHAR</return> e <return>LONGVARBINARY</return>. O comprimento padrão pode
  ser definido usando a diretiva uodbc.defaultlrl php.ini.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  O identificador de resultado.
  <info>int</info>       <strong>$length</strong>     O número de bytes retornado pelo PHP é controlado pelo parâmetro length. Se
                        ele é definido como <return>0</return>, coluna de grandes dados são passadas através do
                        cliente (ou seja, impresso) quando recuperado com <strong>odbc_result()</strong>.

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


id: odbc_next_result
type: function
doc:
<comment>Description:</comment>
  Confere se resultados múltiplos estão disponíveis
  
  Verifica se há mais resultados disponíveis, dessa forma, permitindo acesso para próximo resultado
  via <strong>odbc_fetch_array()</strong>, <strong>odbc_fetch_row()</strong>, <strong>odbc_result()</strong>, etc.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  O identificador de resultado.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se há mais resultados, <info>false</info> caso contrário.


id: odbc_num_fields
type: function
doc:
<comment>Description:</comment>
  Número de colunas em um resultado
  
  Obtém o número de campos (colunas) em um resultado ODBC.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  O identificador de resultado retornado pela <strong>odbc_exec()</strong>.

<comment>Return:</comment>
  <info>int</info>  Retorna o número de campos, ou -1 em erro.


id: odbc_num_rows
type: function
doc:
<comment>Description:</comment>
  Número de linhas em um resultado
  
  Obtém o número de linhas em um resultado ODBC. Para comandos INSERT, UPDATE e DELETE
  <strong>odbc_num_rows()</strong> retorna o número de linhas afetadas. Para SELECT isto <return>pode</return> ser o número de linhas
  disponíveis.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  O identificador de resultado retornado pela <strong>odbc_exec()</strong>.

<comment>Return:</comment>
  <info>int</info>  Retorna o número de linhas em um resultado ODBC. Esta função retornará -1 em erro.


id: odbc_pconnect
type: function
doc:
<comment>Description:</comment>
  Open a persistent database connection
  
  Opens a persistent database connection.
  
  This function is much like <strong>odbc_connect()</strong>, except that the connection is not really closed when
  the script has finished.  Future requests for a connection with the same <strong>$dsn</strong>, <strong>$user</strong>, <strong>$password</strong>
  combination (via <strong>odbc_connect()</strong> and <strong>odbc_pconnect()</strong>) can reuse the persistent connection.

<comment>Return:</comment>
  <info>resource|false</info>  Returns an ODBC connection,  ou <info>false</info> em caso de falha. error.

<comment>See Also:</comment>
   * <strong>odbc_connect()</strong>
   * Persistent Database Connections


id: odbc_prepare
type: function
doc:
<comment>Description:</comment>
  Prepara um comando para execução
  
  Prepara um comando para execução. O identificador de resultado pode ser usado posteriormente para
  executar o comando com <strong>odbc_execute()</strong>.
  
  Alguns bancos de dados (como IBM DB2, MS SQL Server, e Oracle) suportam stored procedures que
  aceitam parâmetros do tipo IN, INOUT, e OUT como definido pela especificação ODBC. Entretanto, o
  Unified ODBC driver atualmente suporta apenas parâmetros do tipo IN em stored procedures.

<comment>Param:</comment>
  <info>resource</info>  <strong>$odbc</strong>   O identificador da conexão ODBC.
                    Consulte <strong>odbc_connect()</strong> para obter detalhes.
  <info>string</info>    <strong>$query</strong>  A instrução da string de consulta que está sendo preparada.

<comment>Return:</comment>
  <info>resource|false</info>  Retorna um identificador de resultado ODBC se o comando SQL foi preparado com
                  sucesso. Retorna <info>false</info> em caso de erro.

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


id: odbc_primarykeys
type: function
doc:
<comment>Description:</comment>
  Gets the primary keys for a table
  
  Returns a result identifier that can be used to fetch the column names that comprise the primary
  key for a table.

<comment>Param:</comment>
  <info>resource</info>     <strong>$odbc</strong>     O identificador da conexão ODBC.
                         Consulte <strong>odbc_connect()</strong> para obter detalhes.
  <info>string|null</info>  <strong>$catalog</strong>  O catálogo ('qualifier' na linguagem ODBC 2).
  <info>string</info>       <strong>$schema</strong>   O esquema ('owner' na linguagem ODBC 2).
  <info>string</info>       <strong>$table</strong>    

<comment>Return:</comment>
  <info>resource|false</info>  Returns an ODBC result identifier ou <info>false</info> em caso de falha.
                  
                  The result set has the following columns:
                  <return>TABLE_CAT</return><return>TABLE_SCHEM</return><return>TABLE_NAME</return><return>COLUMN_NAME</return><return>KEY_SEQ</return><return>PK_NAME</return> Drivers podem listar
                  colunas adicionais.
                  
                  <return>TABLE_CAT</return>
                  
                  <return>TABLE_SCHEM</return>
                  
                  <return>TABLE_NAME</return>
                  
                  <return>COLUMN_NAME</return>
                  
                  <return>KEY_SEQ</return>
                  
                  <return>PK_NAME</return>
                  
                  The result set is ordered by <return>TABLE_CAT</return>, <return>TABLE_SCHEM</return>, <return>TABLE_NAME</return> and <return>KEY_SEQ</return>.

<comment>See Also:</comment>
   * <strong>odbc_tables()</strong>
   * <strong>odbc_foreignkeys()</strong>


id: odbc_procedurecolumns
type: function
doc:
<comment>Description:</comment>
  Retrieve information about parameters to procedures
  
  Retrieve information about parameters to procedures.

<comment>Param:</comment>
  <info>resource</info>     <strong>$odbc</strong>       O identificador da conexão ODBC.
                           Consulte <strong>odbc_connect()</strong> para obter detalhes.
  <info>string|null</info>  <strong>$catalog</strong>    O catálogo ('qualifier' na linguagem ODBC 2).
  <info>string|null</info>  <strong>$schema</strong>     O esquema ('owner' na linguagem ODBC 2). Este parâmetro aceita os
                           seguintes padrões de pesquisa:
                           <return>%</return> para corresponder a zero ou mais caracteres
                           e <return>_</return> para corresponder a um único caractere.
  <info>string|null</info>  <strong>$procedure</strong>  The proc. Este parâmetro aceita os seguintes padrões de pesquisa:
                           <return>%</return> para corresponder a zero ou mais caracteres
                           e <return>_</return> para corresponder a um único caractere.
  <info>string|null</info>  <strong>$column</strong>     The column. Este parâmetro aceita os seguintes padrões de pesquisa:
                           <return>%</return> para corresponder a zero ou mais caracteres
                           e <return>_</return> para corresponder a um único caractere.

<comment>Return:</comment>
  <info>resource|false</info>  Returns the list of input and output parameters, as well as the columns that make
                  up the result set for the specified procedures.  Returns an ODBC result identifier
                  ou <info>false</info> em caso de falha.
                  
                  The result set has the following columns:
                  <return>PROCEDURE_CAT</return><return>PROCEDURE_SCHEM</return><return>PROCEDURE_NAME</return><return>COLUMN_NAME</return><return>COLUMN_TYPE</return><return>DATA_TYPE</return><return>TYPE_NAME</return><return>COLUMN_SIZE</return><return>BUFFER_LENGTH</return><return>DECIMAL_DIGITS</return><return>NUM_PREC_RADIX</return><return>NULLABLE</return><return>REMARKS</return><return>COLUMN_DEF</return><return>SQL_DATA_TYPE</return><return>SQL_DATETIME_SUB</return><return>CHAR_OCTET_LENGTH</return><return>ORDINAL_POSITION</return><return>IS_NULLABLE</return>
                  Drivers podem listar colunas adicionais.
                  
                  <return>PROCEDURE_CAT</return>
                  
                  <return>PROCEDURE_SCHEM</return>
                  
                  <return>PROCEDURE_NAME</return>
                  
                  <return>COLUMN_NAME</return>
                  
                  <return>COLUMN_TYPE</return>
                  
                  <return>DATA_TYPE</return>
                  
                  <return>TYPE_NAME</return>
                  
                  <return>COLUMN_SIZE</return>
                  
                  <return>BUFFER_LENGTH</return>
                  
                  <return>DECIMAL_DIGITS</return>
                  
                  <return>NUM_PREC_RADIX</return>
                  
                  <return>NULLABLE</return>
                  
                  <return>REMARKS</return>
                  
                  <return>COLUMN_DEF</return>
                  
                  <return>SQL_DATA_TYPE</return>
                  
                  <return>SQL_DATETIME_SUB</return>
                  
                  <return>CHAR_OCTET_LENGTH</return>
                  
                  <return>ORDINAL_POSITION</return>
                  
                  <return>IS_NULLABLE</return>
                  
                  The result set is ordered by <return>PROCEDURE_CAT</return>, <return>PROCEDURE_SCHEM</return>, <return>PROCEDURE_NAME</return> and
                  <return>COLUMN_TYPE</return>.

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


id: odbc_procedures
type: function
doc:
<comment>Description:</comment>
  Get the list of procedures stored in a specific data source
  
  Lists all procedures in the requested range.

<comment>Param:</comment>
  <info>resource</info>     <strong>$odbc</strong>       O identificador da conexão ODBC.
                           Consulte <strong>odbc_connect()</strong> para obter detalhes.
  <info>string|null</info>  <strong>$catalog</strong>    O catálogo ('qualifier' na linguagem ODBC 2).
  <info>string|null</info>  <strong>$schema</strong>     O esquema ('owner' na linguagem ODBC 2). Este parâmetro aceita os
                           seguintes padrões de pesquisa:
                           <return>%</return> para corresponder a zero ou mais caracteres
                           e <return>_</return> para corresponder a um único caractere.
  <info>string|null</info>  <strong>$procedure</strong>  The name. Este parâmetro aceita os seguintes padrões de pesquisa:
                           <return>%</return> para corresponder a zero ou mais caracteres
                           e <return>_</return> para corresponder a um único caractere.

<comment>Return:</comment>
  <info>resource|false</info>  Returns an ODBC result identifier containing the information ou <info>false</info> em caso de
                  falha.
                  
                  The result set has the following columns:
                  <return>PROCEDURE_CAT</return><return>PROCEDURE_SCHEM</return><return>PROCEDURE_NAME</return><return>NUM_INPUT_PARAMS</return><return>NUM_OUTPUT_PARAMS</return><return>NUM_RESULT_SETS</return><return>REMARKS</return><return>PROCEDURE_TYPE</return>
                  Drivers podem listar colunas adicionais.
                  
                  <return>PROCEDURE_CAT</return>
                  
                  <return>PROCEDURE_SCHEM</return>
                  
                  <return>PROCEDURE_NAME</return>
                  
                  <return>NUM_INPUT_PARAMS</return>
                  
                  <return>NUM_OUTPUT_PARAMS</return>
                  
                  <return>NUM_RESULT_SETS</return>
                  
                  <return>REMARKS</return>
                  
                  <return>PROCEDURE_TYPE</return>
                  
                  The result set is ordered by <return>PROCEDURE_CAT</return>, <return>PROCEDURE_SCHEMA</return> and <return>PROCEDURE_NAME</return>.

<comment>See Also:</comment>
   * <strong>odbc_procedurecolumns()</strong>
   * <strong>odbc_tables()</strong>


id: odbc_result
type: function
doc:
<comment>Description:</comment>
  Get result data
  
  Get result data

<comment>Param:</comment>
  <info>resource</info>    <strong>$statement</strong>  The ODBC <info>resource</info>.
  <info>string|int</info>  <strong>$field</strong>      The field name being retrieved. It can either be an integer containing the
                          column number of the field you want; or it can be a string containing the
                          name of the field.

<comment>Return:</comment>
  <info>string|bool|null</info>  Returns the string contents of the field, <info>false</info> on error, <info>null</info> for NULL data, or
                    <info>true</info> for binary data.


id: odbc_result_all
type: function
doc:
<comment>Description:</comment>
  Mostra o resultado como uma tabela HTML
  
  Mostra todas as linhas de um resultado produzido pela <strong>odbc_exec()</strong>. O resultado é mostrado no
  formato de tabela HTML. Os dados não são escapados.
  
  Esta função não deve ser usada em ambientes de produção; isso é destinado apenas para fins de
  desenvolvimento, para obter um conjunto de resultados renderizado rapidamente.

<comment>Param:</comment>
  <info>resource</info>  <strong>$statement</strong>  O identificador de resultado.
  <info>string</info>    <strong>$format</strong>     Formatação adicional de toda tabela.

<comment>Return:</comment>
  <info>int|false</info>  Retorna o número de linhas no resultado ou <info>false</info> em erro.


id: odbc_rollback
type: function
doc:
<comment>Description:</comment>
  Rollback a transaction
  
  Rolls back all pending statements on the connection.

<comment>Param:</comment>
  <info>resource</info>  <strong>$odbc</strong>  O identificador da conexão ODBC.
                   Consulte <strong>odbc_connect()</strong> para obter detalhes.

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


id: odbc_setoption
type: function
doc:
<comment>Description:</comment>
  Adjust ODBC settings
  
  This function allows fiddling with the ODBC options for a particular connection or query result.
  It was written to help find work around to problems in quirky ODBC drivers.  You should probably
  only use this function if you are an ODBC programmer and understand the effects the various
  options will have.  You will certainly need a good ODBC reference to explain all the different
  options and values that can be used.  Different driver versions support different options.
  
  Because the effects may vary depending on the ODBC driver, use of this function in scripts to be
  made publicly available is strongly discouraged.  Also, some ODBC options are not available to
  this function because they must be set before the connection is established or the query is
  prepared.  However, if on a particular job it can make PHP work so your boss doesn't tell you to
  use a commercial product, that's all that really matters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$odbc</strong>    Is a connection id or result id on which to change the settings. For
                     SQLSetConnectOption(), this is a connection id. For SQLSetStmtOption(), this is
                     a result id.
  <info>int</info>       <strong>$which</strong>   Is the ODBC function to use. The value should be 1 for SQLSetConnectOption()
                     and 2 for SQLSetStmtOption().
  <info>int</info>       <strong>$option</strong>  The option to set.
  <info>int</info>       <strong>$value</strong>   The value for the given <strong>$option</strong>.

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


id: odbc_specialcolumns
type: function
doc:
<comment>Description:</comment>
  Retrieves special columns
  
  Retrieves either the optimal set of columns that uniquely identifies a row in the table, or
  columns that are automatically updated when any value in the row is updated by a transaction.

<comment>Param:</comment>
  <info>resource</info>     <strong>$odbc</strong>      O identificador da conexão ODBC.
                          Consulte <strong>odbc_connect()</strong> para obter detalhes.
  <info>int</info>          <strong>$type</strong>      When the type argument is <info>SQL_BEST_ROWID</info>, <strong>odbc_specialcolumns()</strong> returns
                          the column or columns that uniquely identify each row in the table.
                          
                          When the type argument is <info>SQL_ROWVER</info>, <strong>odbc_specialcolumns()</strong> returns the
                          column or columns in the specified table, if any, that are automatically
                          updated by the data source when any value in the row is updated by any
                          transaction.
  <info>string|null</info>  <strong>$catalog</strong>   O catálogo ('qualifier' na linguagem ODBC 2).
  <info>string</info>       <strong>$schema</strong>    O esquema ('owner' na linguagem ODBC 2).
  <info>string</info>       <strong>$table</strong>     The table.
  <info>int</info>          <strong>$scope</strong>     The scope, which orders the result set. One of <info>SQL_SCOPE_CURROW</info>,
                          <info>SQL_SCOPE_TRANSACTION</info> or <info>SQL_SCOPE_SESSION</info>.
  <info>int</info>          <strong>$nullable</strong>  Determines whether to return special columns that can have a NULL value.
                          One of <info>SQL_NO_NULLS</info> or <info>SQL_NULLABLE</info>.

<comment>Return:</comment>
  <info>resource|false</info>  Returns an ODBC result identifier or <info>false</info> on failure.
                  
                  The result set has the following columns:
                  <return>SCOPE</return><return>COLUMN_NAME</return><return>DATA_TYPE</return><return>TYPE_NAME</return><return>COLUMN_SIZE</return><return>BUFFER_LENGTH</return><return>DECIMAL_DIGITS</return><return>PSEUDO_COLUMN</return>
                  Drivers podem listar colunas adicionais.
                  
                  <return>SCOPE</return>
                  
                  <return>COLUMN_NAME</return>
                  
                  <return>DATA_TYPE</return>
                  
                  <return>TYPE_NAME</return>
                  
                  <return>COLUMN_SIZE</return>
                  
                  <return>BUFFER_LENGTH</return>
                  
                  <return>DECIMAL_DIGITS</return>
                  
                  <return>PSEUDO_COLUMN</return>
                  
                  The result set is ordered by <return>SCOPE</return>.

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


id: odbc_statistics
type: function
doc:
<comment>Description:</comment>
  Retrieve statistics about a table
  
  Get statistics about a table and its indexes.

<comment>Param:</comment>
  <info>resource</info>     <strong>$odbc</strong>      O identificador da conexão ODBC.
                          Consulte <strong>odbc_connect()</strong> para obter detalhes.
  <info>string|null</info>  <strong>$catalog</strong>   O catálogo ('qualifier' na linguagem ODBC 2).
  <info>string</info>       <strong>$schema</strong>    O esquema ('owner' na linguagem ODBC 2).
  <info>string</info>       <strong>$table</strong>     The table name.
  <info>int</info>          <strong>$unique</strong>    The type of the index. One of <info>SQL_INDEX_UNIQUE</info> or <info>SQL_INDEX_ALL</info>.
  <info>int</info>          <strong>$accuracy</strong>  One of <info>SQL_ENSURE</info> or <info>SQL_QUICK</info>. The latter requests that the driver
                          retrieve the <return>CARDINALITY</return> and <return>PAGES</return> only if they are readily available from
                          the server.

<comment>Return:</comment>
  <info>resource|false</info>  Returns an ODBC result identifier ou <info>false</info> em caso de falha.
                  
                  The result set has the following columns:
                  <return>TABLE_CAT</return><return>TABLE_SCHEM</return><return>TABLE_NAME</return><return>NON_UNIQUE</return><return>INDEX_QUALIFIER</return><return>INDEX_NAME</return><return>TYPE</return><return>ORDINAL_POSITION</return><return>COLUMN_NAME</return><return>ASC_OR_DESC</return><return>CARDINALITY</return><return>PAGES</return><return>FILTER_CONDITION</return>
                  Drivers podem listar colunas adicionais.
                  
                  <return>TABLE_CAT</return>
                  
                  <return>TABLE_SCHEM</return>
                  
                  <return>TABLE_NAME</return>
                  
                  <return>NON_UNIQUE</return>
                  
                  <return>INDEX_QUALIFIER</return>
                  
                  <return>INDEX_NAME</return>
                  
                  <return>TYPE</return>
                  
                  <return>ORDINAL_POSITION</return>
                  
                  <return>COLUMN_NAME</return>
                  
                  <return>ASC_OR_DESC</return>
                  
                  <return>CARDINALITY</return>
                  
                  <return>PAGES</return>
                  
                  <return>FILTER_CONDITION</return>
                  
                  The result set is ordered by <return>NON_UNIQUE</return>, <return>TYPE</return>, <return>INDEX_QUALIFIER</return>, <return>INDEX_NAME</return> and
                  <return>ORDINAL_POSITION</return>.

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


id: odbc_tableprivileges
type: function
doc:
<comment>Description:</comment>
  Lists tables and the privileges associated with each table
  
  Lists tables in the requested range and the privileges associated with each table.

<comment>Param:</comment>
  <info>resource</info>     <strong>$odbc</strong>     O identificador da conexão ODBC.
                         Consulte <strong>odbc_connect()</strong> para obter detalhes.
  <info>string|null</info>  <strong>$catalog</strong>  O catálogo ('qualifier' na linguagem ODBC 2).
  <info>string</info>       <strong>$schema</strong>   O esquema ('owner' na linguagem ODBC 2). Este parâmetro aceita os seguintes
                         padrões de pesquisa:
                         <return>%</return> para corresponder a zero ou mais caracteres
                         e <return>_</return> para corresponder a um único caractere.
  <info>string</info>       <strong>$table</strong>    The name. Este parâmetro aceita os seguintes padrões de pesquisa:
                         <return>%</return> para corresponder a zero ou mais caracteres
                         e <return>_</return> para corresponder a um único caractere.

<comment>Return:</comment>
  <info>resource|false</info>  An ODBC result identifier ou <info>false</info> em caso de falha.
                  
                  The result set has the following columns:
                  <return>TABLE_CAT</return><return>TABLE_SCHEM</return><return>TABLE_NAME</return><return>GRANTOR</return><return>GRANTEE</return><return>PRIVILEGE</return><return>IS_GRANTABLE</return> Drivers podem
                  listar colunas adicionais.
                  
                  <return>TABLE_CAT</return>
                  
                  <return>TABLE_SCHEM</return>
                  
                  <return>TABLE_NAME</return>
                  
                  <return>GRANTOR</return>
                  
                  <return>GRANTEE</return>
                  
                  <return>PRIVILEGE</return>
                  
                  <return>IS_GRANTABLE</return>
                  
                  The result set is ordered by <return>TABLE_CAT</return>, <return>TABLE_SCHEM</return>, <return>TABLE_NAME</return>, <return>PRIVILEGE</return> and
                  <return>GRANTEE</return>.

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


id: odbc_tables
type: function
doc:
<comment>Description:</comment>
  Get the list of table names stored in a specific data source
  
  Lists all tables in the requested range.
  
  To support enumeration of qualifiers, owners, and table types, the following special semantics for
  the <strong>$catalog</strong>, <strong>$schema</strong>, <strong>$table</strong>, and <strong>$table_type</strong> are available:  If <strong>$catalog</strong> is a single percent
  character (%) and <strong>$schema</strong> and <strong>$table</strong> are empty strings, then the result set contains a list of
  valid qualifiers for the data source. (All columns except the TABLE_QUALIFIER column contain
  NULLs.)  If <strong>$schema</strong> is a single percent character (%) and <strong>$catalog</strong> and <strong>$table</strong> are empty strings,
  then the result set contains a list of valid owners for the data source. (All columns except the
  TABLE_OWNER column contain NULLs.)  If <strong>$table_type</strong> is a single percent character (%) and <strong>$catalog</strong>,
  <strong>$schema</strong> and <strong>$table</strong> are empty strings, then the result set contains a list of valid table types for
  the data source. (All columns except the TABLE_TYPE column contain NULLs.)
  
  If <strong>$catalog</strong> is a single percent character (%) and <strong>$schema</strong> and <strong>$table</strong> are empty strings, then the
  result set contains a list of valid qualifiers for the data source. (All columns except the
  TABLE_QUALIFIER column contain NULLs.)
  
  If <strong>$schema</strong> is a single percent character (%) and <strong>$catalog</strong> and <strong>$table</strong> are empty strings, then the
  result set contains a list of valid owners for the data source. (All columns except the
  TABLE_OWNER column contain NULLs.)
  
  If <strong>$table_type</strong> is a single percent character (%) and <strong>$catalog</strong>, <strong>$schema</strong> and <strong>$table</strong> are empty
  strings, then the result set contains a list of valid table types for the data source. (All
  columns except the TABLE_TYPE column contain NULLs.)

<comment>Param:</comment>
  <info>resource</info>     <strong>$odbc</strong>     O identificador da conexão ODBC.
                         Consulte <strong>odbc_connect()</strong> para obter detalhes.
  <info>string|null</info>  <strong>$catalog</strong>  O catálogo ('qualifier' na linguagem ODBC 2).
  <info>string|null</info>  <strong>$schema</strong>   O esquema ('owner' na linguagem ODBC 2). Este parâmetro aceita os seguintes
                         padrões de pesquisa:
                         <return>%</return> para corresponder a zero ou mais caracteres
                         e <return>_</return> para corresponder a um único caractere.
  <info>string|null</info>  <strong>$table</strong>    The name. Este parâmetro aceita os seguintes padrões de pesquisa:
                         <return>%</return> para corresponder a zero ou mais caracteres
                         e <return>_</return> para corresponder a um único caractere.
  <info>string|null</info>  <strong>$types</strong>    If <strong>$table_type</strong> is not an empty string, it must contain a list of
                         comma-separated values for the types of interest; each value may be
                         enclosed in single quotes (<return>'</return>) or unquoted. For example, <return>'TABLE','VIEW'</return> or
                         <return>TABLE, VIEW</return>.  If the data source does not support a specified table type,
                         <strong>odbc_tables()</strong> does not return any results for that type.

<comment>Return:</comment>
  <info>resource|false</info>  Returns an ODBC result identifier containing the information  ou <info>false</info> em caso de
                  falha.
                  
                  The result set has the following columns:
                  <return>TABLE_CAT</return><return>TABLE_SCHEM</return><return>TABLE_NAME</return><return>TABLE_TYPE</return><return>REMARKS</return> Drivers podem listar colunas
                  adicionais.
                  
                  <return>TABLE_CAT</return>
                  
                  <return>TABLE_SCHEM</return>
                  
                  <return>TABLE_NAME</return>
                  
                  <return>TABLE_TYPE</return>
                  
                  <return>REMARKS</return>
                  
                  The result set is ordered by <return>TABLE_TYPE</return>, <return>TABLE_CAT</return>, <return>TABLE_SCHEM</return> and <return>TABLE_NAME</return>.

<comment>See Also:</comment>
   * <strong>odbc_tableprivileges()</strong>
   * <strong>odbc_columns()</strong>
   * <strong>odbc_specialcolumns()</strong>
   * <strong>odbc_statistics()</strong>
   * <strong>odbc_procedures()</strong>


id: opcache_compile_file
type: function
doc:
<comment>Description:</comment>
  Compila e armazena em cache um script PHP sem executá-lo
  
  Esta função compila um script PHP e o adiciona ao cache opcode sem executá-lo. Isso pode ser usado
  para preparar o cache após a reinicialização de um servidor da Web, armazenando previamente em
  cache os arquivos que serão incluídos em solicitações posteriores.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  O caminho para o script PHP a ser compilado.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se <strong>$filename</strong> foi compilado com sucesso ou <info>false</info> em caso de falha.

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


id: opcache_get_configuration
type: function
doc:
<comment>Description:</comment>
  Obtém informações de configuração sobre o cache
  
  Esta função retorna informações de configuração sobre a instância de cache

<comment>Return:</comment>
  <info>array|false</info>  Retorna uma série de informações, incluindo ini, blacklist e versão

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


id: opcache_get_status
type: function
doc:
<comment>Description:</comment>
  Obtém informações de status sobre o cache
  
  Essa função retorna informações de estado sobre a instância do cache na memória. Ele não retornará
  nenhuma informação sobre o cache do arquivo.

<comment>Param:</comment>
  <info>bool</info>  <strong>$include_scripts</strong>  Incluir informações de estado específicas do script

<comment>Return:</comment>
  <info>array|false</info>  Retorna uma matriz de informações, opcionalmente contendo informações de estado
               específicas do script, ou <info>false</info> em caso de falha.

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


id: opcache_invalidate
type: function
doc:
<comment>Description:</comment>
  Invalida um script em cache
  
  Esta função invalida um determinado script do cache opcode. Se <strong>$force</strong> não estiver definido ou for
  <info>false</info>, o script só será invalidado se o horário de modificação do script for mais recente que os
  opcodes armazenados em cache. Esta função invalida apenas o cache na memória e não o cache do
  arquivo.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  O caminho para o script que está sendo invalidado.
  <info>bool</info>    <strong>$force</strong>     Se definido como <info>true</info>, o script será invalidado independentemente de a
                     invalidação ser necessária.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se o cache do opcode para <strong>$filename</strong> foi invalidado ou se não havia nada para
        invalidar, ou <info>false</info> se o cache do opcode está desabilitado.

<comment>See Also:</comment>
   * <strong>opcache_compile_file()</strong>
   * <strong>opcache_reset()</strong>


id: opcache_is_script_cached
type: function
doc:
<comment>Description:</comment>
  Informa se um script é armazenado em cache no OPCache
  
  Esta função verifica se um script PHP foi armazenado em cache no OPCache. Isso pode ser usado para
  detectar mais facilmente o "aquecimento" do cache para um determinado script. Esta função verifica
  apenas o cache na memória, não o cache do arquivo.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  O caminho para o script PHP a ser verificado.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se <strong>$filename</strong> for armazenado em cache no OPCache, <info>false</info> caso contrário.

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


id: opcache_reset
type: function
doc:
<comment>Description:</comment>
  Redefine o conteúdo do cache opcode
  
  Esta função redefine todo o cache do opcode. Depois de chamar <strong>opcache_reset()</strong>, todos os scripts
  serão recarregados e reanalisados na próxima vez que forem atingidos. Esta função redefine apenas
  o cache na memória, não o cache do arquivo.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se o cache de opcode foi redefinido, ou <info>false</info> se o cache de opcode estiver
        desativado ou se a reinicialização estiver pendente ou em progresso (consulte
        <strong>opcache_get_status()</strong>).

<comment>See Also:</comment>
   * <strong>opcache_invalidate()</strong>
   * <strong>opcache_get_status()</strong>


id: openal_buffer_create
type: function
doc:
<comment>Description:</comment>
  Generate OpenAL buffer

<comment>Return:</comment>
  <info>resource</info>  Returns an Open AL(Buffer) resource on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>openal_buffer_loadwav()</strong>
   * <strong>openal_buffer_data()</strong>


id: openal_buffer_data
type: function
doc:
<comment>Description:</comment>
  Load a buffer with data

<comment>Param:</comment>
  <info>resource</info>  <strong>$buffer</strong>  An Open AL(Buffer) resource (previously created by <strong>openal_buffer_create()</strong>).
  <info>int</info>       <strong>$format</strong>  Format of <strong>$data</strong>, one of:  <info>AL_FORMAT_MONO8</info>, <info>AL_FORMAT_MONO16</info>, <info>AL_FORMAT_STEREO8</info>
                     e <info>AL_FORMAT_STEREO16</info>
  <info>string</info>    <strong>$data</strong>    Block of binary audio data in the <strong>$format</strong> and <strong>$freq</strong> specified.
  <info>int</info>       <strong>$freq</strong>    Frequency of <strong>$data</strong> given in Hz.

<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>openal_buffer_loadwav()</strong>
   * <strong>openal_stream()</strong>


id: openal_buffer_destroy
type: function
doc:
<comment>Description:</comment>
  Destroys an OpenAL buffer

<comment>Param:</comment>
  <info>resource</info>  <strong>$buffer</strong>  An Open AL(Buffer) resource (previously created by <strong>openal_buffer_create()</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>openal_buffer_create()</strong>


id: openal_buffer_get
type: function
doc:
<comment>Description:</comment>
  Retrieve an OpenAL buffer property

<comment>Param:</comment>
  <info>resource</info>  <strong>$buffer</strong>    An Open AL(Buffer) resource (previously created by <strong>openal_buffer_create()</strong>).
  <info>int</info>       <strong>$property</strong>  Specific property, one of: <info>AL_FREQUENCY</info>, <info>AL_BITS</info>, <info>AL_CHANNELS</info> e <info>AL_SIZE</info>.

<comment>Return:</comment>
  <info>int|false</info>  Returns an integer value appropriate to the <strong>$property</strong> requested ou <info>false</info> em caso de
             falha.

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


id: openal_buffer_loadwav
type: function
doc:
<comment>Description:</comment>
  Load a .wav file into a buffer

<comment>Param:</comment>
  <info>resource</info>  <strong>$buffer</strong>   An Open AL(Buffer) resource (previously created by <strong>openal_buffer_create()</strong>).
  <info>string</info>    <strong>$wavfile</strong>  Path to .wav file on local file system.

<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>openal_buffer_data()</strong>
   * <strong>openal_stream()</strong>


id: openal_context_create
type: function
doc:
<comment>Description:</comment>
  Create an audio processing context

<comment>Param:</comment>
  <info>resource</info>  <strong>$device</strong>  An Open AL(Device) resource (previously created by <strong>openal_device_open()</strong>).

<comment>Return:</comment>
  <info>resource</info>  Returns an Open AL(Context) resource on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>openal_device_open()</strong>
   * <strong>openal_context_destroy()</strong>


id: openal_context_current
type: function
doc:
<comment>Description:</comment>
  Make the specified context current

<comment>Param:</comment>
  <info>resource</info>  <strong>$context</strong>  An Open AL(Context) resource (previously created by <strong>openal_context_create()</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>openal_context_create()</strong>


id: openal_context_destroy
type: function
doc:
<comment>Description:</comment>
  Destroys a context

<comment>Param:</comment>
  <info>resource</info>  <strong>$context</strong>  An Open AL(Context) resource (previously created by <strong>openal_context_create()</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>openal_context_create()</strong>


id: openal_context_process
type: function
doc:
<comment>Description:</comment>
  Process the specified context

<comment>Param:</comment>
  <info>resource</info>  <strong>$context</strong>  An Open AL(Context) resource (previously created by <strong>openal_context_create()</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>openal_context_create()</strong>
   * <strong>openal_context_current()</strong>
   * <strong>openal_context_suspend()</strong>


id: openal_context_suspend
type: function
doc:
<comment>Description:</comment>
  Suspend the specified context

<comment>Param:</comment>
  <info>resource</info>  <strong>$context</strong>  An Open AL(Context) resource (previously created by <strong>openal_context_create()</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>openal_context_create()</strong>
   * <strong>openal_context_current()</strong>
   * <strong>openal_context_process()</strong>


id: openal_device_close
type: function
doc:
<comment>Description:</comment>
  Close an OpenAL device

<comment>Param:</comment>
  <info>resource</info>  <strong>$device</strong>  An Open AL(Device) resource (previously created by <strong>openal_device_open()</strong>) 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>openal_device_open()</strong>


id: openal_device_open
type: function
doc:
<comment>Description:</comment>
  Initialize the OpenAL audio layer

<comment>Param:</comment>
  <info>string</info>  <strong>$device_desc</strong>  Open an audio device optionally specified by <strong>$device_desc</strong>. If <strong>$device_desc</strong>
                        is not specified the first available audio device will be used.

<comment>Return:</comment>
  <info>resource</info>  Returns an Open AL(Device) resource on success or  <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>openal_device_close()</strong>
   * <strong>openal_context_create()</strong>


id: openal_listener_get
type: function
doc:
<comment>Description:</comment>
  Retrieve a listener property

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>  Property to retrieve, one of: <info>AL_GAIN</info> (float), <info>AL_POSITION</info>
                  (array(float,float,float)), <info>AL_VELOCITY</info> (array(float,float,float)) e
                  <info>AL_ORIENTATION</info> (array(float,float,float)).

<comment>Return:</comment>
  <info>mixed</info>  Returns a float or array of floats (as appropriate) ou <info>false</info> em caso de falha.

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


id: openal_listener_set
type: function
doc:
<comment>Description:</comment>
  Set a listener property

<comment>Param:</comment>
  <info>int</info>    <strong>$property</strong>  Property to set, one of: <info>AL_GAIN</info> (float), <info>AL_POSITION</info>
                    (array(float,float,float)), <info>AL_VELOCITY</info> (array(float,float,float)) e
                    <info>AL_ORIENTATION</info> (array(float,float,float)).
  <info>mixed</info>  <strong>$setting</strong>   Value to set, either float, or an array of floats as appropriate.

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


id: openal_source_create
type: function
doc:
<comment>Description:</comment>
  Generate a source resource

<comment>Return:</comment>
  <info>resource</info>  Returns an Open AL(Source) resource on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>openal_source_set()</strong>
   * <strong>openal_source_play()</strong>
   * <strong>openal_source_destroy()</strong>


id: openal_source_destroy
type: function
doc:
<comment>Description:</comment>
  Destroy a source resource

<comment>Param:</comment>
  <info>resource</info>  <strong>$source</strong>  An Open AL(Source) resource (previously created by <strong>openal_source_create()</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>openal_source_create()</strong>


id: openal_source_get
type: function
doc:
<comment>Description:</comment>
  Retrieve an OpenAL source property

<comment>Param:</comment>
  <info>resource</info>  <strong>$source</strong>    An Open AL(Source) resource (previously created by <strong>openal_source_create()</strong>).
  <info>int</info>       <strong>$property</strong>  Property to get, one of: <info>AL_SOURCE_RELATIVE</info> (int), <info>AL_SOURCE_STATE</info> (int),
                       <info>AL_PITCH</info> (float), <info>AL_GAIN</info> (float), <info>AL_MIN_GAIN</info> (float), <info>AL_MAX_GAIN</info> (float),
                       <info>AL_MAX_DISTANCE</info> (float), <info>AL_ROLLOFF_FACTOR</info> (float), <info>AL_CONE_OUTER_GAIN</info>
                       (float), <info>AL_CONE_INNER_ANGLE</info> (float), <info>AL_CONE_OUTER_ANGLE</info> (float),
                       <info>AL_REFERENCE_DISTANCE</info> (float), <info>AL_POSITION</info> (array(float,float,float)),
                       <info>AL_VELOCITY</info> (array(float,float,float)), <info>AL_DIRECTION</info>
                       (array(float,float,float)).

<comment>Return:</comment>
  <info>mixed</info>  Returns the type associated with the property being retrieved ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>openal_source_create()</strong>
   * <strong>openal_source_set()</strong>
   * <strong>openal_source_play()</strong>


id: openal_source_pause
type: function
doc:
<comment>Description:</comment>
  Pause the source

<comment>Param:</comment>
  <info>resource</info>  <strong>$source</strong>  An Open AL(Source) resource (previously created by <strong>openal_source_create()</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>openal_source_stop()</strong>
   * <strong>openal_source_play()</strong>
   * <strong>openal_source_rewind()</strong>


id: openal_source_play
type: function
doc:
<comment>Description:</comment>
  Start playing the source

<comment>Param:</comment>
  <info>resource</info>  <strong>$source</strong>  An Open AL(Source) resource (previously created by <strong>openal_source_create()</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>openal_source_stop()</strong>
   * <strong>openal_source_pause()</strong>
   * <strong>openal_source_rewind()</strong>


id: openal_source_rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the source

<comment>Param:</comment>
  <info>resource</info>  <strong>$source</strong>  An Open AL(Source) resource (previously created by <strong>openal_source_create()</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>openal_source_stop()</strong>
   * <strong>openal_source_pause()</strong>
   * <strong>openal_source_play()</strong>


id: openal_source_set
type: function
doc:
<comment>Description:</comment>
  Set source property

<comment>Param:</comment>
  <info>resource</info>  <strong>$source</strong>    An Open AL(Source) resource (previously created by <strong>openal_source_create()</strong>).
  <info>int</info>       <strong>$property</strong>  Property to set, one of: <info>AL_BUFFER</info> (OpenAL(Source)), <info>AL_LOOPING</info> (bool),
                       <info>AL_SOURCE_RELATIVE</info> (int), <info>AL_SOURCE_STATE</info> (int), <info>AL_PITCH</info> (float), <info>AL_GAIN</info>
                       (float), <info>AL_MIN_GAIN</info> (float), <info>AL_MAX_GAIN</info> (float), <info>AL_MAX_DISTANCE</info> (float),
                       <info>AL_ROLLOFF_FACTOR</info> (float), <info>AL_CONE_OUTER_GAIN</info> (float), <info>AL_CONE_INNER_ANGLE</info>
                       (float), <info>AL_CONE_OUTER_ANGLE</info> (float), <info>AL_REFERENCE_DISTANCE</info> (float),
                       <info>AL_POSITION</info> (array(float,float,float)), <info>AL_VELOCITY</info>
                       (array(float,float,float)), <info>AL_DIRECTION</info> (array(float,float,float)).
  <info>mixed</info>     <strong>$setting</strong>   Value to assign to specified <strong>$property</strong>. Refer to the description of <strong>$property</strong>
                       for a description of the value(s) expected.

<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>openal_source_create()</strong>
   * <strong>openal_source_get()</strong>
   * <strong>openal_source_play()</strong>


id: openal_source_stop
type: function
doc:
<comment>Description:</comment>
  Stop playing the source

<comment>Param:</comment>
  <info>resource</info>  <strong>$source</strong>  An Open AL(Source) resource (previously created by <strong>openal_source_create()</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>openal_source_play()</strong>
   * <strong>openal_source_pause()</strong>
   * <strong>openal_source_rewind()</strong>


id: openal_stream
type: function
doc:
<comment>Description:</comment>
  Begin streaming on a source

<comment>Param:</comment>
  <info>resource</info>  <strong>$source</strong>  An Open AL(Source) resource (previously created by <strong>openal_source_create()</strong>).
  <info>int</info>       <strong>$format</strong>  Format of <strong>$data</strong>, one of: <info>AL_FORMAT_MONO8</info>, <info>AL_FORMAT_MONO16</info>, <info>AL_FORMAT_STEREO8</info> e
                     <info>AL_FORMAT_STEREO16</info>
  <info>int</info>       <strong>$rate</strong>    Frequency of data to stream given in Hz.

<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>openal_source_create()</strong>
   * <strong>fwrite()</strong>


id: opendir
type: function
doc:
<comment>Description:</comment>
  Abre um manipulador de diretório
  
  Abre um manipulador de diretório para ser usado em chamadas subsequentes de <strong>closedir()</strong>, <strong>readdir()</strong>
  e <strong>rewinddir()</strong>.

<comment>Param:</comment>
  <info>string</info>         <strong>$directory</strong>  O caminho do diretório a ser aberto
  <info>resource|null</info>  <strong>$context</strong>    Para descrição do parâmetro <strong>$context</strong>, consulte a seção sobre fluxos do
                             manual.

<comment>Return:</comment>
  <info>resource|false</info>  Retorna um manipulador de diretório do tipo <info>resource</info> em caso de sucesso, ou <info>false</info>
                  em caso de falha

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


id: openlog
type: function
doc:
<comment>Description:</comment>
  Open connection to system logger
  
  <strong>openlog()</strong> opens a connection to the system logger for a program.
  
  The use of <strong>openlog()</strong> is optional. It will automatically be called by <strong>syslog()</strong> if necessary, in
  which case <strong>$prefix</strong> will default to <info>false</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>    The string <strong>$prefix</strong> is added to each message.
  <info>int</info>     <strong>$flags</strong>     The <strong>$flags</strong> argument is used to indicate what logging options will be used when
                     generating a log message. <strong>openlog()</strong> OptionsConstantDescription<info>LOG_CONS</info> if there
                     is an error while sending data to the system logger, write directly to the
                     system console <info>LOG_NDELAY</info> open the connection to the logger immediately
                     <info>LOG_ODELAY</info> (default) delay opening the connection until the first message is
                     logged <info>LOG_PERROR</info>print log message also to standard error<info>LOG_PID</info>include PID
                     with each message You can use one or more of these options. When using multiple
                     options you need to <return>OR</return> them, i.e. to open the connection immediately, write to
                     the console and include the PID in each message, you will use: <return>LOG_CONS |
                     LOG_NDELAY | LOG_PID</return>
  <info>int</info>     <strong>$facility</strong>  The <strong>$facility</strong> argument is used to specify what type of program is logging the
                     message. This allows you to specify (in your machine's syslog configuration)
                     how messages coming from different facilities will be handled. <strong>openlog()</strong>
                     FacilitiesConstantDescription<info>LOG_AUTH</info> security/authorization messages (use
                     <info>LOG_AUTHPRIV</info> instead in systems where that constant is defined)
                     <info>LOG_AUTHPRIV</info>security/authorization messages (private)<info>LOG_CRON</info>clock daemon (cron
                     and at)<info>LOG_DAEMON</info>other system daemons<info>LOG_KERN</info>kernel messages<info>LOG_LOCAL0</info> ...
                     <info>LOG_LOCAL7</info>reserved for local use, these are not available in Windows<info>LOG_LPR</info>line
                     printer subsystem<info>LOG_MAIL</info>mail subsystem<info>LOG_NEWS</info>USENET news
                     subsystem<info>LOG_SYSLOG</info>messages generated internally by syslogd<info>LOG_USER</info>generic
                     user-level messages<info>LOG_UUCP</info>UUCP subsystem
                     
                     <info>LOG_USER</info> is the only valid log type under Windows operating systems

<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>syslog()</strong>
   * <strong>closelog()</strong>


id: openssl_cipher_iv_length
type: function
doc:
<comment>Description:</comment>
  Gets the cipher iv length
  
  Gets the cipher initialization vector (iv) length.

<comment>Param:</comment>
  <info>string</info>  <strong>$cipher_algo</strong>  The cipher method, see <strong>openssl_get_cipher_methods()</strong> for a list of potential
                        values.

<comment>Return:</comment>
  <info>int|false</info>  Returns the cipher length on success, or <info>false</info> on failure.


id: openssl_cipher_key_length
type: function
doc:
<comment>Description:</comment>
  Gets the cipher key length
  
  Gets the cipher key length.

<comment>Param:</comment>
  <info>string</info>  <strong>$cipher_algo</strong>  The cipher method, see <strong>openssl_get_cipher_methods()</strong> for a list of potential
                        values.

<comment>Return:</comment>
  <info>int|false</info>  Returns the cipher length on success,  ou <info>false</info> em caso de falha.


id: openssl_cms_decrypt
type: function
doc:
<comment>Description:</comment>
  Decrypt a CMS message
  
  Decrypts a CMS message.

<comment>Param:</comment>
  <info>string</info>                                                     <strong>$input_filename</strong>   The name of a file
                                                                               containing encrypted
                                                                               content.
  <info>string</info>                                                     <strong>$output_filename</strong>  The name of the file
                                                                               to deposit the
                                                                               decrypted content.
  <info>OpenSSLCertificate|string</info>                                  <strong>$certificate</strong>      The name of the file
                                                                               containing a
                                                                               certificate of the
                                                                               recipient.
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string|null</info>  <strong>$private_key</strong>      The name of the file
                                                                               containing a PKCS#8
                                                                               key.
  <info>int</info>                                                        <strong>$encoding</strong>         The encoding of the
                                                                               input file. One of
                                                                               <info>OPENSSL_ENCODING_SMIME</info>,
                                                                               <info>OPENSSL_ENCODING_DER</info>
                                                                               or
                                                                               <info>OPENSSL_ENCODING_PEM</info>.

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


id: openssl_cms_encrypt
type: function
doc:
<comment>Description:</comment>
  Encrypt a CMS message
  
  This function encrypts content to one or more recipients, based on the certificates that are
  passed to it.

<comment>Param:</comment>
  <info>string</info>                           <strong>$input_filename</strong>   The file to be encrypted.
  <info>string</info>                           <strong>$output_filename</strong>  The output file.
  <info>OpenSSLCertificate|array|string</info>  <strong>$certificate</strong>      Recipients to encrypt to.
  <info>array|null</info>                       <strong>$headers</strong>          Headers to include when S/MIME is used.
  <info>int</info>                              <strong>$flags</strong>            Flags to be passed to CMS_sign.
  <info>int</info>                              <strong>$encoding</strong>         An encoding to output. One of
                                                     <info>OPENSSL_ENCODING_SMIME</info>, <info>OPENSSL_ENCODING_DER</info> or
                                                     <info>OPENSSL_ENCODING_PEM</info>.
  <info>int</info>                              <strong>$cipher_algo</strong>      A cypher to use.

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


id: openssl_cms_read
type: function
doc:
<comment>Description:</comment>
  Export the CMS file to an array of PEM certificates
  
  Performs the exact analog to <strong>openssl_pkcs7_read()</strong>.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$input_filename</strong>  
  <info>array</info>   <strong>$certificates</strong>    

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


id: openssl_cms_sign
type: function
doc:
<comment>Description:</comment>
  Sign a file
  
  This function signs a file with an X.509 certificate and key.

<comment>Param:</comment>
  <info>string</info>                                                <strong>$input_filename</strong>                   The name
                                                                                          of the
                                                                                          file to be
                                                                                          signed.
  <info>string</info>                                                <strong>$output_filename</strong>                  The name
                                                                                          of the
                                                                                          file to
                                                                                          deposit
                                                                                          the
                                                                                          results.
  <info>OpenSSLCertificate|string</info>                             <strong>$certificate</strong>                      The
                                                                                          signing
                                                                                          certificate.
                                                                                          See
                                                                                          Key/Certificate
                                                                                          parameters
                                                                                          for a list
                                                                                          of valid
                                                                                          values.
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>                      The key
                                                                                          associated
                                                                                          with
                                                                                          <strong>$certificate</strong>.
                                                                                          See
                                                                                          Key/Certificate
                                                                                          parameters
                                                                                          for a list
                                                                                          of valid
                                                                                          values.
  <info>array|null</info>                                            <strong>$headers</strong>                          An array
                                                                                          of headers
                                                                                          to be
                                                                                          included
                                                                                          in S/MIME
                                                                                          output.
  <info>int</info>                                                   <strong>$flags</strong>                            Flags to
                                                                                          be passed
                                                                                          to
                                                                                          <strong>cms_sign()</strong>.
  <info>int</info>                                                   <strong>$encoding</strong>                         The
                                                                                          encoding
                                                                                          of the
                                                                                          output
                                                                                          file. One
                                                                                          of
                                                                                          <info>OPENSSL_ENCODING_SMIME</info>,
                                                                                          <info>OPENSSL_ENCODING_DER</info>
                                                                                          or
                                                                                          <info>OPENSSL_ENCODING_PEM</info>.
  <info>string|null</info>                                           <strong>$untrusted_certificates_filename</strong>  
                                                                                          Intermediate
                                                                                          certificates
                                                                                          to be
                                                                                          included
                                                                                          in the
                                                                                          signature.

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


id: openssl_cms_verify
type: function
doc:
<comment>Description:</comment>
  Verify a CMS signature
  
  This function verifies a CMS signature, either attached or detached, with the specified encoding.

<comment>Param:</comment>
  <info>string</info>       <strong>$input_filename</strong>                   The input file.
  <info>int</info>          <strong>$flags</strong>                            Flags to pass to <strong>cms_verify()</strong>.
  <info>string|null</info>  <strong>$certificates</strong>                     A file with the signer certificate and optionally
                                                 intermediate certificates.
  <info>array</info>        <strong>$ca_info</strong>                          An array containing self-signed certificate
                                                 authority certificates.
  <info>string|null</info>  <strong>$untrusted_certificates_filename</strong>  A file containing additional intermediate
                                                 certificates.
  <info>string|null</info>  <strong>$content</strong>                          A file pointing to the content when signatures are
                                                 detached.
  <info>string|null</info>  <strong>$pk7</strong>                              
  <info>string|null</info>  <strong>$sigfile</strong>                          A file to save the signature to.
  <info>int</info>          <strong>$encoding</strong>                         The encoding of the input file. One of
                                                 <info>OPENSSL_ENCODING_SMIME</info>, <info>OPENSSL_ENCODING_DER</info> or
                                                 <info>OPENSSL_ENCODING_PEM</info>.

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


id: openssl_csr_export
type: function
doc:
<comment>Description:</comment>
  Exports a CSR as a string
  
  <strong>openssl_csr_export()</strong> takes the Certificate Signing Request represented by <strong>$csr</strong> and stores it in
  PEM format in <strong>$output</strong>, which is passed by reference.

<comment>Param:</comment>
  <info>OpenSSLCertificateSigningRequest|string</info>  <strong>$csr</strong>      Consulte Parâmetros CSR para obter uma lista de
                                                     valores válidos.
  <info>string</info>                                   <strong>$output</strong>   on success, this string will contain the PEM
                                                     encoded CSR
  <info>bool</info>                                     <strong>$no_text</strong>  O parâmetro opcional <strong>$notext</strong> afeta a
                                                     verbosidade da saída; se for <info>false</info>, então
                                                     informações adicionais legíveis para humanos
                                                     serão incluídas na saída. O valor padrão de
                                                     <strong>$notext</strong> é <info>true</info>.

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

<comment>See Also:</comment>
   * <strong>openssl_csr_export_to_file()</strong>
   * <strong>openssl_csr_new()</strong>
   * <strong>openssl_csr_sign()</strong>


id: openssl_csr_export_to_file
type: function
doc:
<comment>Description:</comment>
  Exports a CSR to a file
  
  <strong>openssl_csr_export_to_file()</strong> takes the Certificate Signing Request represented by <strong>$csr</strong> and saves
  it in PEM format into the file named by <strong>$output_filename</strong>.

<comment>Param:</comment>
  <info>OpenSSLCertificateSigningRequest|string</info>  <strong>$csr</strong>              Consulte Parâmetros CSR para obter uma
                                                             lista de valores válidos.
  <info>string</info>                                   <strong>$output_filename</strong>  Path to the output file.
  <info>bool</info>                                     <strong>$no_text</strong>          O parâmetro opcional <strong>$notext</strong> afeta a
                                                             verbosidade da saída; se for <info>false</info>,
                                                             então informações adicionais legíveis
                                                             para humanos serão incluídas na saída.
                                                             O valor padrão de <strong>$notext</strong> é <info>true</info>.

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

<comment>See Also:</comment>
   * <strong>openssl_csr_export()</strong>
   * <strong>openssl_csr_new()</strong>
   * <strong>openssl_csr_sign()</strong>


id: openssl_csr_get_public_key
type: function
doc:
<comment>Description:</comment>
  Returns the public key of a CSR
  
  <strong>openssl_csr_get_public_key()</strong> extracts the public key  from <strong>$csr</strong> and prepares it for use by other
  functions.

<comment>Param:</comment>
  <info>OpenSSLCertificateSigningRequest|string</info>  <strong>$csr</strong>          Consulte Parâmetros CSR para obter uma
                                                         lista de valores válidos.
  <info>bool</info>                                     <strong>$short_names</strong>  This parameter is ignored

<comment>Return:</comment>
  <info>OpenSSLAsymmetricKey|false</info>  Returns an <class>OpenSSLAsymmetricKey</class> on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>openssl_csr_get_subject()</strong>
   * <strong>openssl_csr_new()</strong>
   * <strong>openssl_pkey_get_details()</strong>
   * <strong>openssl_pkey_export_to_file()</strong>
   * <strong>openssl_pkey_export()</strong>


id: openssl_csr_get_subject
type: function
doc:
<comment>Description:</comment>
  Returns the subject of a CSR
  
  <strong>openssl_csr_get_subject()</strong> returns subject distinguished name information encoded in the <strong>$csr</strong>
  including fields commonName (CN), organizationName (O), countryName (C) etc.

<comment>Param:</comment>
  <info>OpenSSLCertificateSigningRequest|string</info>  <strong>$csr</strong>          Consulte Parâmetros CSR para obter uma
                                                         lista de valores válidos.
  <info>bool</info>                                     <strong>$short_names</strong>  <strong>$shortnames</strong> controls how the data is
                                                         indexed in the array - if <strong>$shortnames</strong> is
                                                         <info>true</info> (the default) then fields will be
                                                         indexed with the short name form,
                                                         otherwise, the long name form will be used
                                                         - e.g.: CN is the shortname form of
                                                         commonName.

<comment>Return:</comment>
  <info>array|false</info>  Returns an associative array with subject description,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>openssl_csr_new()</strong>
   * <strong>openssl_csr_get_public_key()</strong>
   * <strong>openssl_x509_parse()</strong>


id: openssl_csr_new
type: function
doc:
<comment>Description:</comment>
  Generates a CSR
  
  <strong>openssl_csr_new()</strong> generates a new CSR based on the information provided by <strong>$distinguished_names</strong>.
  
  É preciso ter um arquivo openssl.cnf válido instalado para que esta função funcione corretamente.
  Consulte as notas na seção de instalação para obter mais informações.

<comment>Param:</comment>
  <info>array</info>                 <strong>$distinguished_names</strong>  The Distinguished Name or subject fields to be used in
                                              the certificate.
  <info>OpenSSLAsymmetricKey</info>  <strong>$private_key</strong>          <strong>$private_key</strong> should be set to a private key that was
                                              previously generated by <strong>openssl_pkey_new()</strong> (or
                                              otherwise obtained from the other openssl_pkey family
                                              of functions). The corresponding public portion of the
                                              key will be used to sign the CSR.
  <info>array|null</info>            <strong>$options</strong>              By default, the information in your system
                                              <return>openssl.conf</return> is used to initialize the request; you
                                              can specify a configuration file section by setting
                                              the <return>config_section_section</return> key of <strong>$options</strong>.  You can
                                              also specify an alternative openssl configuration file
                                              by setting the value of the <return>config</return> key to the path of
                                              the file you want to use. The following keys, if
                                              present in <strong>$options</strong> behave as their equivalents in the
                                              <return>openssl.conf</return>, as listed in the table below.
                                              Configuration overrides<strong>$options</strong> keytype<return>openssl.conf</return>
                                              equivalentdescriptiondigest_alg<info>string</info>default_mdDigest
                                              method or signature hash, usually one of
                                              <strong>openssl_get_md_methods()</strong>x509_extensions<info>string</info>x509_extensionsSelects
                                              which extensions should be used when creating an x509
                                              certificatereq_extensions<info>string</info>req_extensionsSelects
                                              which extensions should be used when creating a
                                              CSRprivate_key_bits<info>int</info>default_bitsSpecifies how many
                                              bits should be used to generate a private
                                              keyprivate_key_type<info>int</info>noneSpecifies the type of
                                              private key to create.  This can be one of
                                              <info>OPENSSL_KEYTYPE_DSA</info>, <info>OPENSSL_KEYTYPE_DH</info>,
                                              <info>OPENSSL_KEYTYPE_RSA</info> or <info>OPENSSL_KEYTYPE_EC</info>. The default
                                              value is <info>OPENSSL_KEYTYPE_RSA</info>.
                                              encrypt_key<info>bool</info>encrypt_keyShould an exported key (with
                                              passphrase) be encrypted?encrypt_key_cipher<info>int</info>none One
                                              of cipher constants. curve_name<info>string</info>none One of
                                              <strong>openssl_get_curve_names()</strong>. config<info>string</info>N/A Path to
                                              your own alternative openssl.conf file.
  <info>array|null</info>            <strong>$extra_attributes</strong>     <strong>$extra_attributes</strong> is used to specify additional
                                              configuration options for the CSR.  Both
                                              <strong>$distinguished_names</strong> and <strong>$extra_attributes</strong> are
                                              associative arrays whose keys are converted to OIDs
                                              and applied to the relevant part of the request.

<comment>Return:</comment>
  <info>OpenSSLCertificateSigningRequest|false</info>  Returns the CSR ou <info>false</info> em caso de falha.

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


id: openssl_csr_sign
type: function
doc:
<comment>Description:</comment>
  Sign a CSR with another certificate (or itself) and generate a certificate
  
  <strong>openssl_csr_sign()</strong> generates an x509 certificate from the given CSR.
  
  É preciso ter um arquivo openssl.cnf válido instalado para que esta função funcione corretamente.
  Consulte as notas na seção de instalação para obter mais informações.

<comment>Param:</comment>
  <info>OpenSSLCertificateSigningRequest|string</info>               <strong>$csr</strong>             A CSR previously generated
                                                                         by <strong>openssl_csr_new()</strong>. It
                                                                         can also be the path to a
                                                                         PEM encoded CSR when
                                                                         specified as
                                                                         file://path/to/csr or an
                                                                         exported string generated
                                                                         by <strong>openssl_csr_export()</strong>.
  <info>OpenSSLCertificate|string|null</info>                        <strong>$ca_certificate</strong>  The generated certificate
                                                                         will be signed by
                                                                         <strong>$ca_certificate</strong>. If
                                                                         <strong>$ca_certificate</strong> is <info>null</info>,
                                                                         the generated certificate
                                                                         will be a self-signed
                                                                         certificate.
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>     <strong>$private_key</strong> is the private
                                                                         key that corresponds to
                                                                         <strong>$ca_certificate</strong>.
  <info>int</info>                                                   <strong>$days</strong>            <strong>$days</strong> specifies the length
                                                                         of time for which the
                                                                         generated certificate will
                                                                         be valid, in days.
  <info>array|null</info>                                            <strong>$options</strong>         You can finetune the CSR
                                                                         signing by <strong>$options</strong>. See
                                                                         <strong>openssl_csr_new()</strong> for more
                                                                         information about <strong>$options</strong>.
  <info>int</info>                                                   <strong>$serial</strong>          An optional the serial
                                                                         number of issued
                                                                         certificate. If not
                                                                         specified it will default
                                                                         to 0.

<comment>Return:</comment>
  <info>OpenSSLCertificate|false</info>  Returns an <class>OpenSSLCertificate</class> on success, <info>false</info> on failure.


id: openssl_decrypt
type: function
doc:
<comment>Description:</comment>
  Decrypts data
  
  Takes a raw or base64 encoded string and decrypts it using a given method and key.

<comment>Param:</comment>
  <info>string</info>       <strong>$data</strong>         The encrypted message to be decrypted.
  <info>string</info>       <strong>$cipher_algo</strong>  The cipher method. For a list of available cipher methods, use
                             <strong>openssl_get_cipher_methods()</strong>.
  <info>string</info>       <strong>$passphrase</strong>   The key.
  <info>int</info>          <strong>$options</strong>      <strong>$options</strong> can be one of <info>OPENSSL_RAW_DATA</info>, <info>OPENSSL_ZERO_PADDING</info>.
  <info>string</info>       <strong>$iv</strong>           A non-NULL Initialization Vector.
  <info>string|null</info>  <strong>$tag</strong>          The authentication tag in AEAD cipher mode. If it is incorrect, the
                             authentication fails and the function returns <info>false</info>.
                             
                             The length of the <strong>$tag</strong> is not checked by the function. It is the
                             caller's responsibility to ensure that the length of the tag matches
                             the length of the tag retrieved when <strong>openssl_encrypt()</strong> has been called.
                             Otherwise the decryption may succeed if the given tag only matches the
                             start of the proper tag.
  <info>string</info>       <strong>$aad</strong>          Additional authenticated data.

<comment>Return:</comment>
  <info>string|false</info>  The decrypted string on success ou <info>false</info> em caso de falha.

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


id: openssl_dh_compute_key
type: function
doc:
<comment>Description:</comment>
  Computes shared secret for public value of remote DH public key and local DH key
  
  The shared secret returned by <strong>openssl_dh_compute_key()</strong> is often used as an encryption key to
  secretly communicate with a remote party. This is known as the Diffie-Hellman key exchange.
  
  ECDH is only supported as of PHP 8.1.0 and OpenSSL 3.0.0.

<comment>Param:</comment>
  <info>string</info>                <strong>$public_key</strong>   DH Public key of the remote party.
  <info>OpenSSLAsymmetricKey</info>  <strong>$private_key</strong>  A local DH private key, corresponding to the public key to be
                                      shared with the remote party.

<comment>Return:</comment>
  <info>string|false</info>  Returns shared secret on success ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>openssl_pkey_new()</strong>
   * <strong>openssl_pkey_get_details()</strong>
   * <strong>openssl_pkey_get_private()</strong>
   * <strong>openssl_pkey_get_public()</strong>


id: openssl_digest
type: function
doc:
<comment>Description:</comment>
  Computes a digest
  
  Computes a digest hash value for the given data using a given method, and returns a raw or binhex
  encoded string.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>         The data.
  <info>string</info>  <strong>$digest_algo</strong>  The digest method to use, e.g. "sha256", see <strong>openssl_get_md_methods()</strong> for a
                        list of available digest methods.
  <info>bool</info>    <strong>$binary</strong>       Setting to <info>true</info> will return as raw output data, otherwise the return value
                        is binhex encoded.

<comment>Return:</comment>
  <info>string|false</info>  Returns the digested hash value on success ou <info>false</info> em caso de falha.

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


id: openssl_encrypt
type: function
doc:
<comment>Description:</comment>
  Encrypts data
  
  Encrypts given data with given method and key, returns a raw or base64 encoded string

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>         The plaintext message data to be encrypted.
  <info>string</info>  <strong>$cipher_algo</strong>  The cipher method. For a list of available cipher methods, use
                        <strong>openssl_get_cipher_methods()</strong>.
  <info>string</info>  <strong>$passphrase</strong>   The passphrase. If the passphrase is shorter than expected, it is silently
                        padded with <return>NUL</return> characters; if the passphrase is longer than expected, it is
                        silently truncated.
  <info>int</info>     <strong>$options</strong>      <strong>$options</strong> is a bitwise disjunction of the flags <info>OPENSSL_RAW_DATA</info> and
                        <info>OPENSSL_ZERO_PADDING</info>.
  <info>string</info>  <strong>$iv</strong>           A non-NULL Initialization Vector.
  <info>string</info>  <strong>$tag</strong>          The authentication tag passed by reference when using AEAD cipher mode (GCM
                        or CCM).
  <info>string</info>  <strong>$aad</strong>          Additional authenticated data.
  <info>int</info>     <strong>$tag_length</strong>   The length of the authentication <strong>$tag</strong>. Its value can be between 4 and 16 for
                        GCM mode.

<comment>Return:</comment>
  <info>string|false</info>  Returns the encrypted string on success ou <info>false</info> em caso de falha.

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


id: openssl_error_string
type: function
doc:
<comment>Description:</comment>
  Return openSSL error message
  
  <strong>openssl_error_string()</strong> returns the last error from the openSSL library.  Error messages are
  queued, so this function should be called multiple times to collect all of the information. The
  last error will be the most recent one.

<comment>Return:</comment>
  <info>string|false</info>  Returns an error message string, or <info>false</info> if there are no more error messages to
                return.


id: openssl_free_key
type: function
doc:
<comment>Description:</comment>
  Free key resource
  
  <strong>openssl_free_key()</strong> frees the key associated with the specified <strong>$key</strong> from memory.

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey</info>  <strong>$key</strong>  

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


id: openssl_get_cert_locations
type: function
doc:
<comment>Description:</comment>
  Retrieve the available certificate locations
  
  <strong>openssl_get_cert_locations()</strong> returns an array with information about the available certificate
  locations that will be searched for SSL certificates.

<comment>Return:</comment>
  <info>array</info>  Returns an array with the available certificate locations.


id: openssl_get_cipher_methods
type: function
doc:
<comment>Description:</comment>
  Gets available cipher methods
  
  Gets a list of available cipher methods.

<comment>Param:</comment>
  <info>bool</info>  <strong>$aliases</strong>  Set to <info>true</info> if cipher aliases should be included within the returned <info>array</info>.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of available cipher methods. Note that prior to OpenSSL 1.1.1, the cipher methods
         have been returned in upper case and lower case spelling; as of OpenSSL 1.1.1 only the
         lower case variants are returned.

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


id: openssl_get_curve_names
type: function
doc:
<comment>Description:</comment>
  Gets list of available curve names for ECC
  
  Gets the list of available curve names for use in Elliptic curve  cryptography (ECC) for
  public/private key operations. The two most widely  standardized/supported curves are prime256v1
  (NIST P-256) and secp384r1 (NIST P-384). Approximate Equivalancies of AES, RSA, DSA and ECC
  KeysizesAES Symmetric Keysize (Bits)RSA and DSA Keysize (Bits)ECC Keysize
  (Bits)80102416011220482241283072256192768038425615360512 NIST  recommends using ECC curves with at
  least 256 bits.

<comment>Return:</comment>
  <info>array|false</info>  An <info>array</info> of available curve names,  ou <info>false</info> em caso de falha.


id: openssl_get_md_methods
type: function
doc:
<comment>Description:</comment>
  Gets available digest methods
  
  Gets a list of available digest methods.

<comment>Param:</comment>
  <info>bool</info>  <strong>$aliases</strong>  Set to <info>true</info> if digest aliases should be included within the returned <info>array</info>.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of available digest methods.

<comment>See Also:</comment>
   * <strong>openssl_digest()</strong>
   * <strong>openssl_get_cipher_methods()</strong>


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


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


id: openssl_open
type: function
doc:
<comment>Description:</comment>
  Open sealed data
  
  <strong>openssl_open()</strong> opens (decrypts) <strong>$data</strong> using the private key associated with the key identifier
  <strong>$private_key</strong> and the envelope key <strong>$encrypted_key</strong>, and fills <strong>$output</strong> with the decrypted data. The
  envelope key is generated when the data are sealed and can only be used by one specific private
  key. See <strong>openssl_seal()</strong> for more information.

<comment>Param:</comment>
  <info>string</info>                                                <strong>$data</strong>           
  <info>string</info>                                                <strong>$output</strong>         If the call is successful
                                                                        the opened data is returned
                                                                        in this parameter.
  <info>string</info>                                                <strong>$encrypted_key</strong>  
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>    
  <info>string</info>                                                <strong>$cipher_algo</strong>    The cipher method.  The
                                                                        default value (<return>'RC4'</return>) is
                                                                        considered insecure. It is
                                                                        strongly recommended to
                                                                        explicitly specify a secure
                                                                        cipher method.
                                                                        
                                                                        The default value (<return>'RC4'</return>) is
                                                                        considered insecure. It is
                                                                        strongly recommended to
                                                                        explicitly specify a secure
                                                                        cipher method.
  <info>string|null</info>                                           <strong>$iv</strong>             The initialization vector.

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


id: openssl_pbkdf2
type: function
doc:
<comment>Description:</comment>
  Generates a PKCS5 v2 PBKDF2 string
  
  <strong>openssl_pbkdf2()</strong> computes PBKDF2 (Password-Based Key Derivation Function 2), a key derivation
  function defined in PKCS5 v2.

<comment>Param:</comment>
  <info>string</info>  <strong>$password</strong>     Password from which the derived key is generated.
  <info>string</info>  <strong>$salt</strong>         PBKDF2 recommends a crytographic salt of at least 64 bits (8 bytes).
  <info>int</info>     <strong>$key_length</strong>   Length of desired output key.
  <info>int</info>     <strong>$iterations</strong>   The number of iterations desired. NIST  recommends at least 10,000.
  <info>string</info>  <strong>$digest_algo</strong>  Optional hash or digest algorithm from <strong>openssl_get_md_methods()</strong>.  Defaults
                        to SHA-1.

<comment>Return:</comment>
  <info>string|false</info>  Returns raw binary string ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>hash_pbkdf2()</strong>
   * <strong>openssl_get_md_methods()</strong>


id: openssl_pkcs12_export
type: function
doc:
<comment>Description:</comment>
  Exports a PKCS#12 Compatible Certificate Store File to variable
  
  <strong>openssl_pkcs12_export()</strong> stores <strong>$certificate</strong> into a string named by <strong>$output</strong> in a PKCS#12 file
  format.

<comment>Param:</comment>
  <info></info>                                                      <strong>$x509</strong>         Consulte Parâmetros
                                                                      Chave/Certificado para obter
                                                                      uma lista de valores válidos.
  <info>string</info>                                                <strong>$output</strong>       On success, this will hold the
                                                                      PKCS#12.
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>  Private key component of
                                                                      PKCS#12 file. See
                                                                      Public/Private Key parameters
                                                                      for a list of valid values.
  <info>string</info>                                                <strong>$passphrase</strong>   Encryption password for
                                                                      unlocking the PKCS#12 file.
  <info>array</info>                                                 <strong>$options</strong>      Optional array, other keys
                                                                      will be ignored.
                                                                      KeyDescrição<return>"extracerts"</return>array
                                                                      of extra certificates or a
                                                                      single certificate to be
                                                                      included in the PKCS#12
                                                                      file.<return>"friendly_name"</return>string to
                                                                      be used for the supplied
                                                                      certificate and key

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


id: openssl_pkcs12_export_to_file
type: function
doc:
<comment>Description:</comment>
  Exports a PKCS#12 Compatible Certificate Store File
  
  <strong>openssl_pkcs12_export_to_file()</strong> stores <strong>$certificate</strong> into a file named by <strong>$output_filename</strong> in a
  PKCS#12 file format.

<comment>Param:</comment>
  <info></info>                                                      <strong>$x509</strong>             Consulte Parâmetros
                                                                          Chave/Certificado para
                                                                          obter uma lista de valores
                                                                          válidos.
  <info>string</info>                                                <strong>$output_filename</strong>  Path to the output file.
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>      Private key component of
                                                                          PKCS#12 file. See
                                                                          Public/Private Key
                                                                          parameters for a list of
                                                                          valid values.
  <info>string</info>                                                <strong>$passphrase</strong>       Encryption password for
                                                                          unlocking the PKCS#12
                                                                          file.
  <info>array</info>                                                 <strong>$options</strong>          Optional array, other keys
                                                                          will be ignored.
                                                                          KeyDescrição<return>"extracerts"</return>array
                                                                          of extra certificates or a
                                                                          single certificate to be
                                                                          included in the PKCS#12
                                                                          file.<return>"friendly_name"</return>string
                                                                          to be used for the
                                                                          supplied certificate and
                                                                          key

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


id: openssl_pkcs12_read
type: function
doc:
<comment>Description:</comment>
  Parse a PKCS#12 Certificate Store into an array
  
  <strong>openssl_pkcs12_read()</strong> parses the PKCS#12 certificate store supplied by <strong>$pkcs12</strong> into a array named
  <strong>$certificates</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$pkcs12</strong>        The certificate store contents, not its file name.
  <info>array</info>   <strong>$certificates</strong>  On success, this will hold the Certificate Store Data.
  <info>string</info>  <strong>$passphrase</strong>    Encryption password for unlocking the PKCS#12 file.

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


id: openssl_pkcs7_decrypt
type: function
doc:
<comment>Description:</comment>
  Decrypts an S/MIME encrypted message
  
  Decrypts the S/MIME encrypted message contained in the file specified by <strong>$input_filename</strong> using the
  certificate and its associated private key specified by <strong>$certificate</strong> and <strong>$private_key</strong>.

<comment>Param:</comment>
  <info>string</info>                                                     <strong>$input_filename</strong>   
  <info>string</info>                                                     <strong>$output_filename</strong>  The decrypted message
                                                                               is written to the
                                                                               file specified by
                                                                               <strong>$output_filename</strong>.
  <info>OpenSSLCertificate|string</info>                                  <strong>$certificate</strong>      
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string|null</info>  <strong>$private_key</strong>      

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


id: openssl_pkcs7_encrypt
type: function
doc:
<comment>Description:</comment>
  Encrypt an S/MIME message
  
  <strong>openssl_pkcs7_encrypt()</strong> takes the contents of the file named <strong>$input_filename</strong> and encrypts them
  using an RC2 40-bit cipher so that they can only be read by the intended recipients specified by
  <strong>$certificate</strong>.

<comment>Param:</comment>
  <info>string</info>                           <strong>$input_filename</strong>   
  <info>string</info>                           <strong>$output_filename</strong>  
  <info>OpenSSLCertificate|array|string</info>  <strong>$certificate</strong>      Either a lone X.509 certificate, or an array of
                                                     X.509 certificates.
  <info>array|null</info>                       <strong>$headers</strong>          <strong>$headers</strong> is an array of headers that will be
                                                     prepended to the data after it has been
                                                     encrypted.
                                                     
                                                     <strong>$headers</strong> can be either an associative array
                                                     keyed by header name, or an indexed array,
                                                     where each element contains a single header
                                                     line.
  <info>int</info>                              <strong>$flags</strong>            <strong>$flags</strong> can be used to specify options that
                                                     affect the encoding process - see PKCS7
                                                     constants.
  <info>int</info>                              <strong>$cipher_algo</strong>      One of cipher constants.

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


id: openssl_pkcs7_read
type: function
doc:
<comment>Description:</comment>
  Export the PKCS7 file to an array of PEM certificates
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>          The string of data you wish to parse (p7b format).
  <info>array</info>   <strong>$certificates</strong>  The array of PEM certificates from the p7b input 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>openssl_csr_sign()</strong>


id: openssl_pkcs7_sign
type: function
doc:
<comment>Description:</comment>
  Sign an S/MIME message
  
  <strong>openssl_pkcs7_sign()</strong> takes the contents of the file named <strong>$input_filename</strong> and signs them using the
  certificate and its matching private key specified by <strong>$certificate</strong> and <strong>$private_key</strong> parameters.

<comment>Param:</comment>
  <info>string</info>                                                <strong>$input_filename</strong>                   The input
                                                                                          file you
                                                                                          are
                                                                                          intending
                                                                                          to
                                                                                          digitally
                                                                                          sign.
  <info>string</info>                                                <strong>$output_filename</strong>                  The file
                                                                                          which the
                                                                                          digital
                                                                                          signature
                                                                                          will be
                                                                                          written
                                                                                          to.
  <info>OpenSSLCertificate|string</info>                             <strong>$certificate</strong>                      The X.509
                                                                                          certificate
                                                                                          used to
                                                                                          digitally
                                                                                          sign
                                                                                          <strong>$input_filename</strong>.
                                                                                          See
                                                                                          Key/Certificate
                                                                                          parameters
                                                                                          for a list
                                                                                          of valid
                                                                                          values.
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>                      
                                                                                          <strong>$private_key</strong>
                                                                                          is the
                                                                                          private
                                                                                          key
                                                                                          corresponding
                                                                                          to
                                                                                          <strong>$certificate</strong>.
                                                                                          See
                                                                                          Public/Private
                                                                                          Key
                                                                                          parameters
                                                                                          for a list
                                                                                          of valid
                                                                                          values.
  <info>array|null</info>                                            <strong>$headers</strong>                          <strong>$headers</strong>
                                                                                          is an
                                                                                          array of
                                                                                          headers
                                                                                          that will
                                                                                          be
                                                                                          prepended
                                                                                          to the
                                                                                          data after
                                                                                          it has
                                                                                          been
                                                                                          signed
                                                                                          (see
                                                                                          <strong>openssl_pkcs7_encrypt()</strong>
                                                                                          for more
                                                                                          information
                                                                                          about the
                                                                                          format of
                                                                                          this
                                                                                          parameter).
  <info>int</info>                                                   <strong>$flags</strong>                            <strong>$flags</strong> can
                                                                                          be used to
                                                                                          alter the
                                                                                          output -
                                                                                          see PKCS7
                                                                                          constants.
  <info>string|null</info>                                           <strong>$untrusted_certificates_filename</strong>  
                                                                                          <strong>$untrusted_certificates_filename</strong>
                                                                                          specifies
                                                                                          the name
                                                                                          of a file
                                                                                          containing
                                                                                          a bunch of
                                                                                          extra
                                                                                          certificates
                                                                                          to include
                                                                                          in the
                                                                                          signature
                                                                                          which can
                                                                                          for
                                                                                          example be
                                                                                          used to
                                                                                          help the
                                                                                          recipient
                                                                                          to verify
                                                                                          the
                                                                                          certificate
                                                                                          that you
                                                                                          used.

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


id: openssl_pkcs7_verify
type: function
doc:
<comment>Description:</comment>
  Verifies the signature of an S/MIME signed message
  
  <strong>openssl_pkcs7_verify()</strong> reads the S/MIME message contained in the given file and examines the
  digital signature.

<comment>Param:</comment>
  <info>string</info>       <strong>$input_filename</strong>                   Path to the message.
  <info>int</info>          <strong>$flags</strong>                            <strong>$flags</strong> can be used to affect how the signature is
                                                 verified - see PKCS7 constants for more
                                                 information.
  <info>string|null</info>  <strong>$signers_certificates_filename</strong>    If the <strong>$signers_certificates_filename</strong> is specified,
                                                 it should be a string holding the name of a file
                                                 into which the certificates of the persons that
                                                 signed the messages will be stored in PEM format.
  <info>array</info>        <strong>$ca_info</strong>                          If the <strong>$ca_info</strong> is specified, it should hold
                                                 information about the trusted CA certificates to
                                                 use in the verification process - see certificate
                                                 verification for more information about this
                                                 parameter.
  <info>string|null</info>  <strong>$untrusted_certificates_filename</strong>  If the <strong>$untrusted_certificates_filename</strong> is
                                                 specified, it is the filename of a file containing
                                                 a bunch of certificates to use as untrusted CAs.
  <info>string|null</info>  <strong>$content</strong>                          You can specify a filename with <strong>$content</strong> that will
                                                 be filled with the verified data, but with the
                                                 signature information stripped.
  <info>string|null</info>  <strong>$output_filename</strong>                  

<comment>Return:</comment>
  <info>bool|int</info>  Returns <info>true</info> if the signature is verified, <info>false</info> if it is not correct (the message has
            been tampered with, or the signing certificate is invalid), or -1 on error.


id: openssl_pkey_derive
type: function
doc:
<comment>Description:</comment>
  Computes shared secret for public value of remote and local DH or ECDH key
  
  <strong>openssl_pkey_derive()</strong> takes a set of a <strong>$public_key</strong> and <strong>$private_key</strong> and derives a shared secret,
  for either DH or EC keys.

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$public_key</strong>   <strong>$public_key</strong> is the public key
                                                                      for the derivation. See
                                                                      Public/Private Key parameters
                                                                      for a list of valid values.
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>  <strong>$private_key</strong> is the private
                                                                      key for the derivation. See
                                                                      Public/Private Key parameters
                                                                      for a list of valid values.
  <info>int</info>                                                   <strong>$key_length</strong>   If not zero, will set the
                                                                      desired length of the derived
                                                                      secret.

<comment>Return:</comment>
  <info>string|false</info>  The derived secret on success ou <info>false</info> em caso de falha.


id: openssl_pkey_export
type: function
doc:
<comment>Description:</comment>
  Gets an exportable representation of a key into a string
  
  <strong>openssl_pkey_export()</strong> exports <strong>$key</strong> as a PEM encoded string and stores it into <strong>$output</strong> (which is
  passed by reference).
  
  É preciso ter um arquivo openssl.cnf válido instalado para que esta função funcione corretamente.
  Consulte as notas na seção de instalação para obter mais informações.

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$key</strong>         
  <info>string</info>                                                <strong>$output</strong>      
  <info>string|null</info>                                           <strong>$passphrase</strong>  The key is optionally protected
                                                                     by <strong>$passphrase</strong>.
  <info>array|null</info>                                            <strong>$options</strong>     <strong>$options</strong> can be used to
                                                                     fine-tune the export process by
                                                                     specifying and/or overriding
                                                                     options for the openssl
                                                                     configuration file.  See
                                                                     <strong>openssl_csr_new()</strong> for more
                                                                     information about <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.


id: openssl_pkey_export_to_file
type: function
doc:
<comment>Description:</comment>
  Gets an exportable representation of a key into a file 
  
  <strong>openssl_pkey_export_to_file()</strong> saves an ascii-armoured (PEM encoded) rendition of <strong>$key</strong> into the
  file named by <strong>$output_filename</strong>.
  
  É preciso ter um arquivo openssl.cnf válido instalado para que esta função funcione corretamente.
  Consulte as notas na seção de instalação para obter mais informações.

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$key</strong>              
  <info>string</info>                                                <strong>$output_filename</strong>  Path to the output file.
  <info>string|null</info>                                           <strong>$passphrase</strong>       The key can be optionally
                                                                          protected by a
                                                                          <strong>$passphrase</strong>.
  <info>array|null</info>                                            <strong>$options</strong>          <strong>$options</strong> can be used to
                                                                          fine-tune the export
                                                                          process by specifying
                                                                          and/or overriding options
                                                                          for the openssl
                                                                          configuration file. See
                                                                          <strong>openssl_csr_new()</strong> for more
                                                                          information about
                                                                          <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.


id: openssl_pkey_free
type: function
doc:
<comment>Description:</comment>
  Frees a private key
  
  Esta função não tem efeito. Antes do PHP 8.0.0, esta função era usada para fechar o recurso.
  
  This function frees a private key created by <strong>openssl_pkey_new()</strong>.

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey</info>  <strong>$key</strong>  Resource holding the key.

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


id: openssl_pkey_get_details
type: function
doc:
<comment>Description:</comment>
  Returns an array with the key details
  
  This function returns the key details (bits, key, type).

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey</info>  <strong>$key</strong>  Resource holding the key.

<comment>Return:</comment>
  <info>array|false</info>  Returns an array with the key details on success or <info>false</info> on failure. Returned array
               has indexes <return>bits</return> (number of bits), <return>key</return> (string representation of the public key) and
               <return>type</return> (type of the key which is one of <info>OPENSSL_KEYTYPE_RSA</info>, <info>OPENSSL_KEYTYPE_DSA</info>,
               <info>OPENSSL_KEYTYPE_DH</info>, <info>OPENSSL_KEYTYPE_EC</info> or -1 meaning unknown).
               
               Depending on the key type used, additional details may be returned. Note that  some
               elements may not always be available.
               
               <info>OPENSSL_KEYTYPE_RSA</info>, an additional array key named <return>"rsa"</return>,  containing the key data is
               returned.
               
               <info>OPENSSL_KEYTYPE_DSA</info>, an additional array key named <return>"dsa"</return>,  containing the key data is
               returned.
               
               <info>OPENSSL_KEYTYPE_DH</info>, an additional array key named <return>"dh"</return>,  containing the key data is
               returned.
               
               <info>OPENSSL_KEYTYPE_EC</info>, an additional array key named <return>"ec"</return>,  containing the key data is
               returned.


id: openssl_pkey_get_private
type: function
doc:
<comment>Description:</comment>
  Get a private key
  
  <strong>openssl_pkey_get_private()</strong> parses <strong>$private_key</strong> and prepares it for use by other functions.

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>  <strong>$private_key</strong> can be one of the
                                                                      following: a string having the
                                                                      format
                                                                      file://path/to/file.pem. The
                                                                      named file must contain a PEM
                                                                      encoded certificate/private
                                                                      key (it may contain both). A
                                                                      PEM formatted private key.
                                                                      
                                                                      a string having the format
                                                                      file://path/to/file.pem. The
                                                                      named file must contain a PEM
                                                                      encoded certificate/private
                                                                      key (it may contain both).
                                                                      
                                                                      A PEM formatted private key.
  <info>string|null</info>                                           <strong>$passphrase</strong>   The optional parameter
                                                                      <strong>$passphrase</strong> must be used if
                                                                      the specified key is encrypted
                                                                      (protected by a passphrase).

<comment>Return:</comment>
  <info>OpenSSLAsymmetricKey|false</info>  Returns an <class>OpenSSLAsymmetricKey</class> instance on success, or <info>false</info> on
                              error.


id: openssl_pkey_get_public
type: function
doc:
<comment>Description:</comment>
  Extract public key from certificate and prepare it for use
  
  <strong>openssl_pkey_get_public()</strong> extracts the public key from <strong>$public_key</strong> and prepares it for use by
  other functions.

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$public_key</strong>  <strong>$public_key</strong> can be one of the
                                                                     following: an
                                                                     <class>OpenSSLAsymmetricKey</class> instancea
                                                                     string having the format
                                                                     file://path/to/file.pem. The
                                                                     named file must contain a PEM
                                                                     encoded certificate/public key
                                                                     (it may contain both). A PEM
                                                                     formatted public key.
                                                                     
                                                                     an <class>OpenSSLAsymmetricKey</class>
                                                                     instance
                                                                     
                                                                     a string having the format
                                                                     file://path/to/file.pem. The
                                                                     named file must contain a PEM
                                                                     encoded certificate/public key
                                                                     (it may contain both).
                                                                     
                                                                     A PEM formatted public key.

<comment>Return:</comment>
  <info>OpenSSLAsymmetricKey|false</info>  Returns an <class>OpenSSLAsymmetricKey</class> instance on success, or <info>false</info> on
                              error.


id: openssl_pkey_new
type: function
doc:
<comment>Description:</comment>
  Generates a new private key 
  
  <strong>openssl_pkey_new()</strong> generates a new private key. How to obtain the public component of the key is
  shown in an example below.
  
  É preciso ter um arquivo openssl.cnf válido instalado para que esta função funcione corretamente.
  Consulte as notas na seção de instalação para obter mais informações.

<comment>Param:</comment>
  <info>array|null</info>  <strong>$options</strong>  You can finetune the key generation (such as specifying the number of bits)
                        using <strong>$options</strong>.  See <strong>openssl_csr_new()</strong> for more information about <strong>$options</strong>.

<comment>Return:</comment>
  <info>OpenSSLAsymmetricKey|false</info>  Returns an <class>OpenSSLAsymmetricKey</class> instance for the pkey on success, or
                              <info>false</info> on error.


id: openssl_private_decrypt
type: function
doc:
<comment>Description:</comment>
  Decrypts data with private key 
  
  <strong>openssl_private_decrypt()</strong> decrypts <strong>$data</strong> that was previously encrypted via
  <strong>openssl_public_encrypt()</strong> and stores the result into <strong>$decrypted_data</strong>.
  
  You can use this function e.g. to decrypt data which is supposed to only be available to you.

<comment>Param:</comment>
  <info>string</info>                                                <strong>$data</strong>            
  <info>string</info>                                                <strong>$decrypted_data</strong>  
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>     <strong>$private_key</strong> must be the
                                                                         private key corresponding
                                                                         that was used to encrypt
                                                                         the data.
  <info>int</info>                                                   <strong>$padding</strong>         <strong>$padding</strong> can be one of
                                                                         <info>OPENSSL_PKCS1_PADDING</info>,
                                                                         <info>OPENSSL_SSLV23_PADDING</info>,
                                                                         <info>OPENSSL_PKCS1_OAEP_PADDING</info>,
                                                                         <info>OPENSSL_NO_PADDING</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>openssl_public_encrypt()</strong>
   * <strong>openssl_public_decrypt()</strong>


id: openssl_private_encrypt
type: function
doc:
<comment>Description:</comment>
  Encrypts data with private key 
  
  <strong>openssl_private_encrypt()</strong> encrypts <strong>$data</strong> with private <strong>$private_key</strong> and stores the result into
  <strong>$encrypted_data</strong>. Encrypted data can be decrypted via <strong>openssl_public_decrypt()</strong>.
  
  This function can be used e.g. to sign data (or its hash) to prove that it is not written by
  someone else.

<comment>Param:</comment>
  <info>string</info>                                                <strong>$data</strong>            
  <info>string</info>                                                <strong>$encrypted_data</strong>  
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>     
  <info>int</info>                                                   <strong>$padding</strong>         <strong>$padding</strong> can be one of
                                                                         <info>OPENSSL_PKCS1_PADDING</info>,
                                                                         <info>OPENSSL_NO_PADDING</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>openssl_public_encrypt()</strong>
   * <strong>openssl_public_decrypt()</strong>


id: openssl_public_decrypt
type: function
doc:
<comment>Description:</comment>
  Decrypts data with public key 
  
  <strong>openssl_public_decrypt()</strong> decrypts <strong>$data</strong> that was previous encrypted via <strong>openssl_private_encrypt()</strong>
  and stores the result into <strong>$decrypted_data</strong>.
  
  You can use this function e.g. to check if the message was written by the owner of the private
  key.

<comment>Param:</comment>
  <info>string</info>                                                <strong>$data</strong>            
  <info>string</info>                                                <strong>$decrypted_data</strong>  
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$public_key</strong>      <strong>$public_key</strong> must be the
                                                                         public key corresponding
                                                                         that was used to encrypt
                                                                         the data.
  <info>int</info>                                                   <strong>$padding</strong>         <strong>$padding</strong> can be one of
                                                                         <info>OPENSSL_PKCS1_PADDING</info>,
                                                                         <info>OPENSSL_NO_PADDING</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>openssl_private_encrypt()</strong>
   * <strong>openssl_private_decrypt()</strong>


id: openssl_public_encrypt
type: function
doc:
<comment>Description:</comment>
  Encrypts data with public key 
  
  <strong>openssl_public_encrypt()</strong> encrypts <strong>$data</strong> with public <strong>$public_key</strong> and stores the result into
  <strong>$encrypted_data</strong>. Encrypted data can be decrypted via <strong>openssl_private_decrypt()</strong>.
  
  This function can be used e.g. to encrypt message which can be then read only by owner of the
  private key. It can be also used to store secure data in database.

<comment>Param:</comment>
  <info>string</info>                                                <strong>$data</strong>            
  <info>string</info>                                                <strong>$encrypted_data</strong>  This will hold the result
                                                                         of the encryption.
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$public_key</strong>      The public key.
  <info>int</info>                                                   <strong>$padding</strong>         <strong>$padding</strong> can be one of
                                                                         <info>OPENSSL_PKCS1_PADDING</info>,
                                                                         <info>OPENSSL_SSLV23_PADDING</info>,
                                                                         <info>OPENSSL_PKCS1_OAEP_PADDING</info>,
                                                                         <info>OPENSSL_NO_PADDING</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>openssl_private_encrypt()</strong>
   * <strong>openssl_private_decrypt()</strong>


id: openssl_random_pseudo_bytes
type: function
doc:
<comment>Description:</comment>
  Generate a pseudo-random string of bytes
  
  Generates a <info>string</info> of pseudo-random bytes, with the number of bytes determined by the <strong>$length</strong>
  parameter.
  
  It also indicates if a cryptographically strong algorithm was used to produce the pseudo-random
  bytes, and does this via the optional <strong>$strong_result</strong> parameter. It's rare for this to be <info>false</info>,
  but some systems may be broken or old.

<comment>Param:</comment>
  <info>int</info>   <strong>$length</strong>         The length of the desired string of bytes. Must be a positive integer less
                        than or equal to <return>2147483647</return>. PHP will try to cast this parameter to a
                        non-null integer to use it.
  <info>bool</info>  <strong>$strong_result</strong>  If passed into the function, this will hold a <info>bool</info> value that determines if
                        the algorithm used was "cryptographically strong", e.g., safe for usage with
                        GPG,  passwords, etc. <info>true</info> if it did, otherwise <info>false</info>

<comment>Return:</comment>
  <info>string</info>  Returns the generated <info>string</info> of bytes.

<comment>See Also:</comment>
   * <strong>random_bytes()</strong>
   * <strong>bin2hex()</strong>
   * <strong>crypt()</strong>
   * <strong>random_int()</strong>


id: openssl_seal
type: function
doc:
<comment>Description:</comment>
  Seal (encrypt) data
  
  <strong>openssl_seal()</strong> seals (encrypts) <strong>$data</strong> by using the given <strong>$cipher_algo</strong> with a randomly generated
  secret key. The key is encrypted with each of the public keys associated with the identifiers in
  <strong>$public_key</strong> and each encrypted key is returned in <strong>$encrypted_keys</strong>. This means that one can send
  sealed data to multiple recipients (provided one has obtained their public keys). Each recipient
  must receive both the sealed data and the envelope key that was encrypted with the recipient's
  public key.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>            The data to seal.
  <info>string</info>  <strong>$sealed_data</strong>     The sealed data.
  <info>array</info>   <strong>$encrypted_keys</strong>  Array of encrypted keys.
  <info>array</info>   <strong>$public_key</strong>      Array of <class>OpenSSLAsymmetricKey</class> instances containing public keys.
  <info>string</info>  <strong>$cipher_algo</strong>     The cipher method.  The default value (<return>'RC4'</return>) is considered insecure. It
                           is strongly recommended to explicitly specify a secure cipher method.
                           
                           The default value (<return>'RC4'</return>) is considered insecure. It is strongly
                           recommended to explicitly specify a secure cipher method.
  <info>string</info>  <strong>$iv</strong>              The initialization vector.

<comment>Return:</comment>
  <info>int|false</info>  Returns the length of the sealed data on success, or <info>false</info> on error. If successful the
             sealed data is returned in <strong>$sealed_data</strong>, and the envelope keys in <strong>$encrypted_keys</strong>.

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


id: openssl_sign
type: function
doc:
<comment>Description:</comment>
  Generate signature
  
  <strong>openssl_sign()</strong> computes a signature for the specified <strong>$data</strong> by generating a cryptographic digital
  signature using the private key associated with <strong>$private_key</strong>. Note that the data itself is not
  encrypted.

<comment>Param:</comment>
  <info>string</info>                                                <strong>$data</strong>         The string of data you wish to
                                                                      sign
  <info>string</info>                                                <strong>$signature</strong>    If the call was successful the
                                                                      signature is returned in
                                                                      <strong>$signature</strong>.
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>  <class>OpenSSLAsymmetricKey</class> - a key,
                                                                      returned by
                                                                      <strong>openssl_get_privatekey()</strong>
                                                                      
                                                                      <info>string</info> - a PEM formatted key
  <info>string|int</info>                                            <strong>$algorithm</strong>    <info>int</info> - one of these Signature
                                                                      Algorithms.
                                                                      
                                                                      <info>string</info> - a valid string
                                                                      returned by
                                                                      <strong>openssl_get_md_methods()</strong>
                                                                      example,
                                                                      "sha256WithRSAEncryption" or
                                                                      "sha384".

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


id: openssl_spki_export
type: function
doc:
<comment>Description:</comment>
  Exports a valid PEM formatted public key signed public key and challenge
  
  Exports PEM formatted public key from encoded signed public key and challenge

<comment>Param:</comment>
  <info>string</info>  <strong>$spki</strong>  Expects a valid signed public key and challenge

<comment>Return:</comment>
  <info>string|false</info>  Returns the associated PEM formatted public key or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>openssl_spki_new()</strong>
   * <strong>openssl_spki_verify()</strong>
   * <strong>openssl_spki_export_challenge()</strong>
   * <strong>openssl_get_md_methods()</strong>
   * <strong>openssl_csr_new()</strong>
   * <strong>openssl_csr_sign()</strong>


id: openssl_spki_export_challenge
type: function
doc:
<comment>Description:</comment>
  Exports the challenge associated with a signed public key and challenge
  
  Exports challenge from encoded signed public key and challenge

<comment>Param:</comment>
  <info>string</info>  <strong>$spki</strong>  Expects a valid signed public key and challenge

<comment>Return:</comment>
  <info>string|false</info>  Returns the associated challenge string or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>openssl_spki_new()</strong>
   * <strong>openssl_spki_verify()</strong>
   * <strong>openssl_spki_export()</strong>
   * <strong>openssl_get_md_methods()</strong>
   * <strong>openssl_csr_new()</strong>
   * <strong>openssl_csr_sign()</strong>


id: openssl_spki_new
type: function
doc:
<comment>Description:</comment>
  Generate a new signed public key and challenge
  
  Generates a signed public key and challenge using specified hashing algorithm

<comment>Param:</comment>
  <info>OpenSSLAsymmetricKey</info>  <strong>$private_key</strong>  <strong>$private_key</strong> should be set to a private key that was
                                      previously generated by <strong>openssl_pkey_new()</strong> (or otherwise
                                      obtained from the other openssl_pkey family of functions). The
                                      corresponding public portion of the key will be used to sign
                                      the CSR.
  <info>string</info>                <strong>$challenge</strong>    The challenge associated to associate with the SPKAC
  <info>int</info>                   <strong>$digest_algo</strong>  The digest algorithm. See openssl_get_md_method().

<comment>Return:</comment>
  <info>string|false</info>  Returns a signed public key and challenge string or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>openssl_spki_verify()</strong>
   * <strong>openssl_spki_export_challenge()</strong>
   * <strong>openssl_spki_export()</strong>
   * <strong>openssl_get_md_methods()</strong>
   * <strong>openssl_csr_new()</strong>
   * <strong>openssl_csr_sign()</strong>


id: openssl_spki_verify
type: function
doc:
<comment>Description:</comment>
  Verifies a signed public key and challenge
  
  Validates the supplied signed public key and challenge

<comment>Param:</comment>
  <info>string</info>  <strong>$spki</strong>  Expects a valid signed public key and challenge

<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>openssl_spki_new()</strong>
   * <strong>openssl_spki_export_challenge()</strong>
   * <strong>openssl_spki_export()</strong>
   * <strong>openssl_get_md_methods()</strong>
   * <strong>openssl_csr_new()</strong>
   * <strong>openssl_csr_sign()</strong>


id: openssl_verify
type: function
doc:
<comment>Description:</comment>
  Verify signature
  
  <strong>openssl_verify()</strong> verifies that the <strong>$signature</strong> is correct for the specified <strong>$data</strong> using the public
  key associated with <strong>$public_key</strong>. This must be the public key corresponding to the private key used
  for signing.

<comment>Param:</comment>
  <info>string</info>                                                <strong>$data</strong>        The string of data used to
                                                                     generate the signature
                                                                     previously
  <info>string</info>                                                <strong>$signature</strong>   A raw binary string, generated
                                                                     by <strong>openssl_sign()</strong> or similar
                                                                     means
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$public_key</strong>  <class>OpenSSLAsymmetricKey</class> - a key,
                                                                     returned by
                                                                     <strong>openssl_get_publickey()</strong>
                                                                     
                                                                     <info>string</info> - a PEM formatted key
                                                                     (e.g. <return>-----BEGIN PUBLIC
                                                                     KEY-----
                                                                     MIIBCgK...</return>)
  <info>string|int</info>                                            <strong>$algorithm</strong>   <info>int</info> - one of these Signature
                                                                     Algorithms.
                                                                     
                                                                     <info>string</info> - a valid string
                                                                     returned by
                                                                     <strong>openssl_get_md_methods()</strong>
                                                                     example,
                                                                     "sha1WithRSAEncryption" or
                                                                     "sha512".

<comment>Return:</comment>
  <info>int|false</info>  Returns 1 if the signature is correct, 0 if it is incorrect, and -1 or <info>false</info> on error.

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


id: openssl_x509_check_private_key
type: function
doc:
<comment>Description:</comment>
  Checks if a private key corresponds to a certificate
  
  Checks whether the given <strong>$private_key</strong> is the private key that corresponds to <strong>$certificate</strong>.
  
  The function does not check if <strong>$private_key</strong> is indeed a private key or not. It merely compares the
  public materials (e.g. exponent and modulus of an RSA key) and/or key parameters (e.g. EC params
  of an EC key) of a key pair.
  
  This means, for example, that a public key could be given for <strong>$private_key</strong> and the function may
  return <info>true</info>.

<comment>Param:</comment>
  <info>OpenSSLCertificate|string</info>                             <strong>$certificate</strong>  The certificate.
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$private_key</strong>  The private key.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$private_key</strong> is the private key that corresponds to <strong>$certificate</strong>, or <info>false</info>
        otherwise.


id: openssl_x509_checkpurpose
type: function
doc:
<comment>Description:</comment>
  Verifies if a certificate can be used for a particular purpose
  
  <strong>openssl_x509_checkpurpose()</strong> examines a certificate to see if it can be used for the specified
  <strong>$purpose</strong>.

<comment>Param:</comment>
  <info>OpenSSLCertificate|string</info>  <strong>$certificate</strong>                  The examined certificate.
  <info>int</info>                        <strong>$purpose</strong>                      <strong>openssl_x509_checkpurpose()</strong>
                                                           purposesConstantDescriptionX509_PURPOSE_SSL_CLIENTCan
                                                           the certificate be used for the client
                                                           side of an SSL
                                                           connection?X509_PURPOSE_SSL_SERVERCan the
                                                           certificate be used for the server side
                                                           of an SSL
                                                           connection?X509_PURPOSE_NS_SSL_SERVERCan
                                                           the cert be used for Netscape SSL
                                                           server?X509_PURPOSE_SMIME_SIGNCan the
                                                           cert be used to sign S/MIME
                                                           email?X509_PURPOSE_SMIME_ENCRYPTCan the
                                                           cert be used to encrypt S/MIME
                                                           email?X509_PURPOSE_CRL_SIGNCan the cert
                                                           be used to sign a certificate revocation
                                                           list (CRL)?X509_PURPOSE_ANYCan the cert
                                                           be used for Any/All purposes? These
                                                           options are not bitfields - you may
                                                           specify one only!
  <info>array</info>                      <strong>$ca_info</strong>                      <strong>$ca_info</strong> should be an array of trusted CA
                                                           files/dirs as described in Certificate
                                                           Verification.
  <info>string|null</info>                <strong>$untrusted_certificates_file</strong>  If specified, this should be the name of
                                                           a PEM encoded file holding certificates
                                                           that can be used to help verify the
                                                           certificate, although no trust is placed
                                                           in the certificates that come from that
                                                           file.

<comment>Return:</comment>
  <info>bool|int</info>  Returns <info>true</info> if the certificate can be used for the intended purpose, <info>false</info> if it
            cannot, or -1 on error.


id: openssl_x509_export
type: function
doc:
<comment>Description:</comment>
  Exports a certificate as a string
  
  <strong>openssl_x509_export()</strong> stores <strong>$certificate</strong> into a string named by <strong>$output</strong> in a PEM encoded format.

<comment>Param:</comment>
  <info></info>        <strong>$x509</strong>     Consulte Parâmetros Chave/Certificado para obter uma lista de valores válidos.
  <info>string</info>  <strong>$output</strong>   On success, this will hold the PEM.
  <info>bool</info>    <strong>$no_text</strong>  O parâmetro opcional <strong>$notext</strong> afeta a verbosidade da saída; se for <info>false</info>, então
                    informações adicionais legíveis para humanos serão incluídas na saída. O valor
                    padrão de <strong>$notext</strong> é <info>true</info>.

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


id: openssl_x509_export_to_file
type: function
doc:
<comment>Description:</comment>
  Exports a certificate to file
  
  <strong>openssl_x509_export_to_file()</strong> stores <strong>$certificate</strong> into a file named by <strong>$output_filename</strong> in a PEM
  encoded format.

<comment>Param:</comment>
  <info></info>        <strong>$x509</strong>             Consulte Parâmetros Chave/Certificado para obter uma lista de valores
                            válidos.
  <info>string</info>  <strong>$output_filename</strong>  Path to the output file.
  <info>bool</info>    <strong>$no_text</strong>          O parâmetro opcional <strong>$notext</strong> afeta a verbosidade da saída; se for <info>false</info>,
                            então informações adicionais legíveis para humanos serão incluídas na
                            saída. O valor padrão de <strong>$notext</strong> é <info>true</info>.

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


id: openssl_x509_fingerprint
type: function
doc:
<comment>Description:</comment>
  Calculates the fingerprint, or digest, of a given X.509 certificate
  
  <strong>openssl_x509_fingerprint()</strong> returns the digest of <strong>$certificate</strong> as a string.

<comment>Param:</comment>
  <info></info>        <strong>$x509</strong>         Consulte Parâmetros Chave/Certificado para obter uma lista de valores
                        válidos.
  <info>string</info>  <strong>$digest_algo</strong>  The digest method or hash algorithm to use, e.g. "sha256", one of
                        <strong>openssl_get_md_methods()</strong>.
  <info>bool</info>    <strong>$binary</strong>       When set to <info>true</info>, outputs raw binary data. <info>false</info> outputs lowercase hexits.

<comment>Return:</comment>
  <info>string|false</info>  Returns a string containing the calculated certificate fingerprint as lowercase
                hexits unless <strong>$binary</strong> is set to <info>true</info> in which case the raw binary representation of
                the message digest is returned.
                
                Returns <info>false</info> on failure.


id: openssl_x509_free
type: function
doc:
<comment>Description:</comment>
  Free certificate resource
  
  Esta função não tem efeito. Antes do PHP 8.0.0, esta função era usada para fechar o recurso.
  
  <strong>openssl_x509_free()</strong> frees the certificate associated with the specified <strong>$certificate</strong> resource from
  memory.

<comment>Param:</comment>
  <info>OpenSSLCertificate</info>  <strong>$certificate</strong>  

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


id: openssl_x509_parse
type: function
doc:
<comment>Description:</comment>
  Parse an X509 certificate and return the information as an array
  
  <strong>openssl_x509_parse()</strong> returns information about the supplied <strong>$certificate</strong>, including fields such as
  subject name, issuer name, purposes, valid from and valid to dates etc.

<comment>Param:</comment>
  <info>OpenSSLCertificate|string</info>  <strong>$certificate</strong>  X509 certificate. See Key/Certificate parameters for a
                                           list of valid values.
  <info>bool</info>                       <strong>$short_names</strong>  <strong>$short_names</strong> controls how the data is indexed in the
                                           array - if <strong>$short_names</strong> is <info>true</info> (the default) then fields
                                           will be indexed with the short name form, otherwise, the
                                           long name form will be used - e.g.: CN is the shortname
                                           form of commonName.

<comment>Return:</comment>
  <info>array|false</info>  The structure of the returned data is (deliberately) not yet documented, as it is
               still subject to change.


id: openssl_x509_read
type: function
doc:
<comment>Description:</comment>
  Parse an X.509 certificate and return an object for
    it
  
  <strong>openssl_x509_read()</strong> parses the certificate supplied by <strong>$certificate</strong> and returns an
  <class>OpenSSLCertificate</class> object for it.

<comment>Param:</comment>
  <info>OpenSSLCertificate|string</info>  <strong>$certificate</strong>  X509 certificate. See Key/Certificate parameters for a
                                           list of valid values.

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


id: openssl_x509_verify
type: function
doc:
<comment>Description:</comment>
  Verifies digital signature of x509 certificate against a public key
  
  <strong>openssl_x509_verify()</strong> verifies that the  <strong>$certificate</strong> certificate was signed by the private  key
  corresponding to public key <strong>$public_key</strong>.

<comment>Param:</comment>
  <info></info>                                                      <strong>$x509</strong>        Consulte Parâmetros
                                                                     Chave/Certificado para obter
                                                                     uma lista de valores válidos.
  <info>OpenSSLAsymmetricKey|OpenSSLCertificate|array|string</info>  <strong>$public_key</strong>  <class>OpenSSLAsymmetricKey</class> - a key,
                                                                     returned by
                                                                     <strong>openssl_get_publickey()</strong>
                                                                     
                                                                     <info>string</info> - a PEM formatted key
                                                                     (e.g. <return>-----BEGIN PUBLIC
                                                                     KEY-----
                                                                     MIIBCgK...</return>)

<comment>Return:</comment>
  <info>int</info>  Returns 1 if the signature is correct, 0 if it is incorrect, and -1 on error.

<comment>See Also:</comment>
   * <strong>openssl_verify()</strong>
   * <strong>openssl_get_publickey()</strong>


id: ord
type: function
doc:
<comment>Description:</comment>
  Converte o primeiro byte de uma string para um valor entre 0 e 255
  
  Interpreta o valor binário do primeiro byte de <strong>$character</strong> como um inteiro sem sinal entre 0 e 255.
  
  Se a string estiver em codificação de um byte, como ASCII, ISO-8859 ou Windows 1252, é equivalente
  a retornar a posição de um caractere na tabela de mapeamento do conjunto de caracteres.
  Entretanto, note que esta função não tem ciência da codificação da string, e em particular nunca
  irá identificar um ponto de código Unicode em uma codificação multi-byte como UTF-8 ou UTF-16.
  
  Esta função complementa a função <strong>chr()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$character</strong>  A string que terá o primeiro caractere avaliado.

<comment>Return:</comment>
  <info>int</info>  An integer between 0 and 255.

<comment>See Also:</comment>
   * <strong>chr()</strong>
   * Tabela ASCII
   * <strong>mb_ord()</strong>
   * <strong>IntlChar::ord()</strong>


id: output_add_rewrite_var
type: function
doc:
<comment>Description:</comment>
  Add URL rewriter values
  
  This function adds another name/value pair to the URL rewrite mechanism. The name and value will
  be added to URLs (as GET parameter) and forms (as hidden input fields) the same way as the session
  ID when transparent URL rewriting is enabled with session.use_trans_sid.
  
  This function's behaviour is controlled by the url_rewriter.tags and url_rewriter.hosts php.ini
  parameters.
  
  Note that this function can be successfully called at most once per request.
  
  Calling this function will implicitly start output buffering if it is not active already.

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

<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>output_reset_rewrite_vars()</strong>
   * <strong>ob_flush()</strong>
   * <strong>ob_list_handlers()</strong>
   * url_rewriter.tags
   * url_rewriter.hosts
   * session.trans_sid_tags
   * session.trans_sid_hosts


id: output_reset_rewrite_vars
type: function
doc:
<comment>Description:</comment>
  Reset URL rewriter values
  
  This function resets the URL rewriter and removes all rewrite variables previously set by the
  <strong>output_add_rewrite_var()</strong> function.

<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>output_add_rewrite_var()</strong>
   * <strong>ob_flush()</strong>
   * <strong>ob_list_handlers()</strong>
   * url_rewriter.tags
   * url_rewriter.hosts
   * session.trans_sid_tags
   * session.trans_sid_hosts


id: pack
type: function
doc:
<comment>Description:</comment>
  Empacota dados em uma string binária
  
  Empacota os argumentos fornecidos em uma string binária de acordo com o formato especificado em
  <strong>$format</strong>.
  
  A ideia para esta função foi tirada do Perl e todos os códigos de formatação funcionam da mesma
  forma que no Perl. Entretando, há alguns códigos de formatação que não existem, como  código "u"
  do Perl.
  
  Observe que a distinção entre valores com e sem sinal somente afeta a função <strong>unpack()</strong>, enquanto
  que a função <strong>pack()</strong> fornece o mesmo resultado para códigos de formato com e sem sinal.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  A string <strong>$format</strong> consistem em códigos de formado seguidos de um argumento
                   repetidor opcional. O arrgumento repetidor pode ser um valor inteiro ou <return>*</return> para
                   repetir até o final dos dados de entrada. Para a, A, h, H a contagem de repetição
                   especifica quantos caractares de um argumento de dados são tomados, para @ é a
                   posição absoluta onde colocar o próximo dado, para todo o restante a contagem de
                   repetição especifica quantos argumentos de dados são consumidos e empacotados na
                   string binária resultante.
                   
                   Os formatos atualmente implementados são: Caracteres de formato de
                   <strong>pack()</strong>CódigoDescriçãoaString com bytes NUL à esquerdaAString com espaços à
                   esquerdahString hexadecimal, nibble menos significativo primeiroHString
                   hexadecimal, nibble mais significativo primeirocsigned charCunsigned charssigned
                   short (sempre 16 bits, ordem de bytes da máquina)Sunsigned short (sempre 16 bits,
                   ordem de bytes da máquina)nunsigned short (sempre 16 bits, ordem de bytes Big
                   Endian)vunsigned short (sempre 16 bits, ordem de bytes Little Endian)isigned
                   integer (tamanho e ordem de bytes dependentes da máquina)Iunsigned integer
                   (tamanho e ordem de bytes dependentes da máquina)lsigned long (sempre 32 bits,
                   ordem de bytes da máquina)Lunsigned long (sempre 32 bits, ordem de bytes da
                   máquina)Nunsigned long (sempre 32 bits, ordem de bytes Big Endian)Vunsigned long
                   (sempre 32 bits, ordem de bytes Little Endian)qsigned long long (sempre 64 bits,
                   ordem de bytes da máquina)Qunsigned long long (sempre 64 bits, ordem de bytes da
                   máquina)Junsigned long long (sempre 64 bits, ordem de bytes Big Endian)Punsigned
                   long long (sempre 64 bits, ordem de bytes Little Endian)ffloat (representação e
                   tamanho dependentes da máquina)gfloat (tamanho dependente da máquina, ordem de
                   bytes Little Endian)Gfloat (tamanho dependente da máquina, ordem de bytes Big
                   Endian)ddouble (representação e tamanho dependentes da máquina)edouble (tamanho
                   dependente da máquina, ordem de bytes Little Endian)Edouble (tamanho dependente
                   da máquina, ordem de bytes Big Endian)xbyte NULXVolta um byteZString com bytes
                   NUL à esquerda@Preenche com bytes NUL até a posição absoluta
  <info>mixed</info>   <strong>$values</strong>  

<comment>Return:</comment>
  <info>string</info>  Retorna uma string binária contendo dados.

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


id: parallel\Channel::__construct
type: function
doc:
<comment>Description:</comment>
  Channel Construction
  
  Shall make an anonymous unbuffered channel
  
  Shall make an anonymous buffered channel with the given capacity

<comment>Param:</comment>
  <info>int</info>  <strong>$capacity</strong>  May be <info>Channel::Infinite</info> or a positive integer


id: parallel\Channel::close
type: function
doc:
<comment>Description:</comment>
  Closing
  
  Shall close this channel

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


id: parallel\Channel::make
type: function
doc:
<comment>Description:</comment>
  Access
  
  Shall make an unbuffered channel with the given name
  
  Shall make a buffered channel with the given name and capacity

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      The name of the channel.
  <info>int</info>     <strong>$capacity</strong>  May be <info>Channel::Infinite</info> or a positive integer

<comment>Return:</comment>
  <info>Channel</info>  


id: parallel\Channel::open
type: function
doc:
<comment>Description:</comment>
  Access
  
  Shall open the channel with the given name

<comment>Return:</comment>
  <info>Channel</info>  


id: parallel\Channel::recv
type: function
doc:
<comment>Description:</comment>
  Sharing
  
  Shall recv a value from this channel

<comment>Return:</comment>
  <info>mixed</info>  


id: parallel\Channel::send
type: function
doc:
<comment>Description:</comment>
  Sharing
  
  Shall send the given value on this channel

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


id: parallel\Events::addChannel
type: function
doc:
<comment>Description:</comment>
  Targets
  
  Shall watch for events on the given <strong>$channel</strong>

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


id: parallel\Events::addFuture
type: function
doc:
<comment>Description:</comment>
  Targets
  
  Shall watch for events on the given <strong>$future</strong>

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


id: parallel\Events::poll
type: function
doc:
<comment>Description:</comment>
  Polling
  
  Shall poll for the next event

<comment>Return:</comment>
  <info>parallel\Events\Event|null</info>  Should there be no targets remaining, <info>null</info> shall be returned
                              
                              Should this be a non-blocking loop, and blocking would occur, <info>null</info>
                              shall be returned
                              
                              Otherwise, the <class>parallel\Events\Event</class> returned describes the event.


id: parallel\Events::remove
type: function
doc:
<comment>Description:</comment>
  Targets
  
  Shall remove the given <strong>$target</strong>

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


id: parallel\Events::setBlocking
type: function
doc:
<comment>Description:</comment>
  Behaviour
  
  By default when events are polled for, blocking will occur (at the PHP level) until the first
  event can be returned: Setting blocking mode to <info>false</info> will cause poll to return control if the
  first target polled is not ready.
  
  This differs from setting a timeout of 0 with parallel\Events::setTimeout, since a timeout of 0,
  while allowed, will cause an exception  to be raised, which may be extremely slow or wasteful if
  what is really desired is non-blocking behaviour.
  
  A non-blocking loop effects the return value of parallel\Events::poll, such that it may be <info>null</info>
  before all events have been processed.
  
  Shall set blocking mode

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


id: parallel\Events::setInput
type: function
doc:
<comment>Description:</comment>
  Input
  
  Shall set <strong>$input</strong> for this event loop

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


id: parallel\Events::setTimeout
type: function
doc:
<comment>Description:</comment>
  Behaviour
  
  By default when events are polled for, blocking will occur (at the PHP level) until the first
  event can be returned: Setting the timeout causes an exception to be thrown when the timeout is
  reached.
  
  This differs from setting blocking mode to <info>false</info> with parallel\Events::setBlocking, which will not
  cause an exception to be thrown.
  
  Shall set the timeout in microseconds

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


id: parallel\Events\Input::add
type: function
doc:
<comment>Description:</comment>
  Inputs
  
  Shall set input for the given target

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


id: parallel\Events\Input::clear
type: function
doc:
<comment>Description:</comment>
  Inputs
  
  Shall remove input for all targets

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


id: parallel\Events\Input::remove
type: function
doc:
<comment>Description:</comment>
  Inputs
  
  Shall remove input for the given target

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


id: parallel\Future::cancel
type: function
doc:
<comment>Description:</comment>
  Cancellation
  
  Shall try to cancel the task
  
  If task is running, it will be interrupted.
  
  Internal function calls in progress cannot be interrupted.

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


id: parallel\Future::cancelled
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Shall indicate if the task was cancelled

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


id: parallel\Future::done
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Shall indicate if the task is completed

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


id: parallel\Future::value
type: function
doc:
<comment>Description:</comment>
  Resolution
  
  Shall return (and if necessary wait for) return from task

<comment>Return:</comment>
  <info>mixed</info>  


id: parallel\Runtime::__construct
type: function
doc:
<comment>Description:</comment>
  Runtime Construction
  
  Shall construct a new runtime without bootstrapping.
  
  Shall construct a bootstrapped runtime.

<comment>Param:</comment>
  <info>string</info>  <strong>$bootstrap</strong>  The location of a bootstrap file, generally an autoloader.


id: parallel\Runtime::close
type: function
doc:
<comment>Description:</comment>
  Runtime Graceful Join
  
  Shall request that the runtime shutsdown.
  
  Tasks scheduled for execution will be executed before the shutdown occurs.

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


id: parallel\Runtime::kill
type: function
doc:
<comment>Description:</comment>
  Runtime Join
  
  Shall attempt to force the runtime to shutdown.
  
  Tasks scheduled for execution will not be executed, the currently running task shall be
  interrupted.
  
  Internal function calls in progress cannot be interrupted.

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


id: parallel\Runtime::run
type: function
doc:
<comment>Description:</comment>
  Execution
  
  Shall schedule <strong>$task</strong> for execution in parallel.
  
  Shall schedule <strong>$task</strong> for execution in parallel, passing <strong>$argv</strong> at execution time.

<comment>Param:</comment>
  <info>Closure</info>  <strong>$task</strong>  A <class>Closure</class> with specific characteristics.
  <info>array</info>    <strong>$argv</strong>  An <info>array</info> of arguments with specific characteristics to be passed to <strong>$task</strong> at
                  execution time.

<comment>Return:</comment>
  <info>Future|null</info>  The return <info>parallel\Future</info> must not be ignored when the task contains a return or
               throw statement.


id: parallel\Sync::__construct
type: function
doc:
<comment>Description:</comment>
  Construction
  
  Shall construct a new synchronization object with no value
  
  Shall construct a new synchronization object containing the given scalar value


id: parallel\Sync::__invoke
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Shall exclusively enter into the critical code


id: parallel\Sync::get
type: function
doc:
<comment>Description:</comment>
  Access
  
  Shall atomically return the synchronization objects value

<comment>Return:</comment>
  <info>scalar</info>  


id: parallel\Sync::notify
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Shall notify one (by default) or all threads waiting on the synchronization object


id: parallel\Sync::set
type: function
doc:
<comment>Description:</comment>
  Access
  
  Shall atomically set the value of the synchronization object


id: parallel\Sync::wait
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Shall wait for notification on this synchronization object


id: parallel\bootstrap
type: function
doc:
<comment>Description:</comment>
  Bootstrapping
  
  Shall use the provided <strong>$file</strong> to bootstrap all runtimes created for automatic scheduling via
  <strong>parallel\run()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>  Path to the file to bootstrap all runtimes.

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

<comment>See Also:</comment>
   * 


id: parallel\run
type: function
doc:
<comment>Description:</comment>
  Execution
  
  Shall schedule <strong>$task</strong> for execution in parallel.
  
  Shall schedule <strong>$task</strong> for execution in parallel, passing <strong>$argv</strong> at execution time.

<comment>Param:</comment>
  <info>Closure</info>  <strong>$task</strong>  A <class>Closure</class> with specific characteristics.
  <info>array</info>    <strong>$argv</strong>  An <info>array</info> of arguments with specific characteristics to be passed to <strong>$task</strong> at
                  execution time.

<comment>Return:</comment>
  <info>Future|null</info>  The return <info>parallel\Future</info> must not be ignored when the task contains a return or
               throw statement.

<comment>See Also:</comment>
   * 


id: parse_ini_file
type: function
doc:
<comment>Description:</comment>
  Interpreta um arquivo de configuração
  
  <strong>parse_ini_file()</strong> carrega o arquivo INI especificado em <strong>$filename</strong> e retorna as configurações
  contidas nele em um array associativo.
  
  A estrutura do arquivo INI é a mesma do php.ini.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>          O nome do arquivo INI sendo interpretado. Se um caminho relativo for
                             usado, será avaliado relativamente ao diretório atual de trabalho, e
                             depois no caminho include_path.
  <info>bool</info>    <strong>$process_sections</strong>  Definindo o parâmetro <strong>$process_sections</strong> para <info>true</info>, obtém-se um array
                             multidimensional com os nomes das seções e configurações incluídos. O
                             padrão para <strong>$process_sections</strong> é <info>false</info>
  <info>int</info>     <strong>$scanner_mode</strong>      Pode ser <info>INI_SCANNER_NORMAL</info> (padrão) ou <info>INI_SCANNER_RAW</info>. Se
                             <info>INI_SCANNER_RAW</info> for fornecido, os valores das opções não serão
                             interpretados.
                             
                             A partir do PHP 5.6.1, também pode ser especificado como
                             <info>INI_SCANNER_TYPED</info>. Nesse modo, os tipos boolean, null e integer são
                             preservados quando possível. Os valores string <return>"true"</return>, <return>"on"</return> e <return>"yes"</return> são
                             convertidos em <info>true</info>. <return>"false"</return>, <return>"off"</return>, <return>"no"</return> e <return>"none"</return> são considerados
                             <info>false</info>. <return>"null"</return> é convertido para <info>null</info> no modo tipado. Além disso, todas
                             as strings numéricas são convertidas para o tipo inteiro, se possível.

<comment>Return:</comment>
  <info>array|false</info>  As configurações são retornadas como um <info>array</info> associativo em caso de sucesso, and
               <info>false</info> on failure.

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


id: parse_ini_string
type: function
doc:
<comment>Description:</comment>
  Interpreta uma string de configuração
  
  <strong>parse_ini_string()</strong> retorna as configurações da string <strong>$ini_string</strong> em um array associativo.
  
  A estrutura da string INI é a mesma dos php.ini's.

<comment>Param:</comment>
  <info>string</info>  <strong>$ini_string</strong>        O conteúdo do arquivo ini sendo interpretado.
  <info>bool</info>    <strong>$process_sections</strong>  Definindo o último parâmetro <strong>$process_sections</strong> como <info>true</info>, você recupera
                             um array multidimensional com o nome das seções e configurações
                             inclusas. O padrão para <strong>$process_sections</strong> é <info>false</info>
  <info>int</info>     <strong>$scanner_mode</strong>      O parâmetro pode ser <info>INI_SCANNER_NORMAL</info> (default) ou <info>INI_SCANNER_RAW</info>.
                             Se <info>INI_SCANNER_RAW</info> for fornecido, então os valores das opçoes não serão
                             analisados.
                             
                             A partir do PHP 5.6.1, também pode ser especificado como
                             <info>INI_SCANNER_TYPED</info>. Nesse modo, os tipos boolean, null e integer são
                             preservados quando possível. Os valores string <return>"true"</return>, <return>"on"</return> e <return>"yes"</return> são
                             convertidos em <info>true</info>. <return>"false"</return>, <return>"off"</return>, <return>"no"</return> e <return>"none"</return> são considerados
                             <info>false</info>. <return>"null"</return> é convertido para <info>null</info> no modo tipado. Além disso, todas
                             as strings numéricas são convertidas para o tipo inteiro, se possível.

<comment>Return:</comment>
  <info>array|false</info>  As configurações são retornadas como um <info>array</info> associativo, se sucesso e <info>false</info> caso
               falhe.

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


id: parse_str
type: function
doc:
<comment>Description:</comment>
  Converte a string em variáveis
  
  Interpreta <strong>$string</strong> como se ela fosse uma query string passada via URL e cria variáveis no escopo
  atual ou no array se informado em <strong>$result</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The input string.
  <info>array</info>   <strong>$result</strong>  Se o segundo parâmetro <strong>$result</strong> for informado, as variáveis serão gravadas como
                   elementos de array.
                   
                   Utilizar esta função sem o parâmetro <strong>$result</strong> é altamente DESENCORAJADO E OBSOLETO
                   a partir do PHP 7.2. Desde o 8.0.0, o parâmetro <strong>$result</strong> é obrigatório.

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

<comment>See Also:</comment>
   * <strong>parse_url()</strong>
   * <strong>pathinfo()</strong>
   * <strong>http_build_query()</strong>
   * <strong>urldecode()</strong>


id: parse_url
type: function
doc:
<comment>Description:</comment>
  Parse a URL and return its components
  
  This function parses a URL and returns an associative array containing any of the various
  components of the URL that are present. The values of the array elements are not URL decoded.
  
  This function is not meant to validate the given URL, it only breaks it up into the parts listed
  below. Partial and invalid URLs are also accepted, <strong>parse_url()</strong> tries its best to parse them
  correctly.

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>        The URL to parse.
  <info>int</info>     <strong>$component</strong>  Specify one of <info>PHP_URL_SCHEME</info>, <info>PHP_URL_HOST</info>, <info>PHP_URL_PORT</info>, <info>PHP_URL_USER</info>,
                      <info>PHP_URL_PASS</info>, <info>PHP_URL_PATH</info>, <info>PHP_URL_QUERY</info> or <info>PHP_URL_FRAGMENT</info> to retrieve just
                      a specific URL component as a <info>string</info> (except when <info>PHP_URL_PORT</info> is given, in
                      which case the return value will be an <info>int</info>).

<comment>Return:</comment>
  <info>int|string|array|null|false</info>  On seriously malformed URLs, <strong>parse_url()</strong> may return <info>false</info>.
                               
                               If the <strong>$component</strong> parameter is omitted, an associative <info>array</info> is
                               returned. At least one element will be present within the array.
                               Potential keys within this array are: scheme - e.g. http
                               hostportuserpasspathquery - after the question mark <return>?</return> fragment -
                               after the hashmark <return>#</return>
                               
                               scheme - e.g. http
                               
                               host
                               
                               port
                               
                               user
                               
                               pass
                               
                               path
                               
                               query - after the question mark <return>?</return>
                               
                               fragment - after the hashmark <return>#</return>
                               
                               If the <strong>$component</strong> parameter is specified, <strong>parse_url()</strong> returns a
                               <info>string</info> (or an <info>int</info>, in the case of <info>PHP_URL_PORT</info>) instead of an <info>array</info>.
                               If the requested component doesn't exist within the given URL, <info>null</info>
                               will be returned. As of PHP 8.0.0, <strong>parse_url()</strong> distinguishes absent
                               and empty queries and fragments:
                               
                               
                               
                               Previously all cases resulted in query and fragment being <info>null</info>.
                               
                               Note that control characters (cf. <strong>ctype_cntrl()</strong>) in the components
                               are replaced with underscores (<return>_</return>).

<comment>See Also:</comment>
   * <strong>pathinfo()</strong>
   * <strong>parse_str()</strong>
   * <strong>http_build_query()</strong>
   * <strong>dirname()</strong>
   * <strong>basename()</strong>
   * RFC 3986


id: passthru
type: function
doc:
<comment>Description:</comment>
  Execute an external program and display raw output
  
  The <strong>passthru()</strong> function is similar to the <strong>exec()</strong> function in that it executes a <strong>$command</strong>. This
  function should be used in place of <strong>exec()</strong> or <strong>system()</strong> when the output from the Unix command is
  binary data which needs to be passed directly back to the browser.  A common use for this is to
  execute something like the pbmplus utilities that can output an image stream directly.  By setting
  the Content-type to <return>image/gif</return> and then calling a pbmplus program to output a gif, you can create
  PHP scripts that output images directly.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>      The command that will be executed.
  <info>int</info>     <strong>$result_code</strong>  If the <strong>$result_code</strong> argument is present, the  return status of the Unix
                        command will be placed here.

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

<comment>See Also:</comment>
   * <strong>exec()</strong>
   * <strong>system()</strong>
   * <strong>popen()</strong>
   * <strong>escapeshellcmd()</strong>
   * backtick operator


id: password_get_info
type: function
doc:
<comment>Description:</comment>
  Retorna a informações sobre o hash fornecido
  
  Quando for passado um hash válido criado por um algoritmo suportado pela função <strong>password_hash()</strong>,
  esta função retornará um array com as informações sobre esse hash.

<comment>Param:</comment>
  <info>string</info>  <strong>$hash</strong>  Um hash criado por <strong>password_hash()</strong>.

<comment>Return:</comment>
  <info>array</info>  Retorna um array associativo com três elementos: <return>algo</return>, que corresponderá a uma constante de
         algoritmo de password <return>algoName</return>, que terá o nome legível do algoritmo <return>options</return>, que inclui as
         opções fornecidas quando chamou-se a função <strong>password_hash()</strong>
         
         <return>algo</return>, que corresponderá a uma constante de algoritmo de password
         
         <return>algoName</return>, que terá o nome legível do algoritmo
         
         <return>options</return>, que inclui as opções fornecidas quando chamou-se a função <strong>password_hash()</strong>


id: password_hash
type: function
doc:
<comment>Description:</comment>
  Cria um hash de senha
  
  <strong>password_hash()</strong> cria um novo hash de senha usando um algoritmo forte de hash de mão única.
  
  Os seguintes algoritmos são suportados atualmente:
  
  <info>PASSWORD_DEFAULT</info> - Usa o algoritmo bcrypt (padrão desde o PHP 5.5.0). Perceba que essa constante
  foi desenhada para mudar ao longo do tempo a medida que novos algoritmos mais fortes forem
  adicionados ao PHP. Por essa razão, o comprimento do resultado da utilização desse identificador
  pode mudar ao longo do tempo. Por isso, é recomendado que armazene o resultado em uma coluna do
  banco de dados que possa ser expandida além dos 60 caracteres (255 caracteres seria uma boa
  escolha). <info>PASSWORD_BCRYPT</info> - Usa o algoritmo <info>CRYPT_BLOWFISH</info> para criar o hash. Produzirá um hash
  compatível com o padrão <strong>crypt()</strong> usando o identificador "$2y$". O resultado será sempre uma string
  de 60 caracteres,  ou <info>false</info> em caso de falha. <info>PASSWORD_ARGON2I</info> - Usa o algoritmo Argon2i para
  criar o hash. Este algoritmo somente estará disponível se o PHP tiver sido compilado com suporte a
  Argon2. <info>PASSWORD_ARGON2ID</info> -  Usa o algoritmo Argon2is para criar o hash. Este algoritmo somente
  estará disponível se o PHP tiver sido compilado com suporte a Argon2.
  
  <info>PASSWORD_DEFAULT</info> - Usa o algoritmo bcrypt (padrão desde o PHP 5.5.0). Perceba que essa constante
  foi desenhada para mudar ao longo do tempo a medida que novos algoritmos mais fortes forem
  adicionados ao PHP. Por essa razão, o comprimento do resultado da utilização desse identificador
  pode mudar ao longo do tempo. Por isso, é recomendado que armazene o resultado em uma coluna do
  banco de dados que possa ser expandida além dos 60 caracteres (255 caracteres seria uma boa
  escolha).
  
  <info>PASSWORD_BCRYPT</info> - Usa o algoritmo <info>CRYPT_BLOWFISH</info> para criar o hash. Produzirá um hash compatível
  com o padrão <strong>crypt()</strong> usando o identificador "$2y$". O resultado será sempre uma string de 60
  caracteres,  ou <info>false</info> em caso de falha.
  
  <info>PASSWORD_ARGON2I</info> - Usa o algoritmo Argon2i para criar o hash. Este algoritmo somente estará
  disponível se o PHP tiver sido compilado com suporte a Argon2.
  
  <info>PASSWORD_ARGON2ID</info> -  Usa o algoritmo Argon2is para criar o hash. Este algoritmo somente estará
  disponível se o PHP tiver sido compilado com suporte a Argon2.
  
  Opções suportadas por <info>PASSWORD_BCRYPT</info>:
  
  <return>salt</return> (<info>string</info>) - para fornecer manualmente um salt a ser usado quando estiver sendo feito o hash da
  senha. Perceba que isso irá sobrepor e evitar que um salt seja gerado automaticamente.  Se
  omitido, um salt aleatório será gerado pela função <strong>password_hash()</strong> para cada senha sofrendo hash.
  Esse é o modo de operação desejado.  A opção salt está defasada. Agora é preferível que
  simplesmente se utilize o salt que é gerado por padrão. A partir do PHP 8.0.0, um salt fornecido
  explicitamente será ignorado. <return>cost</return> (<info>int</info>) - indica o custo de algoritmo que deve ser usado.
  Exemplos desses valores podem ser encontrados na página da função <strong>crypt()</strong>.  Se omitido, um valor
  padrão <return>10</return> será usado. Este é um bom patamar de custo, mas pode-se considerar aumentar esse valor
  dependendo do hardware.
  
  <return>salt</return> (<info>string</info>) - para fornecer manualmente um salt a ser usado quando estiver sendo feito o hash da
  senha. Perceba que isso irá sobrepor e evitar que um salt seja gerado automaticamente.
  
  Se omitido, um salt aleatório será gerado pela função <strong>password_hash()</strong> para cada senha sofrendo
  hash. Esse é o modo de operação desejado.
  
  A opção salt está defasada. Agora é preferível que simplesmente se utilize o salt que é gerado por
  padrão. A partir do PHP 8.0.0, um salt fornecido explicitamente será ignorado.
  
  <return>cost</return> (<info>int</info>) - indica o custo de algoritmo que deve ser usado. Exemplos desses valores podem ser
  encontrados na página da função <strong>crypt()</strong>.
  
  Se omitido, um valor padrão <return>10</return> será usado. Este é um bom patamar de custo, mas pode-se considerar
  aumentar esse valor dependendo do hardware.
  
  Opções suportadas por <info>PASSWORD_ARGON2I</info> e <info>PASSWORD_ARGON2ID</info>:
  
  <return>memory_cost</return> (<info>int</info>) - Máximo de mémoria (em kibibytes) que pode ser utilizado para computar o hash
  Argon2. O valor padrão é <info>PASSWORD_ARGON2_DEFAULT_MEMORY_COST</info>. <return>time_cost</return> (<info>int</info>) - Quantidade máxima
  de tempo que pode levar para computar o hash Argon2. O valor padrão é
  <info>PASSWORD_ARGON2_DEFAULT_TIME_COST</info>. <return>threads</return> (<info>int</info>) - Número de threads para computar o hash Argon2.
  O valor padrão é <info>PASSWORD_ARGON2_DEFAULT_THREADS</info>.  Disponível somente quando o PHP usa a
  libargon2, e não com a implementação libsodium.
  
  <return>memory_cost</return> (<info>int</info>) - Máximo de mémoria (em kibibytes) que pode ser utilizado para computar o hash
  Argon2. O valor padrão é <info>PASSWORD_ARGON2_DEFAULT_MEMORY_COST</info>.
  
  <return>time_cost</return> (<info>int</info>) - Quantidade máxima de tempo que pode levar para computar o hash Argon2. O valor
  padrão é <info>PASSWORD_ARGON2_DEFAULT_TIME_COST</info>.
  
  <return>threads</return> (<info>int</info>) - Número de threads para computar o hash Argon2. O valor padrão é
  <info>PASSWORD_ARGON2_DEFAULT_THREADS</info>.
  
  Disponível somente quando o PHP usa a libargon2, e não com a implementação libsodium.

<comment>Param:</comment>
  <info>string</info>           <strong>$password</strong>  A senha do usuário.
                              
                              Usando <info>PASSWORD_BCRYPT</info> como algoritmo, resultará no parâmetro
                              <strong>$password</strong> sendo truncado em um comprimento máximo de 72 bytes.
  <info>string|int|null</info>  <strong>$algo</strong>      Uma constante de algoritmo de senha denotando o algoritmo a ser usado
                              ao fazer o hash da senha.
  <info>array</info>            <strong>$options</strong>   Um array associativo contendo opções. Consulte as constantes de
                              algoritmo de senha para obter a documentação sobre as opções
                              suportadas por cada algoritmo.
                              
                              Se omitido, um salt aleatório será gerado e o custo padrão será usado.

<comment>Return:</comment>
  <info>string</info>  Retorna o hash da senha.
          
          O algoritmo, o custo e o salt utilizados são retornados como parte do hash. Dessa forma,
          toda informação necessária para verificar o hash é incluída nele. Isso permite que a
          função <strong>password_verify()</strong> verifique o hash sem precisar de um armazenamento separado para a
          informação do salt ou do algoritmo.

<comment>See Also:</comment>
   * <strong>password_verify()</strong>
   * <strong>password_needs_rehash()</strong>
   * <strong>crypt()</strong>
   * <strong>sodium_crypto_pwhash_str()</strong>


id: password_needs_rehash
type: function
doc:
<comment>Description:</comment>
  Verifica se o hash informado corresponde às opções especificadas
  
  Esta função verifica se o hash fornecido implementa o algoritmo e as opções indicadas. Se não, ela
  assume que o hash precisa ser recalculado.

<comment>Param:</comment>
  <info>string</info>           <strong>$hash</strong>     Um hash criado por <strong>password_hash()</strong>.
  <info>string|int|null</info>  <strong>$algo</strong>     Uma constante de algoritmo de senha denotando o algoritmo a ser usado
                             ao fazer o hash da senha.
  <info>array</info>            <strong>$options</strong>  Um array associativo contendo opções. Consulte as constantes de
                             algoritmo de senha para obter a documentação sobre as opções suportadas
                             por cada algoritmo.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se o hash deve ser recalculado para corresponder ao algortimo informado em
        <strong>$algo</strong> e às opções em <strong>$options</strong>, ou <info>false</info> caso contrário.


id: password_verify
type: function
doc:
<comment>Description:</comment>
  Verifica se uma senha corresponde a um hash
  
  Verifica se o hash fornecido corresponde à senha informada <strong>password_verify()</strong> é compatível com
  <strong>crypt()</strong>. Portanto, hashes de senha criadas por <strong>crypt()</strong> podem ser usados com <strong>password_verify()</strong>.
  
  Perceba que <strong>password_hash()</strong> retorna o algoritmo, custo e o salt como parte do hash retornado. Por
  isso, toda a informação necessária para verificar o hash está incluída nele. Isso permite que a
  função de verificação faça isso sem precisar de um armazenamento separado para a informação do
  salt ou do algoritmo.
  
  Esta função é segura contra ataques de sincronismo.

<comment>Param:</comment>
  <info>string</info>  <strong>$password</strong>  A senha do usuário.
  <info>string</info>  <strong>$hash</strong>      Um hash criado por <strong>password_hash()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se o password e o hash corresponderem, ou <info>false</info> caso contrário.

<comment>See Also:</comment>
   * <strong>password_needs_rehash()</strong>
   * <strong>password_hash()</strong>
   * implementação no espaço de usuário
   * <strong>sodium_crypto_pwhash_str_verify()</strong>


id: pathinfo
type: function
doc:
<comment>Description:</comment>
  Retorna informações sobre um caminho de arquivo
  
  <strong>pathinfo()</strong> retorna informações sobre o caminho em <strong>$path</strong>: ou um array associativo ou uma string,
  dependendo das opções em <strong>$flags</strong>.
  
  Para informação sobre obtenção de informação sobre o caminho atual, leia a seção sobre  variáveis
  reservadas predefinidas.
  
  <strong>pathinfo()</strong> opera ingenuamente na string de entrada, e não tem ciência sobre o sistema de arquivos
  real, ou componentes de caminho como "<return>..</return>".
  
  Apenas nos sistemas Windows, o caractere <return>\</return> será interpretado como um separador de diretório. Em
  outros sistemas será tratado como qualquer outro caractere.
  
  <strong>pathinfo()</strong> é afetado pela localidade, então para que seja interpretado corretamente um caminho
  contendo caracteres multibyte, a localização correspondente deve ser definida pela função
  <strong>setlocale()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>   O caminho a ser analisado.
  <info>int</info>     <strong>$flags</strong>  Se presente, define o elemento expecífico a ser retornado; pode ser
                  <info>PATHINFO_DIRNAME</info>, <info>PATHINFO_BASENAME</info>, <info>PATHINFO_EXTENSION</info> ou <info>PATHINFO_FILENAME</info>.
                  
                  Se <strong>$flags</strong> não for especificado, retorna todos os elementos disponíveis.

<comment>Return:</comment>
  <info>array|string</info>  Se o parâmetro <strong>$flags</strong> não for passado, um <info>array</info> associativo contendo os seguintes
                elementos é retornado: <return>dirname</return>, <return>basename</return>, <return>extension</return> (se houver), e <return>filename</return>.
                
                Se <strong>$path</strong> tiver mais de uma extensão, <info>PATHINFO_EXTENSION</info> retorna apenas a última e
                <info>PATHINFO_FILENAME</info> apenas remove a última. (veja o primeiro exemplo abaixo).
                
                Se <strong>$path</strong> não tiver uma extensão, nenhum elemento <return>extension</return> será retornado (veja o
                segundo exemplo abaixo).
                
                Se o <return>basename</return> do parâmetro <strong>$path</strong> começa com um ponto, os seguintes caracteres são
                interpretados como <return>extension</return>, e o <return>filename</return> estará vazio (veja o terceiro exemplo
                abaixo).
                
                Se <strong>$flags</strong> estiver presente, retorna uma <info>string</info> contendo o elemento solicitado.

<comment>See Also:</comment>
   * <strong>dirname()</strong>
   * <strong>basename()</strong>
   * <strong>parse_url()</strong>
   * <strong>realpath()</strong>


id: pclose
type: function
doc:
<comment>Description:</comment>
  Fecha o ponteiro de arquivo de processo
  
  Fecha um ponteiro de arquivo a um tubo aberto por <strong>popen()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  O ponteiro de arquivo deve ser válido e deve ter sido retornado por uma chamada
                     bem sucedida à função <strong>popen()</strong>.

<comment>Return:</comment>
  <info>int</info>  Retorna o estado da finalização do processo que estava em execução. Em caso de erro, <return>-1</return> é
       retornado.
       
       Se o PHP foi compilado com --enable-sigchild, o valor retornado por esta função é indefinido.

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


id: pcntl_alarm
type: function
doc:
<comment>Description:</comment>
  Set an alarm clock for delivery of a signal
  
  Creates a timer that will send a <info>SIGALRM</info> signal to the process after the given number of seconds.
  Any call to <strong>pcntl_alarm()</strong> will cancel any previously set alarm.

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds</strong>  The number of seconds to wait. If <strong>$seconds</strong> is zero, no new alarm is created.

<comment>Return:</comment>
  <info>int</info>  Returns the time in seconds that any previously scheduled alarm had remaining before it was
       to be delivered, or <return>0</return> if there was no previously scheduled alarm.


id: pcntl_async_signals
type: function
doc:
<comment>Description:</comment>
  Enable/disable asynchronous signal handling or return the old setting
  
  If the <strong>$enable</strong> parameter is <info>null</info>, <strong>pcntl_async_signals()</strong> returns whether asynchronous signal
  handling is enabled. Otherwise, asynchronous signal handling is enabled or disabled.

<comment>Param:</comment>
  <info>bool|null</info>  <strong>$enable</strong>  Whether asynchronous signal handling should be enabled.

<comment>Return:</comment>
  <info>bool</info>  When used as getter (<strong>$enable</strong> parameter is <info>null</info>) it returns whether asynchronous signal
        handling is enabled. When used as setter (<strong>$enable</strong> parameter is not <info>null</info>), it returns whether
        asynchronous signal handling was enabled before the function call.

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


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


id: pcntl_exec
type: function
doc:
<comment>Description:</comment>
  Executes specified program in current process space
  
  Executes the program with the given arguments.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>      <strong>$path</strong> must be the path to a binary executable or a script with a valid path
                     pointing to an executable in the shebang ( #!/usr/local/bin/perl for example)
                     as the first line.  See your system's man execve(2) page for additional
                     information.
  <info>array</info>   <strong>$args</strong>      <strong>$args</strong> is an array of argument strings passed to the program.
  <info>array</info>   <strong>$env_vars</strong>  <strong>$env_vars</strong> is an array of strings which are passed as environment to the
                     program.  The array is in the format of name =&gt; value, the key being the
                     name of the environmental variable and the value being the value of that
                     variable.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>false</info>.


id: pcntl_fork
type: function
doc:
<comment>Description:</comment>
  Forks the currently running process
  
  The <strong>pcntl_fork()</strong> function creates a child process that differs from the parent process only in its
  PID and PPID. Please see your system's fork(2) man page for specific details as to how fork works
  on your system.

<comment>Return:</comment>
  <info>int</info>  On success, the PID of the child process is returned in the parent's thread of execution, and
       a 0 is returned in the child's thread of execution.  On failure, a -1 will be returned in the
       parent's context, no child process will be created, and a PHP error is raised.

<comment>See Also:</comment>
   * <strong>pcntl_rfork()</strong>
   * <strong>pcntl_waitpid()</strong>
   * <strong>pcntl_signal()</strong>
   * <strong>cli_set_process_title()</strong>


id: pcntl_get_last_error
type: function
doc:
<comment>Description:</comment>
  Retrieve the error number set by the last pcntl function which failed
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  Returns error code.

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


id: pcntl_getpriority
type: function
doc:
<comment>Description:</comment>
  Get the priority of any process
  
  <strong>pcntl_getpriority()</strong> gets the priority of <strong>$process_id</strong>. Because priority levels can differ between
  system types and kernel versions, please see your system's getpriority(2) man page for specific
  details.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$process_id</strong>  If <info>null</info>, the process id of the current process is used.
  <info>int</info>       <strong>$mode</strong>        One of <info>PRIO_PGRP</info>, <info>PRIO_USER</info>, <info>PRIO_PROCESS</info>, <info>PRIO_DARWIN_BG</info> or
                         <info>PRIO_DARWIN_THREAD</info>.

<comment>Return:</comment>
  <info>int|false</info>  <strong>pcntl_getpriority()</strong> returns the priority of the process or <info>false</info> on error.  A lower
             numerical value causes more favorable scheduling.
             
             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>pcntl_setpriority()</strong>


id: pcntl_rfork
type: function
doc:
<comment>Description:</comment>
  Manipulates process resources
  
  Manipulates process resources.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>   The <strong>$flags</strong> parameter determines which resources of the invoking process (parent) are
                shared by the new process (child) or initialized to their default values.
                
                <strong>$flags</strong> is the logical OR of some subset of: <info>RFPROC</info>: If set a new process is created;
                otherwise changes affect the current process. <info>RFNOWAIT</info>: If set, the child process
                will be dissociated from the parent. Upon exit the child will not leave a status for
                the parent to collect. <info>RFFDG</info>: If set, the invoker's file descriptor table is copied;
                otherwise the two processes share a single table. <info>RFCFDG</info>: If set, the new process
                starts with a clean file descriptor table. Is mutually exclusive with <return>RFFDG</return>.
                <info>RFLINUXTHPN</info>: If set, the kernel will return SIGUSR1 instead of SIGCHILD upon thread
                exit for the child. This is intended to do Linux clone exit parent notification.
  <info>int</info>  <strong>$signal</strong>  The signal number.

<comment>Return:</comment>
  <info>int</info>  On success, the PID of the child process is returned in the parent's thread of execution, and
       a <return>0</return> is returned in the child's thread of execution.  On failure, a <return>-1</return> will be returned in the
       parent's context, no child process will be created, and a PHP error is raised.

<comment>See Also:</comment>
   * <strong>pcntl_fork()</strong>
   * <strong>pcntl_waitpid()</strong>
   * <strong>pcntl_signal()</strong>
   * <strong>cli_set_process_title()</strong>


id: pcntl_setpriority
type: function
doc:
<comment>Description:</comment>
  Change the priority of any process
  
  <strong>pcntl_setpriority()</strong> sets the priority of <strong>$process_id</strong>.

<comment>Param:</comment>
  <info>int</info>       <strong>$priority</strong>    <strong>$priority</strong> is generally a value in the range <return>-20</return> to <return>20</return>. The default priority
                         is <return>0</return> while a lower numerical value causes more favorable scheduling.
                         Because priority levels can differ between system types and kernel
                         versions, please see your system's setpriority(2) man page for specific
                         details.
  <info>int|null</info>  <strong>$process_id</strong>  If <info>null</info>, the process id of the current process is used.
  <info>int</info>       <strong>$mode</strong>        One of <info>PRIO_PGRP</info>, <info>PRIO_USER</info>, <info>PRIO_PROCESS</info>, <info>PRIO_DARWIN_BG</info> or
                         <info>PRIO_DARWIN_THREAD</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>pcntl_getpriority()</strong>
   * <strong>pcntl_setpriority()</strong>


id: pcntl_signal
type: function
doc:
<comment>Description:</comment>
  Installs a signal handler
  
  The <strong>pcntl_signal()</strong> function installs a new signal handler or replaces the current signal handler
  for the signal indicated by <strong>$signal</strong>.

<comment>Param:</comment>
  <info>int</info>           <strong>$signal</strong>            The signal number.
  <info>callable|int</info>  <strong>$handler</strong>           The signal handler. This may be either a <info>callable</info>, which will be
                                   invoked to handle the signal, or either of the two global
                                   constants <info>SIG_IGN</info> or <info>SIG_DFL</info>, which will ignore the signal or
                                   restore the default signal handler respectively.
                                   
                                   If a <info>callable</info> is given, it must implement the following
                                   signature:
                                   
                                   <info>void</info>handler<info>int</info><strong>$signo</strong><info>mixed</info><strong>$siginfo</strong><strong>$signal</strong> The signal being
                                   handled. <strong>$siginfo</strong> If operating systems supports siginfo_t
                                   structures, this will be an array of signal information dependent
                                   on the signal.
                                   
                                   The signal being handled.
                                   
                                   If operating systems supports siginfo_t structures, this will be
                                   an array of signal information dependent on the signal.
                                   
                                   Note that when you set a handler to an object method, that
                                   object's reference count is increased which makes it persist
                                   until you either change the handler to something else, or your
                                   script ends.
  <info>int</info>           <strong>$signal</strong>            The signal being handled.
  <info>mixed</info>         <strong>$siginfo</strong>           If operating systems supports siginfo_t structures, this will be
                                   an array of signal information dependent on the signal.
  <info>bool</info>          <strong>$restart_syscalls</strong>  Specifies whether system call restarting should be used when this
                                   signal arrives.

<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>pcntl_fork()</strong>
   * <strong>pcntl_waitpid()</strong>


id: pcntl_signal_dispatch
type: function
doc:
<comment>Description:</comment>
  Calls signal handlers for pending signals
  
  The <strong>pcntl_signal_dispatch()</strong> function calls the signal  handlers installed by <strong>pcntl_signal()</strong> for
  each pending signal.

<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>pcntl_signal()</strong>
   * <strong>pcntl_sigprocmask()</strong>
   * <strong>pcntl_sigwaitinfo()</strong>
   * <strong>pcntl_sigtimedwait()</strong>


id: pcntl_signal_get_handler
type: function
doc:
<comment>Description:</comment>
  Get the current handler for specified signal
  
  The <strong>pcntl_signal_get_handler()</strong> function will get the current handler for the specified <strong>$signal</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$signal</strong>  The signal number.

<comment>Return:</comment>
  <info>callable|int</info>  This function may return an integer value that refers to <info>SIG_DFL</info> or <info>SIG_IGN</info>. If a
                custom handler has been set, that <info>callable</info> is returned.

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


id: pcntl_sigprocmask
type: function
doc:
<comment>Description:</comment>
  Sets and retrieves blocked signals
  
  The <strong>pcntl_sigprocmask()</strong> function adds, removes or sets blocked signals, depending on the <strong>$mode</strong>
  parameter.

<comment>Param:</comment>
  <info>int</info>    <strong>$mode</strong>         Sets the behavior of <strong>pcntl_sigprocmask()</strong>. Possible values:  <info>SIG_BLOCK</info>: Add
                       the signals to the currently blocked signals.<info>SIG_UNBLOCK</info>: Remove the signals
                       from the currently blocked signals.<info>SIG_SETMASK</info>: Replace the currently blocked
                       signals by the given list of signals.
  <info>array</info>  <strong>$signals</strong>      List of signals.
  <info>array</info>  <strong>$old_signals</strong>  The <strong>$old_signals</strong> parameter is set to an array containing the list of the
                       previously blocked signals.

<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>pcntl_sigwaitinfo()</strong>
   * <strong>pcntl_sigtimedwait()</strong>


id: pcntl_sigtimedwait
type: function
doc:
<comment>Description:</comment>
  Waits for signals, with a timeout
  
  The <strong>pcntl_sigtimedwait()</strong> function operates in exactly the same way as <strong>pcntl_sigwaitinfo()</strong> except
  that it takes two additional parameters, <strong>$seconds</strong> and <strong>$nanoseconds</strong>, which enable an upper bound to
  be placed on the time for which the script is suspended.

<comment>Param:</comment>
  <info>array</info>  <strong>$signals</strong>      Array of signals to wait for.
  <info>array</info>  <strong>$info</strong>         The <strong>$info</strong> is set to an array containing information about the signal. See
                       <strong>pcntl_sigwaitinfo()</strong>.
  <info>int</info>    <strong>$seconds</strong>      Timeout in seconds.
  <info>int</info>    <strong>$nanoseconds</strong>  Timeout in nanoseconds.

<comment>Return:</comment>
  <info>int|false</info>  <strong>pcntl_sigtimedwait()</strong> returns a signal number on success,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>pcntl_sigprocmask()</strong>
   * <strong>pcntl_sigwaitinfo()</strong>


