# php_manual

id: token_get_all
type: function
doc:
<comment>Description:</comment>
  Divide um dado fonte em tokens do PHP
  
  <strong>token_get_all()</strong> analisa o <strong>$code</strong> fornecido em tokens da linguagem PHP usando o avaliador léxico do
  Zend engine.
  
  Para uma lista dos tokens do avaliador, veja , ou use <strong>token_name()</strong> para traduzir um valor de um
  token para sua representação em formato string.

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>   O código-fonte do PHP à ser avaliado.
  <info>int</info>     <strong>$flags</strong>  Flags válidas: <info>TOKEN_PARSE</info> - Reconhece a capacidade de usar palavras reservadas em
                  contextos específicos.
                  
                  <info>TOKEN_PARSE</info> - Reconhece a capacidade de usar palavras reservadas em contextos
                  específicos.

<comment>Return:</comment>
  <info>array</info>  Um array de identificadores de tokens. Cada identificador de token individual ou é um
         caracter único (ex.: <return>;</return>, <return>.</return>, <return>&gt;</return>, <return>!</return>, etc...), ou um array com três elementos contendo o
         índice do token no elemento 0, a string contendo o token original no elemento 1 e o número
         da linha no elemento 2.

<comment>See Also:</comment>
   * <strong>PhpToken::tokenize()</strong>
   * <strong>token_name()</strong>


id: token_name
type: function
doc:
<comment>Description:</comment>
  Pega o nome simbólico de um dado token do PHP
  
  <strong>token_name()</strong> Pega o nome simbólico para o valor de <strong>$id</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$id</strong>  O valor do token.

<comment>Return:</comment>
  <info>string</info>  O nome simbólico do dado <strong>$id</strong>.

<comment>See Also:</comment>
   * Lista de tokens do analisador
   * <strong>PhpToken::getTokenName()</strong>


id: touch
type: function
doc:
<comment>Description:</comment>
  Define horário de acesso e de modificação de arquivo
  
  Tenta mudar os horários de acesso e modificação do arquivo no parâmetro <strong>$filename</strong> para o valor
  informado em <strong>$mtime</strong>. Note que o horário de acesso é sempre modificado, independente do número de
  parâmetros.
  
  Se o arquivo não existe, ele será criado.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  O nome do arquivo a ser atualizado.
  <info>int|null</info>  <strong>$mtime</strong>     Horário da atualização. Se <strong>$mtime</strong> for <info>null</info>, o horário atual do sistema
                       (<strong>time()</strong>) é usado.
  <info>int|null</info>  <strong>$atime</strong>     Se não <info>null</info>, o horário de acesso do arquivo é definido para o valor de
                       <strong>$atime</strong>. Caso contrário, é definido para o valor passado ao parâmetro <strong>$mtime</strong>.
                       Se ambos forem <info>null</info>, o horário atual do sistema é usado.

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


id: trader_acos
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric ACos
  
  Calculates the arc cosine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ad
type: function
doc:
<comment>Description:</comment>
  Chaikin A/D Line

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>    Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>     Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>   Preço de fechamento, array de valores reais.
  <info>array</info>  <strong>$volume</strong>  Volume negociado, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_add
type: function
doc:
<comment>Description:</comment>
  Vector Arithmetic Add
  
  Calculates the vector addition of <strong>$real0</strong> to <strong>$real1</strong> and returns the resulting vector.

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>  Array de valores reais.
  <info>array</info>  <strong>$real1</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_adosc
type: function
doc:
<comment>Description:</comment>
  Chaikin A/D Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>       Preço de fechamento, array de valores reais.
  <info>array</info>  <strong>$volume</strong>      Volume negociado, array de valores reais.
  <info>int</info>    <strong>$fastPeriod</strong>  Número de período para o MA rápido. Intervalo válido de 2 a 100000.
  <info>int</info>    <strong>$slowPeriod</strong>  Número de período para o MA lento. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_adx
type: function
doc:
<comment>Description:</comment>
  Average Directional Movement Index

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>       Preço de fechamento, array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_adxr
type: function
doc:
<comment>Description:</comment>
  Average Directional Movement Index Rating

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>       Preço de fechamento, array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_apo
type: function
doc:
<comment>Description:</comment>
  Absolute Price Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$fastPeriod</strong>  Número de período para o MA rápido. Intervalo válido de 2 a 100000.
  <info>int</info>    <strong>$slowPeriod</strong>  Número de período para o MA lento. Intervalo válido de 2 a 100000.
  <info>int</info>    <strong>$mAType</strong>      Tipo de Média Móvel. As constantes TRADER_MA_TYPE_* devem ser usadas.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_aroon
type: function
doc:
<comment>Description:</comment>
  Aroon

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_aroonosc
type: function
doc:
<comment>Description:</comment>
  Aroon Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_asin
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric ASin
  
  Calculates the arc sine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_atan
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric ATan
  
  Calculates the arc tangent for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_atr
type: function
doc:
<comment>Description:</comment>
  Average True Range

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>       Preço de fechamento, array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_avgprice
type: function
doc:
<comment>Description:</comment>
  Average Price

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_bbands
type: function
doc:
<comment>Description:</comment>
  Bollinger Bands

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.
  <info>float</info>  <strong>$nbDevUp</strong>     Multiplicador de desvio para banda superior. Intervalo válido de
                      TRADER_REAL_MIN a TRADER_REAL_MAX.
  <info>float</info>  <strong>$nbDevDn</strong>     Multiplicador de desvio para a banda inferior. Intervalo válido de
                      TRADER_REAL_MIN a TRADER_REAL_MAX.
  <info>int</info>    <strong>$mAType</strong>      Tipo de Média Móvel. As constantes TRADER_MA_TYPE_* devem ser usadas.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_beta
type: function
doc:
<comment>Description:</comment>
  Beta

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>       Array de valores reais.
  <info>array</info>  <strong>$real1</strong>       Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_bop
type: function
doc:
<comment>Description:</comment>
  Balance Of Power

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cci
type: function
doc:
<comment>Description:</comment>
  Commodity Channel Index

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>       Preço de fechamento, array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl2crows
type: function
doc:
<comment>Description:</comment>
  Two Crows

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3blackcrows
type: function
doc:
<comment>Description:</comment>
  Three Black Crows

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3inside
type: function
doc:
<comment>Description:</comment>
  Three Inside Up/Down

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3linestrike
type: function
doc:
<comment>Description:</comment>
  Three-Line Strike

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3outside
type: function
doc:
<comment>Description:</comment>
  Three Outside Up/Down

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3starsinsouth
type: function
doc:
<comment>Description:</comment>
  Three Stars In The South

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3whitesoldiers
type: function
doc:
<comment>Description:</comment>
  Three Advancing White Soldiers

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlabandonedbaby
type: function
doc:
<comment>Description:</comment>
  Abandoned Baby

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>         Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>         Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>          Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>        Preço de fechamento, array de valores reais.
  <info>float</info>  <strong>$penetration</strong>  Percentual de penetração de um candle em outro candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdladvanceblock
type: function
doc:
<comment>Description:</comment>
  Advance Block

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlbelthold
type: function
doc:
<comment>Description:</comment>
  Belt-hold

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlbreakaway
type: function
doc:
<comment>Description:</comment>
  Breakaway

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlclosingmarubozu
type: function
doc:
<comment>Description:</comment>
  Closing Marubozu

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlconcealbabyswall
type: function
doc:
<comment>Description:</comment>
  Concealing Baby Swallow

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlcounterattack
type: function
doc:
<comment>Description:</comment>
  Counterattack

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdldarkcloudcover
type: function
doc:
<comment>Description:</comment>
  Dark Cloud Cover

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>         Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>         Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>          Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>        Preço de fechamento, array de valores reais.
  <info>float</info>  <strong>$penetration</strong>  Percentual de penetração de um candle em outro candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdldoji
type: function
doc:
<comment>Description:</comment>
  Doji

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdldojistar
type: function
doc:
<comment>Description:</comment>
  Doji Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdldragonflydoji
type: function
doc:
<comment>Description:</comment>
  Dragonfly Doji

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlengulfing
type: function
doc:
<comment>Description:</comment>
  Engulfing Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdleveningdojistar
type: function
doc:
<comment>Description:</comment>
  Evening Doji Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>         Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>         Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>          Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>        Preço de fechamento, array de valores reais.
  <info>float</info>  <strong>$penetration</strong>  Percentual de penetração de um candle em outro candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdleveningstar
type: function
doc:
<comment>Description:</comment>
  Evening Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>         Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>         Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>          Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>        Preço de fechamento, array de valores reais.
  <info>float</info>  <strong>$penetration</strong>  Percentual de penetração de um candle em outro candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlgapsidesidewhite
type: function
doc:
<comment>Description:</comment>
  Up/Down-gap side-by-side white lines

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlgravestonedoji
type: function
doc:
<comment>Description:</comment>
  Gravestone Doji

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhammer
type: function
doc:
<comment>Description:</comment>
  Hammer

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhangingman
type: function
doc:
<comment>Description:</comment>
  Hanging Man

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlharami
type: function
doc:
<comment>Description:</comment>
  Harami Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlharamicross
type: function
doc:
<comment>Description:</comment>
  Harami Cross Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhighwave
type: function
doc:
<comment>Description:</comment>
  High-Wave Candle

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhikkake
type: function
doc:
<comment>Description:</comment>
  Hikkake Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhikkakemod
type: function
doc:
<comment>Description:</comment>
  Modified Hikkake Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhomingpigeon
type: function
doc:
<comment>Description:</comment>
  Homing Pigeon

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlidentical3crows
type: function
doc:
<comment>Description:</comment>
  Identical Three Crows

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlinneck
type: function
doc:
<comment>Description:</comment>
  In-Neck Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlinvertedhammer
type: function
doc:
<comment>Description:</comment>
  Inverted Hammer

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlkicking
type: function
doc:
<comment>Description:</comment>
  Kicking

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlkickingbylength
type: function
doc:
<comment>Description:</comment>
  Kicking - bull/bear determined by the longer marubozu

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlladderbottom
type: function
doc:
<comment>Description:</comment>
  Ladder Bottom

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdllongleggeddoji
type: function
doc:
<comment>Description:</comment>
  Long Legged Doji

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdllongline
type: function
doc:
<comment>Description:</comment>
  Long Line Candle

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlmarubozu
type: function
doc:
<comment>Description:</comment>
  Marubozu

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlmatchinglow
type: function
doc:
<comment>Description:</comment>
  Matching Low

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlmathold
type: function
doc:
<comment>Description:</comment>
  Mat Hold

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>         Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>         Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>          Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>        Preço de fechamento, array de valores reais.
  <info>float</info>  <strong>$penetration</strong>  Percentual de penetração de um candle em outro candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlmorningdojistar
type: function
doc:
<comment>Description:</comment>
  Morning Doji Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>         Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>         Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>          Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>        Preço de fechamento, array de valores reais.
  <info>float</info>  <strong>$penetration</strong>  Percentual de penetração de um candle em outro candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlmorningstar
type: function
doc:
<comment>Description:</comment>
  Morning Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>         Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>         Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>          Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>        Preço de fechamento, array de valores reais.
  <info>float</info>  <strong>$penetration</strong>  Percentual de penetração de um candle em outro candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlonneck
type: function
doc:
<comment>Description:</comment>
  On-Neck Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlpiercing
type: function
doc:
<comment>Description:</comment>
  Piercing Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlrickshawman
type: function
doc:
<comment>Description:</comment>
  Rickshaw Man

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlrisefall3methods
type: function
doc:
<comment>Description:</comment>
  Rising/Falling Three Methods

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlseparatinglines
type: function
doc:
<comment>Description:</comment>
  Separating Lines

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlshootingstar
type: function
doc:
<comment>Description:</comment>
  Shooting Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlshortline
type: function
doc:
<comment>Description:</comment>
  Short Line Candle

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlspinningtop
type: function
doc:
<comment>Description:</comment>
  Spinning Top

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlstalledpattern
type: function
doc:
<comment>Description:</comment>
  Stalled Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlsticksandwich
type: function
doc:
<comment>Description:</comment>
  Stick Sandwich

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdltakuri
type: function
doc:
<comment>Description:</comment>
  Takuri (Dragonfly Doji with very long lower shadow)

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdltasukigap
type: function
doc:
<comment>Description:</comment>
  Tasuki Gap

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlthrusting
type: function
doc:
<comment>Description:</comment>
  Thrusting Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdltristar
type: function
doc:
<comment>Description:</comment>
  Tristar Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlunique3river
type: function
doc:
<comment>Description:</comment>
  Unique 3 River

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlupsidegap2crows
type: function
doc:
<comment>Description:</comment>
  Upside Gap Two Crows

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlxsidegap3methods
type: function
doc:
<comment>Description:</comment>
  Upside/Downside Gap Three Methods

<comment>Param:</comment>
  <info>array</info>  <strong>$open</strong>   Preço de abertura, array de valores reais.
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ceil
type: function
doc:
<comment>Description:</comment>
  Vector Ceil
  
  Calculates the next highest integer for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cmo
type: function
doc:
<comment>Description:</comment>
  Chande Momentum Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_correl
type: function
doc:
<comment>Description:</comment>
  Pearson's Correlation Coefficient (r)

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>       Array de valores reais.
  <info>array</info>  <strong>$real1</strong>       Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cos
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Cos
  
  Calculates the cosine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cosh
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Cosh
  
  Calculates the hyperbolic cosine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_dema
type: function
doc:
<comment>Description:</comment>
  Double Exponential Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_div
type: function
doc:
<comment>Description:</comment>
  Vector Arithmetic Div
  
  Divides each value from <strong>$real0</strong> by the corresponding value from <strong>$real1</strong> and returns the resulting
  array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>  Array de valores reais.
  <info>array</info>  <strong>$real1</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_dx
type: function
doc:
<comment>Description:</comment>
  Directional Movement Index

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>       Preço de fechamento, array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ema
type: function
doc:
<comment>Description:</comment>
  Exponential Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_errno
type: function
doc:
<comment>Description:</comment>
  Get error code
  
  Get error code of the last operation.

<comment>Return:</comment>
  <info>int</info>  Returns the error code identified by one of the TRADER_ERR_* constants.


id: trader_exp
type: function
doc:
<comment>Description:</comment>
  Vector Arithmetic Exp
  
  Calculates <info>e</info> raised to the power of each value in <strong>$real</strong>. Returns an array with the calculated
  data.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_floor
type: function
doc:
<comment>Description:</comment>
  Vector Floor
  
  Calculates the next lowest integer for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_get_compat
type: function
doc:
<comment>Description:</comment>
  Get compatibility mode
  
  Get compatibility mode which affects the way calculations are done by all the extension functions.

<comment>Return:</comment>
  <info>int</info>  Returns the compatibility mode id which can be identified by TRADER_COMPATIBILITY_* series of
       constants.


id: trader_get_unstable_period
type: function
doc:
<comment>Description:</comment>
  Get unstable period
  
  Get unstable period factor for a particular function.

<comment>Param:</comment>
  <info>int</info>  <strong>$functionId</strong>  Function ID the factor to be read for. TRADER_FUNC_UNST_* series of constants
                    should be used.

<comment>Return:</comment>
  <info>int</info>  Returns the unstable period factor for the corresponding function.


id: trader_ht_dcperiod
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - Dominant Cycle Period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ht_dcphase
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - Dominant Cycle Phase

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ht_phasor
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - Phasor Components

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ht_sine
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - SineWave

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ht_trendline
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - Instantaneous Trendline

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ht_trendmode
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - Trend vs Cycle Mode

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_kama
type: function
doc:
<comment>Description:</comment>
  Kaufman Adaptive Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_linearreg
type: function
doc:
<comment>Description:</comment>
  Linear Regression

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_linearreg_angle
type: function
doc:
<comment>Description:</comment>
  Linear Regression Angle

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_linearreg_intercept
type: function
doc:
<comment>Description:</comment>
  Linear Regression Intercept

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_linearreg_slope
type: function
doc:
<comment>Description:</comment>
  Linear Regression Slope

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ln
type: function
doc:
<comment>Description:</comment>
  Vector Log Natural
  
  Calculates the natural logarithm for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_log10
type: function
doc:
<comment>Description:</comment>
  Vector Log10
  
  Calculates the base-10 logarithm for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ma
type: function
doc:
<comment>Description:</comment>
  Moving average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.
  <info>int</info>    <strong>$mAType</strong>      Tipo de Média Móvel. As constantes TRADER_MA_TYPE_* devem ser usadas.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_macd
type: function
doc:
<comment>Description:</comment>
  Moving Average Convergence/Divergence

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>          Array de valores reais.
  <info>int</info>    <strong>$fastPeriod</strong>    Número de período para o MA rápido. Intervalo válido de 2 a 100000.
  <info>int</info>    <strong>$slowPeriod</strong>    Número de período para o MA lento. Intervalo válido de 2 a 100000.
  <info>int</info>    <strong>$signalPeriod</strong>  Suavização da linha de sinal (número de período). Intervalo válido de 1 a
                        100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_macdext
type: function
doc:
<comment>Description:</comment>
  MACD with controllable MA type

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>          Array de valores reais.
  <info>int</info>    <strong>$fastPeriod</strong>    Número de período para o MA rápido. Intervalo válido de 2 a 100000.
  <info>int</info>    <strong>$fastMAType</strong>    Tipo de Média Móvel para o MA rápido. As constantes TRADER_MA_TYPE_* devem
                        ser usadas.
  <info>int</info>    <strong>$slowPeriod</strong>    Número de período para o MA lento. Intervalo válido de 2 a 100000.
  <info>int</info>    <strong>$slowMAType</strong>    Tipo de Média Móvel para o MA lento. As constantes TRADER_MA_TYPE_* devem
                        ser usadas.
  <info>int</info>    <strong>$signalPeriod</strong>  Suavização da linha de sinal (número de período). Intervalo válido de 1 a
                        100000.
  <info>int</info>    <strong>$signalMAType</strong>  Tipo de Média Móvel para a linha de sinal. As constantes TRADER_MA_TYPE_*
                        devem ser usadas.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_macdfix
type: function
doc:
<comment>Description:</comment>
  Moving Average Convergence/Divergence Fix 12/26

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>          Array de valores reais.
  <info>int</info>    <strong>$signalPeriod</strong>  Suavização da linha de sinal (número de período). Intervalo válido de 1 a
                        100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_mama
type: function
doc:
<comment>Description:</comment>
  MESA Adaptive Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>       Array de valores reais.
  <info>float</info>  <strong>$fastLimit</strong>  Limite superior usado no algoritmo adaptativo. Intervalo válido de 0.01 a 0.99.
  <info>float</info>  <strong>$slowLimit</strong>  Limite inferior usado no algoritmo adaptativo. Intervalo válido de 0.01 a 0.99.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_mavp
type: function
doc:
<comment>Description:</comment>
  Moving average with variable period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>       Array de valores reais.
  <info>array</info>  <strong>$periods</strong>    Array de valores reais.
  <info>int</info>    <strong>$minPeriod</strong>  Valor inferior ao mínimo que será modificado para período mínimo. Intervalo
                     válido de 2 a 100000.
  <info>int</info>    <strong>$maxPeriod</strong>  Valor superior ao mínimo que será modificado para período máximo. Intervalo
                     válido de 2 a 100000.
  <info>int</info>    <strong>$mAType</strong>     Tipo de Média Móvel. As constantes TRADER_MA_TYPE_* devem ser usadas.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_max
type: function
doc:
<comment>Description:</comment>
  Highest value over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_maxindex
type: function
doc:
<comment>Description:</comment>
  Index of highest value over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_medprice
type: function
doc:
<comment>Description:</comment>
  Median Price

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>  Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>   Preço baixo, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_mfi
type: function
doc:
<comment>Description:</comment>
  Money Flow Index

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>       Preço de fechamento, array de valores reais.
  <info>array</info>  <strong>$volume</strong>      Volume negociado, array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_midpoint
type: function
doc:
<comment>Description:</comment>
  MidPoint over period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_midprice
type: function
doc:
<comment>Description:</comment>
  Midpoint Price over period

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_min
type: function
doc:
<comment>Description:</comment>
  Lowest value over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_minindex
type: function
doc:
<comment>Description:</comment>
  Index of lowest value over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_minmax
type: function
doc:
<comment>Description:</comment>
  Lowest and highest values over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_minmaxindex
type: function
doc:
<comment>Description:</comment>
  Indexes of lowest and highest values over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_minus_di
type: function
doc:
<comment>Description:</comment>
  Minus Directional Indicator

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>       Preço de fechamento, array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_minus_dm
type: function
doc:
<comment>Description:</comment>
  Minus Directional Movement

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_mom
type: function
doc:
<comment>Description:</comment>
  Momentum

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_mult
type: function
doc:
<comment>Description:</comment>
  Vector Arithmetic Mult
  
  Calculates the vector dot product of <strong>$real0</strong> with <strong>$real1</strong> and returns the resulting vector.

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>  Array de valores reais.
  <info>array</info>  <strong>$real1</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_natr
type: function
doc:
<comment>Description:</comment>
  Normalized Average True Range

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>       Preço de fechamento, array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_obv
type: function
doc:
<comment>Description:</comment>
  On Balance Volume

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>    Array de valores reais.
  <info>array</info>  <strong>$volume</strong>  Volume negociado, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_plus_di
type: function
doc:
<comment>Description:</comment>
  Plus Directional Indicator

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>       Preço de fechamento, array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_plus_dm
type: function
doc:
<comment>Description:</comment>
  Plus Directional Movement

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ppo
type: function
doc:
<comment>Description:</comment>
  Percentage Price Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$fastPeriod</strong>  Número de período para o MA rápido. Intervalo válido de 2 a 100000.
  <info>int</info>    <strong>$slowPeriod</strong>  Número de período para o MA lento. Intervalo válido de 2 a 100000.
  <info>int</info>    <strong>$mAType</strong>      Tipo de Média Móvel. As constantes TRADER_MA_TYPE_* devem ser usadas.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_roc
type: function
doc:
<comment>Description:</comment>
  Rate of change : ((price/prevPrice)-1)*100

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_rocp
type: function
doc:
<comment>Description:</comment>
  Rate of change Percentage: (price-prevPrice)/prevPrice

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_rocr
type: function
doc:
<comment>Description:</comment>
  Rate of change ratio: (price/prevPrice)

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_rocr100
type: function
doc:
<comment>Description:</comment>
  Rate of change ratio 100 scale: (price/prevPrice)*100

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_rsi
type: function
doc:
<comment>Description:</comment>
  Relative Strength Index

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sar
type: function
doc:
<comment>Description:</comment>
  Parabolic SAR

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>          Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>           Preço baixo, array de valores reais.
  <info>float</info>  <strong>$acceleration</strong>  Acceleration Factor used up to the Maximum value. Valid range from 0 to
                        TRADER_REAL_MAX.
  <info>float</info>  <strong>$maximum</strong>       Acceleration Factor Maximum value. Valid range from 0 to TRADER_REAL_MAX.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sarext
type: function
doc:
<comment>Description:</comment>
  Parabolic SAR - Extended

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>                   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>                    Preço baixo, array de valores reais.
  <info>float</info>  <strong>$startValue</strong>             Start value and direction. 0 for Auto, &gt;0 for Long, \<0 for Short. Valid range from TRADER_REAL_MIN to TRADER_REAL_MAX.
  <info>float</info>  <strong>$offsetOnReverse</strong>        Percent offset added/removed to initial stop on short/long
                                 reversal. Valid range from 0 to TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationInitLong</strong>   Acceleration Factor initial value for the Long direction. Valid
                                 range from 0 to TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationLong</strong>       Acceleration Factor for the Long direction. Valid range from 0 to
                                 TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationMaxLong</strong>    Acceleration Factor maximum value for the Long direction. Valid
                                 range from 0 to TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationInitShort</strong>  Acceleration Factor initial value for the Short direction. Valid
                                 range from 0 to TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationShort</strong>      Acceleration Factor for the Short direction. Valid range from 0 to
                                 TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationMaxShort</strong>   Acceleration Factor maximum value for the Short direction. Valid
                                 range from 0 to TRADER_REAL_MAX.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_set_compat
type: function
doc:
<comment>Description:</comment>
  Set compatibility mode
  
  Set compatibility mode which will affect the way calculations are done by all the extension
  functions.

<comment>Param:</comment>
  <info>int</info>  <strong>$compatId</strong>  Compatibility Id. TRADER_COMPATIBILITY_* series of constants should be used.

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


id: trader_set_unstable_period
type: function
doc:
<comment>Description:</comment>
  Set unstable period
  
  Influences unstable period factor for functions, which are sensible to it. More information about
  unstable periods can be found on the TA-Lib API documentation page.

<comment>Param:</comment>
  <info>int</info>  <strong>$functionId</strong>  Function ID the factor should be set for. TRADER_FUNC_UNST_* constant series can
                    be used to affect the corresponding function.
  <info>int</info>  <strong>$timePeriod</strong>  Unstable period value.

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


id: trader_sin
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Sin
  
  Calculates the sine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sinh
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Sinh
  
  Calculates the hyperbolic sine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sma
type: function
doc:
<comment>Description:</comment>
  Simple Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sqrt
type: function
doc:
<comment>Description:</comment>
  Vector Square Root
  
  Calculates the square root of each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_stddev
type: function
doc:
<comment>Description:</comment>
  Standard Deviation

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.
  <info>float</info>  <strong>$nbDev</strong>       

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_stoch
type: function
doc:
<comment>Description:</comment>
  Stochastic

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>          Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>           Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>         Preço de fechamento, array de valores reais.
  <info>int</info>    <strong>$fastK_Period</strong>  Período de tempo para a construção da linha Fast-K. Intervalo válido de 1 a
                        100000.
  <info>int</info>    <strong>$slowK_Period</strong>  Suavização na construção da linha Slow-K. Intervalo válido de 1 a 100000,
                        geralmente 3.
  <info>int</info>    <strong>$slowK_MAType</strong>  Tipo de Média Móvel para o Slow-K. As constantes TRADER_MA_TYPE_* devem ser
                        usadas.
  <info>int</info>    <strong>$slowD_Period</strong>  Suavização na construção da linha Slow-D. Intervalo válido de 1 a 100000.
  <info>int</info>    <strong>$slowD_MAType</strong>  Tipo de Média Móvel para o Slow-D. As constantes TRADER_MA_TYPE_* devem ser
                        usadas.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_stochf
type: function
doc:
<comment>Description:</comment>
  Stochastic Fast

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>          Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>           Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>         Preço de fechamento, array de valores reais.
  <info>int</info>    <strong>$fastK_Period</strong>  Período de tempo para a construção da linha Fast-K. Intervalo válido de 1 a
                        100000.
  <info>int</info>    <strong>$fastD_Period</strong>  Suavização na construção da linha Fast-D. Intervalo válido de 1 a 100000,
                        geralmente 3.
  <info>int</info>    <strong>$fastD_MAType</strong>  Tipo de Média Móvel para o Fast-D. As constantes TRADER_MA_TYPE_* devem ser
                        usadas.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_stochrsi
type: function
doc:
<comment>Description:</comment>
  Stochastic Relative Strength Index

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>          Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>    Número de período. Intervalo válido de 2 a 100000.
  <info>int</info>    <strong>$fastK_Period</strong>  Período de tempo para a construção da linha Fast-K. Intervalo válido de 1 a
                        100000.
  <info>int</info>    <strong>$fastD_Period</strong>  Suavização na construção da linha Fast-D. Intervalo válido de 1 a 100000,
                        geralmente 3.
  <info>int</info>    <strong>$fastD_MAType</strong>  Tipo de Média Móvel para o Fast-D. As constantes TRADER_MA_TYPE_* devem ser
                        usadas.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sub
type: function
doc:
<comment>Description:</comment>
  Vector Arithmetic Subtraction
  
  Calculates the vector subtraction of <strong>$real1</strong> from <strong>$real0</strong> and returns the resulting vector.

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>  Array de valores reais.
  <info>array</info>  <strong>$real1</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sum
type: function
doc:
<comment>Description:</comment>
  Summation

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_t3
type: function
doc:
<comment>Description:</comment>
  Triple Exponential Moving Average (T3)

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.
  <info>float</info>  <strong>$vFactor</strong>     Fator de volume. Intervalo válido de 1 a 0.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_tan
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Tan
  
  Calculates the tangent for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_tanh
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Tanh
  
  Calculates the hyperbolic tangent for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_tema
type: function
doc:
<comment>Description:</comment>
  Triple Exponential Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_trange
type: function
doc:
<comment>Description:</comment>
  True Range

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_trima
type: function
doc:
<comment>Description:</comment>
  Triangular Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_trix
type: function
doc:
<comment>Description:</comment>
  1-day Rate-Of-Change (ROC) of a Triple Smooth EMA

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_tsf
type: function
doc:
<comment>Description:</comment>
  Time Series Forecast

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_typprice
type: function
doc:
<comment>Description:</comment>
  Typical Price

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ultosc
type: function
doc:
<comment>Description:</comment>
  Ultimate Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>         Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>          Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>        Preço de fechamento, array de valores reais.
  <info>int</info>    <strong>$timePeriod1</strong>  Number of bars for 1st period. Valid range from 1 to 100000.
  <info>int</info>    <strong>$timePeriod2</strong>  Number of bars for 2nd period. Valid range from 1 to 100000.
  <info>int</info>    <strong>$timePeriod3</strong>  Number of bars for 3rd period. Valid range from 1 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_var
type: function
doc:
<comment>Description:</comment>
  Variance

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.
  <info>float</info>  <strong>$nbDev</strong>       

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_wclprice
type: function
doc:
<comment>Description:</comment>
  Weighted Close Price

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>   Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>    Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>  Preço de fechamento, array de valores reais.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_willr
type: function
doc:
<comment>Description:</comment>
  Williams' %R

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>        Preço alto, array de valores reais.
  <info>array</info>  <strong>$low</strong>         Preço baixo, array de valores reais.
  <info>array</info>  <strong>$close</strong>       Preço de fechamento, array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_wma
type: function
doc:
<comment>Description:</comment>
  Weighted Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>        Array de valores reais.
  <info>int</info>    <strong>$timePeriod</strong>  Número de período. Intervalo válido de 2 a 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trait_exists
type: function
doc:
<comment>Description:</comment>
  Verifica se a trait existe

<comment>Param:</comment>
  <info>string</info>  <strong>$trait</strong>     Nome da trait para verificação
  <info>bool</info>    <strong>$autoload</strong>  Se deve-se carregar automaticamente a trait caso não tenha sido caregada.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se a Trait existir, <info>false</info> caso não exista.


id: trigger_error
type: function
doc:
<comment>Description:</comment>
  Gera uma mensagem a nível de usuário de erro/alerta/nota
  
  Usado para disparar uma condição de erro, pode ser usado em conjunto com o gerenciador de erro
  interno, ou com uma função definida pelo usuário que tenha sido definida como novo gerenciador de
  erro (<strong>set_error_handler()</strong>).
  
  Esta função é útil quando for necessário gerar uma resposta em particular a uma exceção em tempo
  de execução.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>      A mensagem de erro designada para este erro. É limitada a 1024 bytes em
                        tamanho. Quaisquer caracteres adicionais além de 1024 bytes serão truncados.
  <info>int</info>     <strong>$error_level</strong>  O tipo de erro designado para este erro. Funciona apenas com a família de
                        constantes E_USER, e o padrão é <info>E_USER_NOTICE</info>.

<comment>Return:</comment>
  <info>bool</info>  Esta função retorna <info>false</info> se for especificado um <strong>$error_level</strong> incorreto, <info>true</info> caso
        contrário.

<comment>See Also:</comment>
   * <strong>error_reporting()</strong>
   * <strong>set_error_handler()</strong>
   * <strong>restore_error_handler()</strong>
   * As constantes de nível de erro


id: trim
type: function
doc:
<comment>Description:</comment>
  Retira espaço (ou outros caracteres) do início e do final de uma string
  
  Esta função retorna uma string com os espaços retirados do ínicio e do final de <strong>$string</strong>. Sem o
  segundo parâmetro, <strong>trim()</strong> irá retirar estes caracteres   " " (ASCII <return>32</return> (<return>0x20</return>)), um espaço normal.
  "\t" (ASCII <return>9</return> (<return>0x09</return>)), uma tabulação.  "\n" (ASCII <return>10</return> (<return>0x0A</return>)), uma linha nova (alimentação de
  linha).  "\r" (ASCII <return>13</return> (<return>0x0D</return>)), um retono de carro.  "\0" (ASCII <return>0</return> (<return>0x00</return>)), o byte <return>NUL</return>.  "\v"
  (ASCII <return>11</return> (<return>0x0B</return>)), uma tabulação vertical.
  
  " " (ASCII <return>32</return> (<return>0x20</return>)), um espaço normal.
  
  "\t" (ASCII <return>9</return> (<return>0x09</return>)), uma tabulação.
  
  "\n" (ASCII <return>10</return> (<return>0x0A</return>)), uma linha nova (alimentação de linha).
  
  "\r" (ASCII <return>13</return> (<return>0x0D</return>)), um retono de carro.
  
  "\0" (ASCII <return>0</return> (<return>0x00</return>)), o byte <return>NUL</return>.
  
  "\v" (ASCII <return>11</return> (<return>0x0B</return>)), uma tabulação vertical.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>      A <info>string</info> que será modificada.
  <info>string</info>  <strong>$characters</strong>  Opcionalmente, os caracteres removidos pode também ser especificados usando o
                       parâmetro <strong>$characters</strong>. Simplesmente liste todos os caracteres que você quer
                       retirar. Com <return>..</return> você pode especificar um intervalo de caracteres.

<comment>Return:</comment>
  <info>string</info>  A string com caracteres removidos.

<comment>See Also:</comment>
   * <strong>ltrim()</strong>
   * <strong>rtrim()</strong>
   * <strong>str_replace()</strong>


id: uasort
type: function
doc:
<comment>Description:</comment>
  Ordena um array com uma função de comparação definida pelo usuário e mantém associações de índices
  
  Ordena o <strong>$array</strong> de forma que as chaves mantenham suas correlações com os valores aos quais estão
  associadas, usando uma função de comparação definida pelo usuário.
  
  Esta função é usada principalmente para ordenar arrays associativos onde a ordem real dos
  elementos é significativa.
  
  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.
  <info>callable</info>  <strong>$callback</strong>  A função de comparação deve retornar um inteiro menor que, igual ou maior que
                       zero se o primeiro argumento for considerado respectivamente menor que, igual
                       ou maior que o segundo.
                       
                       Retornar valores não inteiros da função de comparação, como <info>float</info>, resultará
                       em uma conversão interna do valor retornado da função callback para <info>int</info>.
                       Portanto, valores como <return>0.99</return> e <return>0.1</return> serão convertidos para o valor inteiro <return>0</return>, o
                       que comparará esses valores como iguais.

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

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


id: ucfirst
type: function
doc:
<comment>Description:</comment>
  Make a string's first character uppercase
  
  Returns a string with the first character of <strong>$string</strong> capitalized, if that character is an ASCII
  character in the range from <return>"a"</return> (0x61) to <return>"z"</return> (0x7a).

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

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

<comment>See Also:</comment>
   * <strong>lcfirst()</strong>
   * <strong>strtolower()</strong>
   * <strong>strtoupper()</strong>
   * <strong>ucwords()</strong>
   * <strong>mb_convert_case()</strong>


id: ucwords
type: function
doc:
<comment>Description:</comment>
  Converte para maiúsculas o primeiro caractere de cada palavra
  
  Retorna uma string com o primeiro caractere de cada palavra em <strong>$string</strong> em maiúscula, se este
  caractere for uma letra ASCII entre <return>"a"</return> (0x61) e <return>"z"</return> (0x7a).
  
  Nesta função, uma palavra é qualquer sequência de caracteres não listada no parâmetro <strong>$separators</strong>.
  Por padrão, os separadores são: espaço, tab horizontal, retorno de carro, nova linha, form feed e
  tab vertical.
  
  Para realizar uma conversão similar em strings multibyte, utilize <strong>mb_convert_case()</strong> com a opção
  <info>MB_CASE_TITLE</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>      A string de entrada.
  <info>string</info>  <strong>$separators</strong>  O parâmetro opcional <strong>$separators</strong> contém os caracteres separadores das
                       palavras.

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

<comment>See Also:</comment>
   * <strong>strtoupper()</strong>
   * <strong>strtolower()</strong>
   * <strong>ucfirst()</strong>
   * <strong>mb_convert_case()</strong>


id: uksort
type: function
doc:
<comment>Description:</comment>
  Ordena um array pelas chaves utilizando uma função de comparação definida pelo usuário.
  
  Ordena o <strong>$array</strong> pelas chaves usando uma função de comparação fornecida pelo usuário para
  determinar a ordem.
  
  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.
  <info>callable</info>  <strong>$callback</strong>  A função de comparação deve retornar um inteiro menor que, igual ou maior que
                       zero se o primeiro argumento for considerado respectivamente menor que, igual
                       ou maior que o segundo.
                       
                       Retornar valores não inteiros da função de comparação, como <info>float</info>, resultará
                       em uma conversão interna do valor retornado da função callback para <info>int</info>.
                       Portanto, valores como <return>0.99</return> e <return>0.1</return> serão convertidos para o valor inteiro <return>0</return>, o
                       que comparará esses valores como iguais.

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

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


id: umask
type: function
doc:
<comment>Description:</comment>
  Modificar a umask atual
  
  <strong>umask()</strong> modifica o umask do PHP para a <strong>$mask</strong> & 0777 e retorna o umask antigo. Quando o PHP está
  sendo usado como um módulo de servidor, o umask é restaurado ao final de cada requisição.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$mask</strong>  A nova máscara.

<comment>Return:</comment>
  <info>int</info>  Se <strong>$mask</strong> for <info>null</info>, <strong>umask()</strong> simplesmente retorna a umask atual senão a umask antiga é
       retornada.


id: uniqid
type: function
doc:
<comment>Description:</comment>
  Gera um ID único
  
  Obtém um identificador prefixado único baseado no tempo atual em microsegundos.
  
  Esta função não gera valores criptograficamente seguros e não deve ser usada para propósitos
  criptográficos ou fins que exijam que os valores retornados sejam impossíveis de adivinhar.
  
  Se aleatoriedade criptograficamente segura for necessária, a classe <class>Random\Randomizer</class> pode ser
  usada com o mecanismo <class>Random\Engine\Secure</class>. Para casos de uso simples, as funções <strong>random_int()</strong> e
  <strong>random_bytes()</strong> fornecem uma API conveniente e segura que é garantida pelo CSPRNG do sistema
  operacional.
  
  Esta função não garante a repetição do valor retornado. Isso ocorre porque muitos sistemas ajustam
  seus relógios utilizando o NTP ou similares de forma que o horário do sistema é alterado
  constantemente. Portanto é possível que esta função não retorna um ID único mesmo no nível do
  processo ou thread. Utilize Use <strong>$more_entropy</strong> para aumentar as chances de não repetição.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>        Útil para gerar identificadores simultaneamente em vários servidores, que
                         poderiam gerar o mesmo identificador no mesmo microsegundo.
                         
                         Com um <strong>$prefix</strong> vazio, a string retornada terá 13 caracteres. Se
                         <strong>$more_entropy</strong> for <info>true</info>, a string terá 23 caracteres.
  <info>bool</info>    <strong>$more_entropy</strong>  Se informado como <info>true</info>, <strong>uniqid()</strong> irá adicionar entropia (utilizando um
                         gerador linear congruente) ao final do do valor retornado, o que aumentará
                         as chances que o resultado seja globalmente único.

<comment>Return:</comment>
  <info>string</info>  Retorna um identificador único baseado no timestamp, como uma string.
          
          Esta função tenta criar um identificador único, mas não garante a unicidade global em 100%
          dos casos.

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


id: unixtojd
type: function
doc:
<comment>Description:</comment>
  Convert Unix timestamp to Julian Day
  
  Return the Julian Day for a Unix <strong>$timestamp</strong> (seconds since 1.1.1970), or for the current day if no
  <strong>$timestamp</strong> is given. Either way, the time is regarded as local time (not UTC).

<comment>Param:</comment>
  <info>int|null</info>  <strong>$timestamp</strong>  A unix timestamp to convert.

<comment>Return:</comment>
  <info>int|false</info>  A julian day number as integer,  ou <info>false</info> em caso de falha.

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


id: unlink
type: function
doc:
<comment>Description:</comment>
  Apaga um arquivo
  
  Apaga o arquivo <strong>$filename</strong>. Similar a função do C no Unix unlink(). Emite um erro <info>E_WARNING</info> level
  no caso de falha.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>  Caminho para o arquivo.
                            
                            Se o arquivo for uma ligação simbólica, a ligação será apagada. No
                            Windows, para apagar uma ligação para um diretório, deve ser utilizada a
                            função <strong>rmdir()</strong>.
  <info>resource|null</info>  <strong>$context</strong>   Um <info>resource</info> de
                            contexto de stream.

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

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


id: unpack
type: function
doc:
<comment>Description:</comment>
  Desempacota dados de uma string binária
  
  Desempacota uma srting binária em um array de acordo com o formato especificado em <strong>$format</strong>.
  
  Os dados desempacotados são armazenados em um array associativo. Para que isto seja feito, os
  diferentes códigos de formato devem ser nomeados e separados por uma barra /. Se um argumento
  repetidor estiver presente, cada chave do array terá um número de sequência atrás do nome
  fornecido.
  
  Form feitas alterações para que esta função ficasse alinhada com a linguagem Perl:  O código "a"
  agora retém os bytes NULL ao final da string.  O código "A" agora remove todos os tipos de espaço
  ASCII do final da string (espaços, tabulações, novas linhas, retorno de carro e bytes NULL).  O
  código "Z" foi adicionado para strings com bytes NULL à esquerda, e remove bytes NULL à direita.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  Consulte a página da função <strong>pack()</strong> para uma explicação sobre os códigos de
                   formatos.
  <info>string</info>  <strong>$string</strong>  Os dados empacotados.
  <info>int</info>     <strong>$offset</strong>  O deslocamento na string a partir de onde os dados serão desempacotados.

<comment>Return:</comment>
  <info>array|false</info>  Retorna um array associativo contendo elementos desempacotados da string binária,  ou
               <info>false</info> em caso de falha.

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


id: unregister_tick_function
type: function
doc:
<comment>Description:</comment>
  Desregistra uma função executada a cada instante
  
  Desregistra a função nomeada por <strong>$callback</strong> de forma que não seja mais executada quando um tique
  for chamado.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  O nome da função a ser desregistrada.

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

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


id: unserialize
type: function
doc:
<comment>Description:</comment>
  Cria um valor PHP a partir de uma representação armazenada
    
  
  <strong>unserialize()</strong> toma uma única variável serializada e converte-a de volta em um valor PHP.
  
  Entradas de usuário não confiáveis não devem ser passadas a <strong>unserialize()</strong> independente dos valores
  do elemento <return>allowed_classes</return> do parâmetro <strong>$options</strong>. Desserialização pode resultar em um código
  carregado e executado devido a uma instanciação de objeto e auto-carregamento, e um usuário
  malicioso pode ser capaz de explorar isto. Use um formato padrão e seguro de troca de dados como
  JSON (via <strong>json_decode()</strong> e <strong>json_encode()</strong>) se for necessário passar dados serializados ao usuário.
  
  Se for necessário desserializar dados armazenados externamente, considere o uso de <strong>hash_hmac()</strong>
  para validação de dados. Certifique-se que os dados não foram modificados por outras pessoas.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>     A string serializada.
                    
                    Se a variável a ser desserializada for um objeto, após a reconstrução bem
                    sucedida do objeto o PHP tentará automaticamente chamar os métodos
                    __unserialize() ou __wakeup() (se existirem).
                    
                    unserialize_callback_func directive É possível definir uma função de retorno de
                    chamada, se uma classe indefinida tiver sido instanciada durante a
                    desserialização. (para evitar receber um objeto imcompleto do tipo <info>object</info>
                    "__PHP_Incomplete_Class".) Deve-se usar o php.ini, a função <strong>ini_set()</strong> ou o
                    arquivo .htaccess para definir unserialize_callback_func. Toda vez que uma
                    classe indefinida precisar ser instanciada, ela será chamada. Para desabilitar
                    este recurso basta esvaziar esta configuração.
                    
                    É possível definir uma função de retorno de chamada, se uma classe indefinida
                    tiver sido instanciada durante a desserialização. (para evitar receber um objeto
                    imcompleto do tipo <info>object</info> "__PHP_Incomplete_Class".) Deve-se usar o php.ini, a
                    função <strong>ini_set()</strong> ou o arquivo .htaccess para definir unserialize_callback_func.
                    Toda vez que uma classe indefinida precisar ser instanciada, ela será chamada.
                    Para desabilitar este recurso basta esvaziar esta configuração.
  <info>array</info>   <strong>$options</strong>  Quaisquer opções podem ser fornecidas a <strong>unserialize()</strong> como um array associativo.
                    
                    Pode ser um <info>array</info> de nomes de classe que devem ser aceitas, <info>false</info> para não
                    aceitar nenhuma classe, ou <info>true</info> para aceitar todas as classes. Se esta opção for
                    definida e <strong>unserialize()</strong> encontrar um objeto de uma classe que não deve ser
                    aceita, o objeto será instanciado como uma <class>__PHP_Incomplete_Class</class>.
                    
                    Omitir esta opção é o mesmo que defini-la como <info>true</info>: o PHP tentará instanciar
                    objetos de qualquer classe.
                    
                    A profundidade máxima de estruturas permitidas durante a desserialização, com a
                    intenção de prevenir sobrecarga de pilha. O limite padrão de profundidade é <return>4096</return>
                    e pode ser desabilitado definindo-se <return>max_depth</return> para <return>0</return>.

<comment>Return:</comment>
  <info>mixed</info>  O valor convertido é retornado, e pode ser <info>bool</info>, <info>int</info>, <info>float</info>, <info>string</info>, <info>array</info> ou <info>object</info>.
         
         Caso a string informada não for desserializável, <info>false</info> é retornado e um erro de nível
         <info>E_NOTICE</info> é emitido.

<comment>See Also:</comment>
   * <strong>json_encode()</strong>
   * <strong>json_decode()</strong>
   * <strong>hash_hmac()</strong>
   * <strong>serialize()</strong>
   * Auto-carregamento de Classes
   * unserialize_callback_func
   * unserialize_max_depth
   * __wakeup()
   * __serialize()
   * __unserialize()


id: unset
type: function
doc:
<comment>Description:</comment>
  Remove a definição de uma variável informada
  
  <strong>unset()</strong> destrói as variáveis especificadas.
  
  O comportamento de <strong>unset()</strong> dentro de uma função pode variar dependendo de qual tipo de variável
  está tentando-se destruir.
  
  Se uma variável global tornar-se indefinida por <strong>unset()</strong> dentro de uma função, apenas a variável
  local é destruída. A variável no ambiente que chamou a função manterá o mesmo valor anterior à
  chamada a <strong>unset()</strong>.
  ]]>
  
  O exemplo acima produzirá:
  
  
  
  Para remover a definição de uma variável global usando <strong>unset()</strong> dentro de uma função, use o array
  $GLOBALS:
  ]]>
  
  Se uma variável que é PASSADA POR REFERÊNCIA tiver sua definição removida por <strong>unset()</strong> dentro de
  uma função, apenas a variável local é destruída. A variável no ambiente que chamou a função
  manterá o mesmo valor anterior à chamada a <strong>unset()</strong>.
  ]]>
  
  O exemplo acima produzirá:
  
  
  
  Se uma variável estática tiver a definição removida por <strong>unset()</strong> dentro de uma função, <strong>unset()</strong>
  destrói a variável apenas no contexto do resto da função. Chamadas subsequentes à função irão
  restaurar o valor anterior da variável.
  ]]>
  
  O exemplo acima produzirá:
  
  

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>   A variável que terá sua definição removida.
  <info>mixed</info>  <strong>$vars</strong>  Mais variáveis que terão definições removidas.

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

<comment>See Also:</comment>
   * <strong>isset()</strong>
   * <strong>empty()</strong>
   * __unset()
   * <strong>array_splice()</strong>
   * Conversão (unset)


id: untaint
type: function
doc:
<comment>Description:</comment>
  Untaint strings
  
  Untaint strings

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

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


id: uopz_add_function
type: function
doc:
<comment>Description:</comment>
  Adds non-existent function or method
  
  Adds a non-existent function or method.

<comment>Param:</comment>
  <info>string</info>   <strong>$class</strong>     The name of the class.
  <info>string</info>   <strong>$function</strong>  The name of the function or method.
  <info>Closure</info>  <strong>$handler</strong>   The <class>Closure</class> that defines the new function or method.
  <info>int</info>      <strong>$flags</strong>     Flags to set for the new function or method.
  <info>int</info>      <strong>$all</strong>       Whether all classes that descend from <strong>$class</strong> will also be affected.

<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>uopz_del_function()</strong>
   * <strong>uopz_set_return()</strong>


id: uopz_allow_exit
type: function
doc:
<comment>Description:</comment>
  Allows control over disabled exit opcode
  
  By default uopz disables the exit opcode, so <strong>exit()</strong> calls are practically ignored.
  <strong>uopz_allow_exit()</strong> allows to control this behavior.

<comment>Param:</comment>
  <info>bool</info>  <strong>$allow</strong>  Whether to allow the execution of exit opcodes or not.

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

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


id: uopz_backup
type: function
doc:
<comment>Description:</comment>
  Backup a function
  
  Backup a function at runtime, to be restored on shutdown

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class containing the function to backup
  <info>string</info>  <strong>$function</strong>  The name of the function

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


id: uopz_compose
type: function
doc:
<comment>Description:</comment>
  Compose a class
  
  Creates a new class of the given name that implements, extends, or uses all of the provided
  classes

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>        A legal class name
  <info>array</info>   <strong>$classes</strong>     An array of class, interface and trait names
  <info>array</info>   <strong>$methods</strong>     An associative array of methods, values are either closures or [modifiers
                       =&gt; closure]
  <info>array</info>   <strong>$properties</strong>  An associative array of properties, keys are names, values are modifiers
  <info>int</info>     <strong>$flags</strong>       Entry type, by default ZEND_ACC_CLASS

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


id: uopz_copy
type: function
doc:
<comment>Description:</comment>
  Copy a function
  
  Copy a function by name

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class containing the function to copy
  <info>string</info>  <strong>$function</strong>  The name of the function

<comment>Return:</comment>
  <info>Closure</info>  A Closure for the specified function


id: uopz_del_function
type: function
doc:
<comment>Description:</comment>
  Deletes previously added function or method
  
  Deletes a previously added function or method.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class.
  <info>string</info>  <strong>$function</strong>  The name of the function or method.
  <info>int</info>     <strong>$all</strong>       Whether all classes that descend from <strong>$class</strong> will also be affected.

<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>uopz_add_function()</strong>
   * <strong>uopz_unset_return()</strong>


id: uopz_delete
type: function
doc:
<comment>Description:</comment>
  Delete a function
  
  Deletes a function or method

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

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


id: uopz_extend
type: function
doc:
<comment>Description:</comment>
  Extend a class at runtime
  
  Makes <strong>$class</strong> extend <strong>$parent</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>   The name of the class to extend
  <info>string</info>  <strong>$parent</strong>  The name of the class to inherit

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


id: uopz_flags
type: function
doc:
<comment>Description:</comment>
  Get or set flags on function or class
  
  Get or set the flags on a class or function entry at runtime

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of a class
  <info>string</info>  <strong>$function</strong>  The name of the function. If <strong>$class</strong> is given and an empty string is passed as
                     <strong>$function</strong>, <strong>uopz_flags()</strong> gets or sets the flags of the class entry.
  <info>int</info>     <strong>$flags</strong>     A valid set of ZEND_ACC_ flags. If omitted, <strong>uopz_flags()</strong> acts as getter.

<comment>Return:</comment>
  <info>int</info>  If setting, returns old flags, else returns flags


id: uopz_function
type: function
doc:
<comment>Description:</comment>
  Creates a function at runtime
  
  Creates a function at runtime

<comment>Param:</comment>
  <info>string</info>   <strong>$class</strong>      The name of the class to receive the new function
  <info>string</info>   <strong>$function</strong>   The name of the function
  <info>Closure</info>  <strong>$handler</strong>    The Closure for the function
  <info>int</info>      <strong>$modifiers</strong>  The modifiers for the function, by default copied or ZEND_ACC_PUBLIC

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


id: uopz_get_exit_status
type: function
doc:
<comment>Description:</comment>
  Retrieve the last set exit status
  
  Retrieves the last set exit status, i.e. the value passed to <strong>exit()</strong>.

<comment>Return:</comment>
  <info>mixed</info>  This function returns the last exit status, or <info>null</info> if <strong>exit()</strong> has not been called.

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


id: uopz_get_hook
type: function
doc:
<comment>Description:</comment>
  Gets previously set hook on function or method
  
  Gets the previously set hook on a function or method.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class.
  <info>string</info>  <strong>$function</strong>  The name of the function or method.

<comment>Return:</comment>
  <info>Closure</info>  Returns the previously set hook on a function or method, or <info>null</info> if no hook has been set.

<comment>See Also:</comment>
   * <strong>uopz_set_hook()</strong>
   * <strong>uopz_unset_hook()</strong>


id: uopz_get_mock
type: function
doc:
<comment>Description:</comment>
  Get the current mock for a class
  
  Returns the current mock for <strong>$class</strong>.

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

<comment>Return:</comment>
  <info>mixed</info>  Either a string containing the name of the mock, or an object, or <info>null</info> if no mock has been
         set.

<comment>See Also:</comment>
   * <strong>uopz_set_mock()</strong>
   * <strong>uopz_unset_mock()</strong>


id: uopz_get_property
type: function
doc:
<comment>Description:</comment>
  Gets value of class or instance property
  
  Gets the value of a static class property, if <strong>$class</strong> is given, or the value of an instance
  property, if <strong>$instance</strong> is given.

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

<comment>Return:</comment>
  <info>mixed</info>  Returns the value of the class or instance property, or <info>null</info> if the property is not
         defined.

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


id: uopz_get_return
type: function
doc:
<comment>Description:</comment>
  Gets a previous set return value for a function
  
  Gets the return value of the <strong>$function</strong> previously set by uopz_set_return.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class containing the function
  <info>string</info>  <strong>$function</strong>  The name of the function

<comment>Return:</comment>
  <info>mixed</info>  The return value or Closure previously set.


id: uopz_get_static
type: function
doc:
<comment>Description:</comment>
  Gets the static variables from function or method scope
  
  Gets the static variables from function or method scope.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class.
  <info>string</info>  <strong>$function</strong>  The name of the function or method.

<comment>Return:</comment>
  <info>array</info>  Returns an associative <info>array</info> of variable names mapped to their current values on success,
         or <info>null</info> if the function or method does not exist.

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


id: uopz_implement
type: function
doc:
<comment>Description:</comment>
  Implements an interface at runtime
  
  Makes <strong>$class</strong> implement <strong>$interface</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>      
  <info>string</info>  <strong>$interface</strong>  

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


id: uopz_overload
type: function
doc:
<comment>Description:</comment>
  Overload a VM opcode
  
  Overloads the specified <strong>$opcode</strong> with the user defined function

<comment>Param:</comment>
  <info>int</info>       <strong>$opcode</strong>    A valid opcode, see constants for details of supported codes
  <info>Callable</info>  <strong>$callable</strong>  

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


id: uopz_redefine
type: function
doc:
<comment>Description:</comment>
  Redefine a constant
  
  Redefines the given <strong>$constant</strong> as <strong>$value</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class containing the constant
  <info>string</info>  <strong>$constant</strong>  The name of the constant
  <info>mixed</info>   <strong>$value</strong>     The new value for the constant, must be a valid type for a constant variable

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


id: uopz_rename
type: function
doc:
<comment>Description:</comment>
  Rename a function at runtime
  
  Renames <strong>$function</strong> to <strong>$rename</strong>
  
  If both functions exist, this effectively swaps their names

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class containing the function
  <info>string</info>  <strong>$function</strong>  The name of an existing function
  <info>string</info>  <strong>$rename</strong>    The new name for the function

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


id: uopz_restore
type: function
doc:
<comment>Description:</comment>
  Restore a previously backed up function
  
  Restore a previously backed up function

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class containing the function to restore
  <info>string</info>  <strong>$function</strong>  The name of the function

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


id: uopz_set_hook
type: function
doc:
<comment>Description:</comment>
  Sets hook to execute when entering a function or method
  
  Sets a hook to execute when entering a function or method.

<comment>Param:</comment>
  <info>string</info>   <strong>$class</strong>     The name of the class.
  <info>string</info>   <strong>$function</strong>  The name of the function or method.
  <info>Closure</info>  <strong>$hook</strong>      A closure to execute when entering the function or method.

<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>uopz_get_hook()</strong>
   * <strong>uopz_unset_hook()</strong>


id: uopz_set_mock
type: function
doc:
<comment>Description:</comment>
  Use mock instead of class for new objects
  
  If <strong>$mock</strong> is a string containing the name of a class then it will be instantiated instead of
  <strong>$class</strong>. <strong>$mock</strong> can also be an object.
  
  Only dynamic access to properties and methods will use the <strong>$mock</strong> object. Static access still uses
  the original <strong>$class</strong>. See example below.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  The name of the class to be mocked.
  <info>mixed</info>   <strong>$mock</strong>   The mock to use in the form of a string containing the name of the class to use or
                  an object. If a string is passed, it has to be the fully qualified class name. It
                  is recommended to use the ::class magic constant in this case.

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

<comment>See Also:</comment>
   * <strong>uopz_get_mock()</strong>
   * <strong>uopz_unset_mock()</strong>


id: uopz_set_property
type: function
doc:
<comment>Description:</comment>
  Sets value of existing class or instance property
  
  Sets the value of an existing static class property, if <strong>$class</strong> is given, or the value of an
  instance property (regardless whether the instance property already exists), if <strong>$instance</strong> is
  given.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class.
  <info>object</info>  <strong>$instance</strong>  The object instance.
  <info>string</info>  <strong>$property</strong>  The name of the property.
  <info>mixed</info>   <strong>$value</strong>     The value to assign to the property.

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

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


id: uopz_set_return
type: function
doc:
<comment>Description:</comment>
  Provide a return value for an existing function
  
  Sets the return value of the <strong>$function</strong> to <strong>$value</strong>. If <strong>$value</strong> is a Closure and <strong>$execute</strong> is set, the
  Closure will be executed in place of the original function. It is possible to call the original
  function from the Closure.
  
  This function replaces uopz_rename.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class containing the function
  <info>string</info>  <strong>$function</strong>  The name of an existing function
  <info>mixed</info>   <strong>$value</strong>     The value the function should return. If a Closure is provided and the execute
                     flag is set, the Closure will be executed in place of the original function.
  <info>bool</info>    <strong>$execute</strong>   If true, and a Closure was provided as the value, the Closure will be executed
                     in place of the original function.

<comment>Return:</comment>
  <info>bool</info>  True if succeeded, false otherwise.


id: uopz_set_static
type: function
doc:
<comment>Description:</comment>
  Sets the static variables in function or method scope
  
  Sets the static variables in function or method scope.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class.
  <info>string</info>  <strong>$function</strong>  The name of the function or method.
  <info>array</info>   <strong>$static</strong>    The associative <info>array</info> of variable names mapped to their values.

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

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


id: uopz_undefine
type: function
doc:
<comment>Description:</comment>
  Undefine a constant
  
  Removes the constant at runtime

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class containing <strong>$constant</strong>
  <info>string</info>  <strong>$constant</strong>  The name of an existing constant

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


id: uopz_unset_hook
type: function
doc:
<comment>Description:</comment>
  Removes previously set hook on function or method
  
  Removes the previously set hook on a function or method.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class.
  <info>string</info>  <strong>$function</strong>  The name of the function or method.

<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>uopz_set_hook()</strong>
   * <strong>uopz_get_hook()</strong>


id: uopz_unset_mock
type: function
doc:
<comment>Description:</comment>
  Unset previously set mock
  
  Unsets the previously set mock for <strong>$class</strong>.

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

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

<comment>See Also:</comment>
   * <strong>uopz_set_mock()</strong>
   * <strong>uopz_get_mock()</strong>


id: uopz_unset_return
type: function
doc:
<comment>Description:</comment>
  Unsets a previously set return value for a function
  
  Unsets the return value of the <strong>$function</strong> previously set by uopz_set_return.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>     The name of the class containing the function
  <info>string</info>  <strong>$function</strong>  The name of the function

<comment>Return:</comment>
  <info>bool</info>  True on success


id: urldecode
type: function
doc:
<comment>Description:</comment>
  Decodifica uma URL codificada
  
  Decodifica qualquer <return>%##</return> codificado na string. Os símbolos 'mais' ('<return>+</return>') são decodificados para um
  caractere de espaço.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string a ser decodificada.

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

<comment>See Also:</comment>
   * <strong>urlencode()</strong>
   * <strong>rawurlencode()</strong>
   * <strong>rawurldecode()</strong>
   * RFC 3986


id: urlencode
type: function
doc:
<comment>Description:</comment>
  URL-encodes string
  
  This function is convenient when encoding a string to be used in a query part of a URL, as a
  convenient way to pass variables to the next page.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The string to be encoded.

<comment>Return:</comment>
  <info>string</info>  Returns a string in which all non-alphanumeric characters except <return>-_.</return> have been replaced
          with a percent (<return>%</return>) sign followed by two hex digits and spaces encoded as plus (<return>+</return>) signs.
          It is encoded the same way that the posted data from a WWW form is encoded, that is the
          same way as in <return>application/x-www-form-urlencoded</return> media type. This differs from the RFC
          3986 encoding (see <strong>rawurlencode()</strong>) in that for historical reasons, spaces are encoded as
          plus (+) signs.

<comment>See Also:</comment>
   * <strong>urldecode()</strong>
   * <strong>htmlentities()</strong>
   * <strong>rawurlencode()</strong>
   * <strong>rawurldecode()</strong>
   * RFC 3986


id: use_soap_error_handler
type: function
doc:
<comment>Description:</comment>
  Set whether to use the SOAP error handler
  
  This function sets whether or not to use the SOAP error handler in the SOAP server.  It will
  return the previous value. If set to <info>true</info>, details of errors in a <class>SoapServer</class> application will be
  sent to the client as a SOAP fault message. If <info>false</info>, the standard PHP error handler is used. The
  default is to send error to the client as SOAP fault message.

<comment>Param:</comment>
  <info>bool</info>  <strong>$enable</strong>  Set to <info>true</info> to send error details to clients.

<comment>Return:</comment>
  <info>bool</info>  Returns the original value.

<comment>See Also:</comment>
   * <strong>set_error_handler()</strong>
   * <strong>set_exception_handler()</strong>


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


id: usleep
type: function
doc:
<comment>Description:</comment>
  Atrasa a execução em microssegundos
  
  Atrasa a execução do programa pelo número especificado de microssegundos.

<comment>Param:</comment>
  <info>int</info>  <strong>$microseconds</strong>  Tempo de parada em microssegundos. Um microssegundo é um milionésimo de
                      segundo.
                      
                      Valores maiores que <return>1000000</return> (isto é, pausar por mais que um segundo) pode não
                      ser suportado pelo sistema operacional. Use a função <strong>sleep()</strong> neste caso.
                      
                      A pausa pode ser aumentada um pouco (isto é, ficar mais longa que o parâmetro
                      <strong>$microseconds</strong>) por qualquer atividade do sistema, por tempo gasto no
                      processamento da chamada ou pela granularidade dos cronômetros do sistema.

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

<comment>See Also:</comment>
   * <strong>sleep()</strong>
   * <strong>time_nanosleep()</strong>
   * <strong>time_sleep_until()</strong>
   * <strong>set_time_limit()</strong>


id: usort
type: function
doc:
<comment>Description:</comment>
  Ordena um array pelos valores utilizando uma função de comparação definida pelo usuário
  
  Ordenar o <strong>$array</strong> pelos valores usando uma função de comparação definida pelo usuário para
  determinar a ordem.
  
  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.
  
  Esta função
  atribui novas chaves aos elementos do <strong>$array</strong>.
  Ela removerá todas as chaves existentes que possam ter sido atribuídas, em vez
  de apenas reordenar as chaves.

<comment>Param:</comment>
  <info>array</info>     <strong>$array</strong>     The input array.
  <info>callable</info>  <strong>$callback</strong>  A função de comparação deve retornar um inteiro menor que, igual ou maior que
                       zero se o primeiro argumento for considerado respectivamente menor que, igual
                       ou maior que o segundo.
                       
                       Retornar valores não inteiros da função de comparação, como <info>float</info>, resultará
                       em uma conversão interna do valor retornado da função callback para <info>int</info>.
                       Portanto, valores como <return>0.99</return> e <return>0.1</return> serão convertidos para o valor inteiro <return>0</return>, o
                       que comparará esses valores como iguais.

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

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


id: utf8_decode
type: function
doc:
<comment>Description:</comment>
  Converts a string from UTF-8 to ISO-8859-1, replacing invalid or unrepresentable
     characters
    
  
  This function converts the string <strong>$string</strong> from the <return>UTF-8</return> encoding to <return>ISO-8859-1</return>. Bytes in the
  string which are not valid <return>UTF-8</return>, and <return>UTF-8</return> characters which do not exist in <return>ISO-8859-1</return> (that is,
  code points above <return>U+00FF</return>) are replaced with <return>?</return>.
  
  Many web pages marked as using the <return>ISO-8859-1</return> character encoding actually use the similar
  <return>Windows-1252</return> encoding, and web browsers will interpret <return>ISO-8859-1</return> web pages as <return>Windows-1252</return>.
  <return>Windows-1252</return> features additional printable characters, such as the Euro sign (<return>€</return>) and curly quotes
  (<return>“</return> <return>”</return>), instead of certain <return>ISO-8859-1</return> control characters. This function will not convert such
  <return>Windows-1252</return> characters correctly. Use a different function if <return>Windows-1252</return> conversion is
  required.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A UTF-8 encoded string.

<comment>Return:</comment>
  <info>string</info>  Returns the ISO-8859-1 translation of <strong>$string</strong>.

<comment>See Also:</comment>
   * <strong>utf8_encode()</strong>
   * <strong>mb_convert_encoding()</strong>
   * UConverter::transcode
   * <strong>iconv()</strong>


id: utf8_encode
type: function
doc:
<comment>Description:</comment>
  Converts a string from ISO-8859-1 to UTF-8
  
  This function converts the string <strong>$string</strong> from the <return>ISO-8859-1</return> encoding to <return>UTF-8</return>.
  
  This function does not attempt to guess the current encoding of the provided string, it assumes it
  is encoded as ISO-8859-1 (also known as "Latin 1") and converts to UTF-8. Since every sequence of
  bytes is a valid ISO-8859-1 string, this never results in an error, but will not result in a
  useful string if a different encoding was intended.
  
  Many web pages marked as using the <return>ISO-8859-1</return> character encoding actually use the similar
  <return>Windows-1252</return> encoding, and web browsers will interpret <return>ISO-8859-1</return> web pages as <return>Windows-1252</return>.
  <return>Windows-1252</return> features additional printable characters, such as the Euro sign (<return>€</return>) and curly quotes
  (<return>“</return> <return>”</return>), instead of certain <return>ISO-8859-1</return> control characters. This function will not convert such
  <return>Windows-1252</return> characters correctly. Use a different function if <return>Windows-1252</return> conversion is
  required.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  An ISO-8859-1 string.

<comment>Return:</comment>
  <info>string</info>  Returns the UTF-8 translation of <strong>$string</strong>.

<comment>See Also:</comment>
   * <strong>utf8_decode()</strong>
   * <strong>mb_convert_encoding()</strong>
   * UConverter::transcode
   * <strong>iconv()</strong>


id: var_dump
type: function
doc:
<comment>Description:</comment>
  Despeja na saída informações sobre uma variável
  
  Esta função mostra na saída uma informação estruturada sobre uma ou mais expressões, incluindo o
  tipo e o valor. Arrays e objetos são explorados recursivamente com valores identados para mostrar
  a estrutura.
  
  Todas as propriedades públicas, privadas e protegidas de objetos serão retornadas na saída a menos
  que o objeto implemente um método __debugInfo().
  
  Assim como qualquer coisa que envia
  seu resultado diretamente para o navegador, as funções de controle de saída podem ser usadas para
  capturar
  a saída desta função e salvá-la em uma
  <info>string</info>, por exemplo.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>   A expressão a ser despejada.
  <info>mixed</info>  <strong>$values</strong>  Mais expressões a despejar.

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

<comment>See Also:</comment>
   * <strong>print_r()</strong>
   * <strong>debug_zval_dump()</strong>
   * <strong>var_export()</strong>
   * __debugInfo()


id: var_export
type: function
doc:
<comment>Description:</comment>
  Mostra ou retorna uma representação string analisável de uma variável
  
  <strong>var_export()</strong> obtém informação estruturada sobre a variável informada. Ela é similar a <strong>var_dump()</strong>
  com uma exceção: a representação retornada é um código PHP válido.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>   A variável a ser exportada.
  <info>bool</info>   <strong>$return</strong>  Se usado e definido para <info>true</info>, <strong>var_export()</strong> irá retornar a representação da
                  variável ao invés de exibí-la.

<comment>Return:</comment>
  <info>string|null</info>  Retorna a representação da variável quando o parâmetro <strong>$return</strong> é usado e avaliado
               para <info>true</info>. Caso contrário, esta função retornará <info>null</info>.

<comment>See Also:</comment>
   * <strong>print_r()</strong>
   * <strong>serialize()</strong>
   * <strong>var_dump()</strong>


id: var_representation
type: function
doc:
<comment>Description:</comment>
  Returns a short, readable, parsable string representation of a variable
  
  <strong>var_representation()</strong> (from the var_representation PECL) returns a string with structured
  information about the  given variable. It is similar to <strong>var_export()</strong> with differences in
  indentation, string escaping, and array representations.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The variable to generate a representation of.
  <info>int</info>    <strong>$flags</strong>  Bitmask consisting of <info>VAR_REPRESENTATION_SINGLE_LINE</info>,
                 <info>VAR_REPRESENTATION_UNESCAPED</info>. The behaviour of these constants is described on the
                 var_representation constants page.

<comment>Return:</comment>
  <info>string</info>  Returns the variable representation.

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


id: variant
type: class
doc:
<comment>Description:</comment>
  The VARIANT is COM's equivalent of the PHP zval; it is a structure that can contain a value with a
  range of different possible types.  The variant class provided by the COM extension allows you to
  have more control over the way that PHP passes values to and from COM.


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

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>     Initial value. If omitted, or set to <info>null</info> an VT_EMPTY object is created.
  <info>int</info>    <strong>$type</strong>      Specifies the content type of the variant object. Possible values are one of the
                    <info>VT_XXX</info> .
                    
                    PHP can detect parameters passed by reference automatically; they do not even
                    need to be passed as variant objects.
                    
                    Consult the MSDN library for additional information on the VARIANT type.
  <info>int</info>    <strong>$codepage</strong>  Specifies the codepage that is used to convert strings to unicode.  See the
                    parameter of the same name in the  class for more information.


id: variant_abs
type: function
doc:
<comment>Description:</comment>
  Returns the absolute value of a variant
  
  Returns the absolute value of a variant.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The variant.

<comment>Return:</comment>
  <info>variant</info>  Returns the absolute value of <strong>$value</strong>.

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


id: variant_add
type: function
doc:
<comment>Description:</comment>
  "Adds" two variant values together and returns the result
  
  Adds <strong>$left</strong> to <strong>$right</strong> using the following rules (taken from the MSDN library), which correspond to
  those of Visual Basic: Variant Addition RulesIfThenBoth expressions are of the string
  typeConcatenationOne expression is a string type and the other a characterAdditionOne expression
  is numeric and the other is a stringAdditionBoth expressions are numericAdditionEither expression
  is NULLNULL is returnedBoth expressions are emptyInteger subtype is returned

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Returns the result.

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


id: variant_and
type: function
doc:
<comment>Description:</comment>
  Performs a bitwise AND operation between two variants
  
  Performs a bitwise AND operation. Note that this is slightly different from a regular AND
  operation.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant AND RulesIf <strong>$left</strong> isIf <strong>$right</strong> isthen the result
           is<info>true</info><info>true</info><info>true</info><info>true</info><info>false</info><info>false</info><info>true</info><info>null</info><info>null</info><info>false</info><info>true</info><info>false</info><info>false</info><info>false</info><info>false</info><info>false</info><info>null</info><info>false</info><info>null</info><info>true</info><info>null</info><info>null</info><info>false</info><info>false</info><info>null</info><info>null</info><info>null</info>

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


id: variant_cast
type: function
doc:
<comment>Description:</comment>
  Convert a variant into a new variant object of another type
  
  This function makes a copy of <strong>$variant</strong> and then performs a variant cast operation to force the
  copy to have the type given by <strong>$type</strong>.
  
  This function wraps VariantChangeType() in the COM library; consult MSDN for more information.

<comment>Param:</comment>
  <info>variant</info>  <strong>$variant</strong>  The variant.
  <info>int</info>      <strong>$type</strong>     <strong>$type</strong> should be one of the <info>VT_XXX</info> constants.

<comment>Return:</comment>
  <info>variant</info>  Returns a variant of given <strong>$type</strong>.

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


id: variant_cat
type: function
doc:
<comment>Description:</comment>
  Concatenates two variant values together and returns the result
  
  Concatenates <strong>$left</strong> with <strong>$right</strong> and returns the result.
  
  This function is notionally equivalent to <strong>$left</strong> <return>.</return> <strong>$right</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Returns the result of the concatenation.

<comment>See Also:</comment>
   *  for the string
   concatenation operator


id: variant_cmp
type: function
doc:
<comment>Description:</comment>
  Compares two variants
  
  Compares <strong>$left</strong> with <strong>$right</strong>.
  
  This function will only compare scalar values, not arrays or variant records.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>       The left operand.
  <info>mixed</info>  <strong>$right</strong>      The right operand.
  <info>int</info>    <strong>$locale_id</strong>  A valid Locale Identifier to use when comparing strings (this affects string
                     collation).
  <info>int</info>    <strong>$flags</strong>      <strong>$flags</strong> can be one or more of the following values OR'd together, and affects
                     string comparisons: Variant Comparision Flagsvaluemeaning<info>NORM_IGNORECASE</info>Compare
                     case insensitively<info>NORM_IGNORENONSPACE</info>Ignore nonspacing
                     characters<info>NORM_IGNORESYMBOLS</info>Ignore symbols<info>NORM_IGNOREWIDTH</info>Ignore string
                     width<info>NORM_IGNOREKANATYPE</info>Ignore Kana type<info>NORM_IGNOREKASHIDA</info>Ignore Arabic kashida
                     characters

<comment>Return:</comment>
  <info>int</info>  Returns one of the following: Variant Comparision Resultsvaluemeaning<info>VARCMP_LT</info><strong>$left</strong> is less
       than <strong>$right</strong> <info>VARCMP_EQ</info><strong>$left</strong> is equal to <strong>$right</strong> <info>VARCMP_GT</info><strong>$left</strong> is greater than <strong>$right</strong>
       <info>VARCMP_NULL</info>Either <strong>$left</strong>, <strong>$right</strong> or both are <info>null</info>


id: variant_date_from_timestamp
type: function
doc:
<comment>Description:</comment>
  Returns a variant date representation of a Unix timestamp
  
  Converts <strong>$timestamp</strong> from a unix timestamp value into a variant of type <info>VT_DATE</info>.  This allows
  easier interopability between the unix-ish parts of PHP and COM.

<comment>Param:</comment>
  <info>int</info>  <strong>$timestamp</strong>  A unix timestamp.

<comment>Return:</comment>
  <info>variant</info>  Returns a <info>VT_DATE</info> variant.

<comment>See Also:</comment>
   * <strong>variant_date_to_timestamp()</strong>
   * <strong>mktime()</strong>
   * <strong>time()</strong>


id: variant_date_to_timestamp
type: function
doc:
<comment>Description:</comment>
  Converts a variant date/time value to Unix timestamp
  
  Converts <strong>$variant</strong> from a <info>VT_DATE</info> (or similar) value into a Unix timestamp.  This allows easier
  interopability between the Unix-ish parts of PHP and COM.

<comment>Param:</comment>
  <info>variant</info>  <strong>$variant</strong>  The variant.

<comment>Return:</comment>
  <info>int|null</info>  Returns a unix timestamp, or <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>variant_date_from_timestamp()</strong>
   * <strong>date()</strong>
   * <strong>strftime()</strong>


id: variant_div
type: function
doc:
<comment>Description:</comment>
  Returns the result from dividing two variants
  
  Divides <strong>$left</strong> by <strong>$right</strong> and returns the result.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant Division RulesIfThenBoth expressions are of the string, date, character, boolean
           typeDouble is returnedOne expression is a string type and the other a characterDivision
           and a double is returnedOne expression is numeric and the other is a stringDivision and a
           double is returned.Both expressions are numericDivision and a double is returnedEither
           expression is NULLNULL is returned<strong>$right</strong> is empty and <strong>$left</strong> is anything but emptyA
           <class>com_exception</class> with code <info>DISP_E_DIVBYZERO</info> is thrown<strong>$left</strong> is empty and <strong>$right</strong> is anything
           but empty.0 as type double is returnedBoth expressions are emptyA <class>com_exception</class> with code
           <info>DISP_E_OVERFLOW</info> is thrown

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


id: variant_eqv
type: function
doc:
<comment>Description:</comment>
  Performs a bitwise equivalence on two variants
  
  Performs a bitwise equivalence on two variants.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  If each bit in <strong>$left</strong> is equal to the corresponding bit in <strong>$right</strong> then <info>true</info> is returned,
           otherwise <info>false</info> is returned.


id: variant_fix
type: function
doc:
<comment>Description:</comment>
  Returns the integer portion of a variant
  
  Gets the integer portion of a variant.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The variant.

<comment>Return:</comment>
  <info>variant</info>  If <strong>$value</strong> is negative, then the first negative integer greater than or equal to the
           variant is returned, otherwise returns the integer portion of the value of <strong>$value</strong>.

<comment>See Also:</comment>
   * <strong>variant_int()</strong>
   * <strong>variant_round()</strong>
   * <strong>floor()</strong>
   * <strong>ceil()</strong>
   * <strong>round()</strong>


id: variant_get_type
type: function
doc:
<comment>Description:</comment>
  Returns the type of a variant object
  
  Returns the type of a variant object.

<comment>Param:</comment>
  <info>variant</info>  <strong>$variant</strong>  The variant object.

<comment>Return:</comment>
  <info>int</info>  This function returns an integer value that indicates the type of <strong>$variant</strong>, which can be an
       instance of ,  or  classes.  The return value can be compared to one of the <info>VT_XXX</info> constants.
       
       The return value for COM and DOTNET objects will usually be <info>VT_DISPATCH</info>; the only reason this
       function works for those classes is because COM and DOTNET are descendants of VARIANT.

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


id: variant_idiv
type: function
doc:
<comment>Description:</comment>
  Converts variants to integers and then returns the result from dividing them
  
  Converts <strong>$left</strong> and <strong>$right</strong> to integer values, and then performs integer division.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant Integer Division RulesIfThenBoth expressions are of the string, date, character,
           boolean typeDivision and integer is returnedOne expression is a string type and the other
           a characterDivisionOne expression is numeric and the other is a stringDivisionBoth
           expressions are numericDivisionEither expression is NULLNULL is returnedBoth expressions
           are emptyA <class>com_exception</class> with code <info>DISP_E_DIVBYZERO</info> is thrown

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


id: variant_imp
type: function
doc:
<comment>Description:</comment>
  Performs a bitwise implication on two variants
  
  Performs a bitwise implication operation.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant Implication TableIf <strong>$left</strong> isIf <strong>$right</strong> isthen the result
           is<info>true</info><info>true</info><info>true</info><info>true</info><info>false</info><info>false</info><info>true</info><info>null</info><info>true</info><info>false</info><info>true</info><info>true</info><info>false</info><info>false</info><info>true</info><info>false</info><info>null</info><info>true</info><info>null</info><info>true</info><info>true</info><info>null</info><info>false</info><info>null</info><info>null</info><info>null</info><info>null</info>


id: variant_int
type: function
doc:
<comment>Description:</comment>
  Returns the integer portion of a variant
  
  Gets the integer portion of a variant.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The variant.

<comment>Return:</comment>
  <info>variant</info>  If <strong>$value</strong> is negative, then the first negative integer greater than or equal to the
           variant is returned, otherwise returns the integer portion of the value of <strong>$value</strong>.

<comment>See Also:</comment>
   * <strong>variant_fix()</strong>
   * <strong>variant_round()</strong>
   * <strong>floor()</strong>
   * <strong>ceil()</strong>
   * <strong>round()</strong>


id: variant_mod
type: function
doc:
<comment>Description:</comment>
  Divides two variants and returns only the remainder
  
  Divides <strong>$left</strong> by <strong>$right</strong> and returns the remainder.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Returns the remainder of the division.

<comment>See Also:</comment>
   * <strong>variant_div()</strong>
   * <strong>variant_idiv()</strong>


id: variant_mul
type: function
doc:
<comment>Description:</comment>
  Multiplies the values of the two variants
  
  Multiplies <strong>$left</strong> by <strong>$right</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant Multiplication RulesIfThenBoth expressions are of the string, date, character,
           boolean typeMultiplicationOne expression is a string type and the other a
           characterMultiplicationOne expression is numeric and the other is a
           stringMultiplicationBoth expressions are numericMultiplicationEither expression is
           NULLNULL is returnedBoth expressions are emptyEmpty string is returned

<comment>See Also:</comment>
   * <strong>variant_div()</strong>
   * <strong>variant_idiv()</strong>


id: variant_neg
type: function
doc:
<comment>Description:</comment>
  Performs logical negation on a variant
  
  Performs logical negation of <strong>$value</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The variant.

<comment>Return:</comment>
  <info>variant</info>  Returns the result of the logical negation.


id: variant_not
type: function
doc:
<comment>Description:</comment>
  Performs bitwise not negation on a variant
  
  Performs bitwise not negation on <strong>$value</strong> and returns the result.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The variant.

<comment>Return:</comment>
  <info>variant</info>  Returns the bitwise not negation. If <strong>$value</strong> is <info>null</info>, the result will also be <info>null</info>.


id: variant_or
type: function
doc:
<comment>Description:</comment>
  Performs a logical disjunction on two variants
  
  Performs a bitwise OR operation. Note that this is slightly different from a regular OR operation.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant OR RulesIf <strong>$left</strong> isIf <strong>$right</strong> isthen the result
           is<info>true</info><info>true</info><info>true</info><info>true</info><info>false</info><info>true</info><info>true</info><info>null</info><info>true</info><info>false</info><info>true</info><info>true</info><info>false</info><info>false</info><info>false</info><info>false</info><info>null</info><info>null</info><info>null</info><info>true</info><info>true</info><info>null</info><info>false</info><info>null</info><info>null</info><info>null</info><info>null</info>

<comment>See Also:</comment>
   * <strong>variant_and()</strong>
   * <strong>variant_xor()</strong>


id: variant_pow
type: function
doc:
<comment>Description:</comment>
  Returns the result of performing the power function with two variants
  
  Returns the result of <strong>$left</strong> to the power of <strong>$right</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Returns the result of <strong>$left</strong> to the power of <strong>$right</strong>.

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


id: variant_round
type: function
doc:
<comment>Description:</comment>
  Rounds a variant to the specified number of decimal places
  
  Returns the value of <strong>$value</strong> rounded to <strong>$decimals</strong> decimal places.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>     The variant.
  <info>int</info>    <strong>$decimals</strong>  Number of decimal places.

<comment>Return:</comment>
  <info>variant|null</info>  Returns the rounded value, or <info>null</info> on failure.

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


id: variant_set
type: function
doc:
<comment>Description:</comment>
  Assigns a new value for a variant object
  
  Converts <strong>$value</strong> to a variant and assigns it to the <strong>$variant</strong> object; no new variant object is
  created, and the old value of <strong>$variant</strong> is freed/released.

<comment>Param:</comment>
  <info>variant</info>  <strong>$variant</strong>  The variant.
  <info>mixed</info>    <strong>$value</strong>    

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


id: variant_set_type
type: function
doc:
<comment>Description:</comment>
  Convert a variant into another type "in-place"
  
  This function is similar to <strong>variant_cast()</strong> except that the variant is modified "in-place"; no new
  variant is created. The parameters for this function have identical meaning to those of
  <strong>variant_cast()</strong>.

<comment>Param:</comment>
  <info>variant</info>  <strong>$variant</strong>  The variant.
  <info>int</info>      <strong>$type</strong>     

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

<comment>See Also:</comment>
   * <strong>variant_cast()</strong>
   * <strong>variant_get_type()</strong>


id: variant_sub
type: function
doc:
<comment>Description:</comment>
  Subtracts the value of the right variant from the left variant value
  
  Subtracts <strong>$right</strong> from <strong>$left</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant Subtraction RulesIfThenBoth expressions are of the string typeSubtractionOne
           expression is a string type and the other a characterSubtractionOne expression is numeric
           and the other is a stringSubtraction.Both expressions are numericSubtractionEither
           expression is NULLNULL is returnedBoth expressions are emptyEmpty string is returned

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


id: variant_xor
type: function
doc:
<comment>Description:</comment>
  Performs a logical exclusion on two variants
  
  Performs a logical exclusion.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left</strong>   The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant XOR RulesIf <strong>$left</strong> isIf <strong>$right</strong> isthen the result
           is<info>true</info><info>true</info><info>false</info><info>true</info><info>false</info><info>true</info><info>false</info><info>true</info><info>true</info><info>false</info><info>false</info><info>false</info><info>null</info><info>null</info><info>null</info>

<comment>See Also:</comment>
   * <strong>variant_or()</strong>
   * <strong>variant_and()</strong>


id: version_compare
type: function
doc:
<comment>Description:</comment>
  Compares two "PHP-standardized" version number strings
  
  <strong>version_compare()</strong> compares two "PHP-standardized" version number strings.
  
  The function first replaces <return>_</return>, <return>-</return> and <return>+</return> with a dot <return>.</return> in the version strings and also inserts dots <return>.</return>
  before and after any non number so that for example '4.3.2RC1' becomes '4.3.2.RC.1'. Then it
  compares the parts starting from left to right. If a part contains special version strings these
  are handled in the following order: <return>any string not found in this list</return> \<  <return>dev</return> \< <return>alpha</return> = <return>a</return> \< <return>beta</return>
  = <return>b</return> \< <return>RC</return> =   <return>rc</return> \< <return>#</return> \< <return>pl</return> = <return>p</return>. This way not only versions with different levels like '4.1' and
  '4.1.2' can be compared but also any PHP specific version containing development state.

<comment>Param:</comment>
  <info>string</info>       <strong>$version1</strong>  First version number.
  <info>string</info>       <strong>$version2</strong>  Second version number.
  <info>string|null</info>  <strong>$operator</strong>  An optional operator. The possible operators are: <return>\<</return>, <return>lt</return>, <return>\<=</return>, <return>le</return>, <return>&gt;</return>, <return>gt</return>, <return>&gt;=</return>, <return>ge</return>, <return>==</return>, <return>=</return>, <return>eq</return>, <return>!=</return>, <return>\<&gt;</return>, <return>ne</return> respectively.
                          
                          This parameter is case-sensitive, values should be lowercase.

<comment>Return:</comment>
  <info>int|bool</info>  By default, <strong>version_compare()</strong> returns <return>-1</return> if the first version is lower than the second,
            <return>0</return> if they are equal, and <return>1</return> if the second is lower.
            
            When using the optional <strong>$operator</strong> argument, the function will return <info>true</info> if the
            relationship is the one specified by the operator, <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>phpversion()</strong>
   * <strong>php_uname()</strong>
   * <strong>function_exists()</strong>


id: vfprintf
type: function
doc:
<comment>Description:</comment>
  Escreve uma string formatada para um fluxo
  
  Escreve uma string produzida de acordo com <strong>$format</strong> para o recurso do fluxo especificado por
  <strong>$stream</strong>.
  
  Funciona como <strong>fprintf()</strong> mas aceita um array de argumentos, ao invés de um número váriavel de
  argumentos.

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

<comment>Return:</comment>
  <info>int</info>  Retorna o tamanho da string mostrada.

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


id: virtual
type: function
doc:
<comment>Description:</comment>
  Realiza uma sub-requisição Apache
  
  <strong>virtual()</strong> é uma função específica do Apache equivalente a <return>\<!--#include virtual...--&gt;</return> no <return>mod_include</return>. Realiza uma sub-requisição do Apache. Util na inclusão de scripts CGI ou arquivos .shtml, ou qualquer outra coisa que você possa interpretar no Apache. Note que para um script CGI, o script precisa gerar um cabeçalho CGI válido. Isto significa que, no mínimo, ele precisa gerar um header <return>Content-Type</return>.
  
  Para executar a sub-requisição, todos os buffers são finalizados e enviados para o browser.
  Cabeçalhos pendentes também serão enviados.
  
  Esta função é suportada quando o PHP
  é instalado como um módulo do servidor web Apache.

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>  A URL no qual o comando virtual será realizado.

<comment>Return:</comment>
  <info>bool</info>  Realizada o comando virtual em sucesso, retorna <info>false</info> em erros.

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


id: vprintf
type: function
doc:
<comment>Description:</comment>
  Output a formatted string
  
  Display array values as a formatted string according to <strong>$format</strong> (which is described in the
  documentation for <strong>sprintf()</strong>).
  
  Operates as <strong>printf()</strong> but accepts an array of arguments, rather than a variable number of
  arguments.

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

<comment>Return:</comment>
  <info>int</info>  Returns the length of the outputted string.

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


id: vsprintf
type: function
doc:
<comment>Description:</comment>
  Return a formatted string
  
  Operates as <strong>sprintf()</strong> but accepts an array of arguments, rather than a variable number of
  arguments.

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

<comment>Return:</comment>
  <info>string</info>  Return array values as a formatted string according to <strong>$format</strong>.

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


id: wddx_add_vars
type: function
doc:
<comment>Description:</comment>
  Add variables to a WDDX packet with the specified ID
  
  Serializes the passed variables and add the result to the given packet.

<comment>Param:</comment>
  <info>resource</info>  <strong>$packet_id</strong>  A WDDX packet, returned by <strong>wddx_packet_start()</strong>.
  <info>mixed</info>     <strong>$var_name</strong>   Can be either a string naming a variable or an array containing strings
                        naming the variables or another array, etc.
  <info>mixed</info>     <strong>$var_names</strong>  

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


id: wddx_deserialize
type: function
doc:
<comment>Description:</comment>
  Desserializa um pacote WDDX
  
  Desserializa um <strong>$packet</strong> WDDX.
  
  Não passe informações de usuários não confiáveis para <strong>wddx_deserialize()</strong>. A desserialização pode
  resultar no carregamento e execução do código devido à instanciação e carregamento automático do
  objeto, e um usuário mal-intencionado pode explorar isso. Use um formato de intercâmbio de dados
  padrão e seguro, como JSON (através de <strong>json_decode()</strong> e <strong>json_encode()</strong>) se você precisar passar
  dados serializados para o usuário.

<comment>Param:</comment>
  <info>string</info>  <strong>$packet</strong>  Um pacote WDDX, como uma string ou stream.

<comment>Return:</comment>
  <info>mixed</info>  Retorna o valor desserializado que pode ser uma string, um número ou um array. Observe que
         as estruturas são desserializadas em arrays associativos.


id: wddx_packet_end
type: function
doc:
<comment>Description:</comment>
  Finaliza um pacote WDDX com o ID especificado
  
  Finaliza e retorna um pacote WDDX escolhido.

<comment>Param:</comment>
  <info>resource</info>  <strong>$packet_id</strong>  Um pacote WDDX, retornado por <strong>wddx_packet_start()</strong>.

<comment>Return:</comment>
  <info>string</info>  Retorna a string com o pacote WDDX.


id: wddx_packet_start
type: function
doc:
<comment>Description:</comment>
  Inicializa um novo pacote WDDX com uma estrutura dentro dele
  
  Inicializa um novo pacote WDDX para adição incremental de variáveis. A função cria automaticamente
  uma definição de estrutura dentro do pacote para armazenar as variáveis.

<comment>Param:</comment>
  <info>string</info>  <strong>$comment</strong>  Uma string opcional contendo comentários.

<comment>Return:</comment>
  <info>resource</info>  Retorna o ID do pacote para ser usado em outras funções ou <info>false</info> em caso de erro.


id: wddx_serialize_value
type: function
doc:
<comment>Description:</comment>
  Serializa um único valor em um pacote WDDX
  
  Cria um pacote WDDX a partir de uma única variável.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$var</strong>      Variável a ser serializada
  <info>string</info>  <strong>$comment</strong>  Um comentário (opcional) que aparece no cabeçalho do pacote.

<comment>Return:</comment>
  <info>string</info>  Retorna o pacote WDDX ou <info>false</info> em caso de erro.


id: wddx_serialize_vars
type: function
doc:
<comment>Description:</comment>
  Serializa variáveis em um pacote WDDX
  
  Cria um pacote WDDX com um estrutura que contém a representação serializada das variáveis
  passadas.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var_name</strong>   Pode ser ou uma string com o nome de uma variável ou um array contendo strings
                     com o nome de variáveis ou outro array, recursivamente.
  <info>mixed</info>  <strong>$var_names</strong>  

<comment>Return:</comment>
  <info>string</info>  Retorna o pacote WDDX ou <info>false</info> em caso de erro.


id: win32_continue_service
type: function
doc:
<comment>Description:</comment>
  Resumes a paused service
  
  Resumes a paused, named service. Requires administrative privileges or  an account with
  appropriate rights set in the service's ACL.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  The short name of the service.
  <info>string</info>  <strong>$machine</strong>      Optional machine name.  If omitted, the local machine is used.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.
        
        Prior to version 1.0.0, retornava <info>WIN32_NO_ERROR</info> em caso de sucesso, <info>false</info> se houver um
        problema com os parâmetros ou um Código de Erro Win32 em caso de falha.

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Win32 Error Codes


id: win32_create_service
type: function
doc:
<comment>Description:</comment>
  Creates a new service entry in the SCM database
  
  Attempts to add a service into the SCM database. Administrative privileges are required for this
  to succeed.

<comment>Param:</comment>
  <info>array</info>   <strong>$details</strong>                An array of service details: <strong>$service</strong> The short name of the
                                  service.  This is the name that you will use to control the
                                  service using the <return>net</return> command.  The service must be unique (no two
                                  services can share the same name), and, ideally, should avoid
                                  having spaces in the name. <strong>$display</strong>The display name of the
                                  service.  This is the name that you will see in the Services
                                  Applet. <strong>$description</strong>The long description of the service.  This is
                                  the description that you will see in the Services Applet. <strong>$user</strong>
                                  The name of the user account under which you want the service to
                                  run.  If omitted, the service will run as the LocalSystem account.
                                  If the username is specified, you must also provide a password.
                                  <strong>$password</strong> The password that corresponds to the <strong>$user</strong>. <strong>$path</strong> The
                                  full path to the executable module that will be launched when the
                                  service is started.  If omitted, the path to the current PHP
                                  process will be used. <strong>$params</strong> Command line parameters to pass to
                                  the service when it starts. If you want to run a PHP script as the
                                  service, then the first parameter should be the full path to the
                                  PHP script that you intend to run. If the script name or path
                                  contains spaces, then wrap the full path to the PHP script with <return>"</return>.
                                  <strong>$load_order</strong> Controls the load_order.  This is not yet fully
                                  supported. <strong>$svc_type</strong> Sets the service type.  If omitted, the
                                  default value is <info>WIN32_SERVICE_WIN32_OWN_PROCESS</info>. Don't change
                                  this unless you know what you're doing. <strong>$start_type</strong> Specifies how
                                  the service should be started.  The default is
                                  <info>WIN32_SERVICE_AUTO_START</info> which means the service will be launched
                                  when the machine starts up. <strong>$error_control</strong> Informs the SCM what it
                                  should do when it detects a problem with the service.  The default
                                  is <info>WIN32_SERVER_ERROR_IGNORE</info>.  Changing this value is not yet
                                  fully supported. <strong>$delayed_start</strong> If <strong>$delayed_start</strong> is set to <info>true</info>,
                                  then this will inform the SCM that this service should be started
                                  after other auto-start services are started plus a short delay.
                                  Any service can be marked as a delayed auto-start service;
                                  however, this setting has no effect unless the service's
                                  <strong>$start_type</strong> is <info>WIN32_SERVICE_AUTO_START</info>.  This setting is only
                                  applicable on Windows Vista and Windows Server 2008 or greater.
                                  <strong>$base_priority</strong> To reduce the impact on processor utilisation, it
                                  may be necessary to set a base priority lower than normal.  The
                                  <strong>$base_priority</strong> can be set to one of the constants define in Win32
                                  Base Priority Classes. <strong>$dependencies</strong> To define the dependencies
                                  for your service, it may be necessary to set  this parameter to
                                  the list of the services names in an array. <strong>$recovery_delay</strong> This
                                  parameter defines the delay between the fail and the execution  of
                                  recovery action. The value is in milliseconds.  The default value
                                  is 60000. <strong>$recovery_action_1</strong> The action will be executed on first
                                  failure. The default value is  <info>WIN32_SC_ACTION_NONE</info>.  The
                                  <strong>$recovery_action_1</strong> can be set to one of the constants defined in
                                  Win32 Recovery action. <strong>$recovery_action_2</strong> The action will be
                                  executed on second failure. The default value is
                                  <info>WIN32_SC_ACTION_NONE</info>.  The <strong>$recovery_action_2</strong> can be set to one of
                                  the constants defined in Win32 Recovery action. <strong>$recovery_action_3</strong>
                                  The action will be executed on next failures. The default value is
                                  <info>WIN32_SC_ACTION_NONE</info>.  The <strong>$recovery_action_3</strong> can be set to one of
                                  the constants defined in Win32 Recovery action.
                                  <strong>$recovery_reset_period</strong> The failure count will be reset after the
                                  delay defined in the parameter. The delay is expirement in
                                  seconds.  The default value is <return>86400</return>. <strong>$recovery_enabled</strong> Set this
                                  parameter at <info>true</info> to enable the recovery settings, <info>false</info>  to
                                  disable.   The default value is <info>false</info> <strong>$recovery_reboot_msg</strong> Set
                                  this parameter to define the message saved into the Windows Event
                                  Log before the reboot. Used only if one action is set to
                                  <info>WIN32_SC_ACTION_REBOOT</info>. <strong>$recovery_command</strong> Set this parameter to
                                  define the command executed when one action is defined on
                                  <info>WIN32_SC_ACTION_RUN_COMMAND</info>.
                                  
                                  The short name of the service.  This is the name that you will use
                                  to control the service using the <return>net</return> command.  The service must be
                                  unique (no two services can share the same name), and, ideally,
                                  should avoid having spaces in the name.
                                  
                                  The display name of the service.  This is the name that you will
                                  see in the Services Applet.
                                  
                                  The long description of the service.  This is the description that
                                  you will see in the Services Applet.
                                  
                                  The name of the user account under which you want the service to
                                  run.  If omitted, the service will run as the LocalSystem account.
                                  If the username is specified, you must also provide a password.
                                  
                                  The password that corresponds to the <strong>$user</strong>.
                                  
                                  The full path to the executable module that will be launched when
                                  the service is started.  If omitted, the path to the current PHP
                                  process will be used.
                                  
                                  Command line parameters to pass to the service when it starts. If
                                  you want to run a PHP script as the service, then the first
                                  parameter should be the full path to the PHP script that you
                                  intend to run. If the script name or path contains spaces, then
                                  wrap the full path to the PHP script with <return>"</return>.
                                  
                                  Controls the load_order.  This is not yet fully supported.
                                  
                                  Sets the service type.  If omitted, the default value is
                                  <info>WIN32_SERVICE_WIN32_OWN_PROCESS</info>. Don't change this unless you know
                                  what you're doing.
                                  
                                  Specifies how the service should be started.  The default is
                                  <info>WIN32_SERVICE_AUTO_START</info> which means the service will be launched
                                  when the machine starts up.
                                  
                                  Informs the SCM what it should do when it detects a problem with
                                  the service.  The default is <info>WIN32_SERVER_ERROR_IGNORE</info>.  Changing
                                  this value is not yet fully supported.
                                  
                                  If <strong>$delayed_start</strong> is set to <info>true</info>, then this will inform the SCM
                                  that this service should be started after other auto-start
                                  services are started plus a short delay.
                                  
                                  Any service can be marked as a delayed auto-start service;
                                  however, this setting has no effect unless the service's
                                  <strong>$start_type</strong> is <info>WIN32_SERVICE_AUTO_START</info>.
                                  
                                  This setting is only applicable on Windows Vista and Windows
                                  Server 2008 or greater.
                                  
                                  To reduce the impact on processor utilisation, it may be necessary
                                  to set a base priority lower than normal.
                                  
                                  The <strong>$base_priority</strong> can be set to one of the constants define in
                                  Win32 Base Priority Classes.
                                  
                                  To define the dependencies for your service, it may be necessary
                                  to set  this parameter to the list of the services names in an
                                  array.
                                  
                                  This parameter defines the delay between the fail and the
                                  execution  of recovery action. The value is in milliseconds.
                                  
                                  The default value is 60000.
                                  
                                  The action will be executed on first failure. The default value is
                                  <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  The <strong>$recovery_action_1</strong> can be set to one of the constants defined
                                  in Win32 Recovery action.
                                  
                                  The action will be executed on second failure. The default value
                                  is  <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  The <strong>$recovery_action_2</strong> can be set to one of the constants defined
                                  in Win32 Recovery action.
                                  
                                  The action will be executed on next failures. The default value is
                                  <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  The <strong>$recovery_action_3</strong> can be set to one of the constants defined
                                  in Win32 Recovery action.
                                  
                                  The failure count will be reset after the delay defined in the
                                  parameter. The delay is expirement in seconds.
                                  
                                  The default value is <return>86400</return>.
                                  
                                  Set this parameter at <info>true</info> to enable the recovery settings, <info>false</info>
                                  to disable.
                                  
                                  The default value is <info>false</info>
                                  
                                  Set this parameter to define the message saved into the Windows
                                  Event  Log before the reboot. Used only if one action is set to
                                  <info>WIN32_SC_ACTION_REBOOT</info>.
                                  
                                  Set this parameter to define the command executed when one action
                                  is defined on   <info>WIN32_SC_ACTION_RUN_COMMAND</info>.
  <info></info>        <strong>$service</strong>                The short name of the service.  This is the name that you will use
                                  to control the service using the <return>net</return> command.  The service must be
                                  unique (no two services can share the same name), and, ideally,
                                  should avoid having spaces in the name.
  <info></info>        <strong>$display</strong>                The display name of the service.  This is the name that you will
                                  see in the Services Applet.
  <info></info>        <strong>$description</strong>            The long description of the service.  This is the description that
                                  you will see in the Services Applet.
  <info></info>        <strong>$user</strong>                   The name of the user account under which you want the service to
                                  run.  If omitted, the service will run as the LocalSystem account.
                                  If the username is specified, you must also provide a password.
  <info></info>        <strong>$password</strong>               The password that corresponds to the <strong>$user</strong>.
  <info></info>        <strong>$path</strong>                   The full path to the executable module that will be launched when
                                  the service is started.  If omitted, the path to the current PHP
                                  process will be used.
  <info></info>        <strong>$params</strong>                 Command line parameters to pass to the service when it starts. If
                                  you want to run a PHP script as the service, then the first
                                  parameter should be the full path to the PHP script that you
                                  intend to run. If the script name or path contains spaces, then
                                  wrap the full path to the PHP script with <return>"</return>.
  <info></info>        <strong>$load_order</strong>             Controls the load_order.  This is not yet fully supported.
  <info></info>        <strong>$svc_type</strong>               Sets the service type.  If omitted, the default value is
                                  <info>WIN32_SERVICE_WIN32_OWN_PROCESS</info>. Don't change this unless you know
                                  what you're doing.
  <info></info>        <strong>$start_type</strong>             Specifies how the service should be started.  The default is
                                  <info>WIN32_SERVICE_AUTO_START</info> which means the service will be launched
                                  when the machine starts up.
  <info></info>        <strong>$error_control</strong>          Informs the SCM what it should do when it detects a problem with
                                  the service.  The default is <info>WIN32_SERVER_ERROR_IGNORE</info>.  Changing
                                  this value is not yet fully supported.
  <info></info>        <strong>$delayed_start</strong>          If <strong>$delayed_start</strong> is set to <info>true</info>, then this will inform the SCM
                                  that this service should be started after other auto-start
                                  services are started plus a short delay.
                                  
                                  Any service can be marked as a delayed auto-start service;
                                  however, this setting has no effect unless the service's
                                  <strong>$start_type</strong> is <info>WIN32_SERVICE_AUTO_START</info>.
                                  
                                  This setting is only applicable on Windows Vista and Windows
                                  Server 2008 or greater.
  <info></info>        <strong>$base_priority</strong>          To reduce the impact on processor utilisation, it may be necessary
                                  to set a base priority lower than normal.
                                  
                                  The <strong>$base_priority</strong> can be set to one of the constants define in
                                  Win32 Base Priority Classes.
  <info></info>        <strong>$dependencies</strong>           To define the dependencies for your service, it may be necessary
                                  to set  this parameter to the list of the services names in an
                                  array.
  <info></info>        <strong>$recovery_delay</strong>         This parameter defines the delay between the fail and the
                                  execution  of recovery action. The value is in milliseconds.
                                  
                                  The default value is 60000.
  <info></info>        <strong>$recovery_action_1</strong>      The action will be executed on first failure. The default value is
                                  <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  The <strong>$recovery_action_1</strong> can be set to one of the constants defined
                                  in Win32 Recovery action.
  <info></info>        <strong>$recovery_action_2</strong>      The action will be executed on second failure. The default value
                                  is  <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  The <strong>$recovery_action_2</strong> can be set to one of the constants defined
                                  in Win32 Recovery action.
  <info></info>        <strong>$recovery_action_3</strong>      The action will be executed on next failures. The default value is
                                  <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  The <strong>$recovery_action_3</strong> can be set to one of the constants defined
                                  in Win32 Recovery action.
  <info></info>        <strong>$recovery_reset_period</strong>  The failure count will be reset after the delay defined in the
                                  parameter. The delay is expirement in seconds.
                                  
                                  The default value is <return>86400</return>.
  <info></info>        <strong>$recovery_enabled</strong>       Set this parameter at <info>true</info> to enable the recovery settings, <info>false</info>
                                  to disable.
                                  
                                  The default value is <info>false</info>
  <info></info>        <strong>$recovery_reboot_msg</strong>    Set this parameter to define the message saved into the Windows
                                  Event  Log before the reboot. Used only if one action is set to
                                  <info>WIN32_SC_ACTION_REBOOT</info>.
  <info></info>        <strong>$recovery_command</strong>       Set this parameter to define the command executed when one action
                                  is defined on   <info>WIN32_SC_ACTION_RUN_COMMAND</info>.
  <info>string</info>  <strong>$machine</strong>                The optional machine name on which you want to create a service.
                                  If omitted, it will use the local machine.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.
        
        Prior to version 1.0.0, retornava <info>WIN32_NO_ERROR</info> em caso de sucesso, <info>false</info> se houver um
        problema com os parâmetros ou um Código de Erro Win32 em caso de falha.

<comment>See Also:</comment>
   * <strong>win32_delete_service()</strong>
   * Win32 Base Priority Classes
   * Win32 Recovery action
   * Win32 Error Codes


id: win32_delete_service
type: function
doc:
<comment>Description:</comment>
  Deletes a service entry from the SCM database
  
  Attempts to delete a service from the SCM database.  Administrative privileges are required for
  this to succeed.
  
  This function really just marks the service for deletion.  If other processes (such as the
  Services Applet) are open, then the deletion will be deferred until those applications are closed.
  If a service is marked for deletion, further attempts to delete it will fail, and attempts to
  create a new service with that name will also fail.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  The short name of the service.
  <info>string</info>  <strong>$machine</strong>      The optional machine name.  If omitted, the local machine will be used.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.
        
        Prior to version 1.0.0, retornava <info>WIN32_NO_ERROR</info> em caso de sucesso, <info>false</info> se houver um
        problema com os parâmetros ou um Código de Erro Win32 em caso de falha.

<comment>See Also:</comment>
   * <strong>win32_create_service()</strong>
   * Win32 Error Codes


id: win32_get_last_control_message
type: function
doc:
<comment>Description:</comment>
  Returns the last control message that was sent to this service
  
  Returns the control code that was last sent to this service process. When running as a service you
  should periodically check this to determine if your service needs to stop running.
  
  Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI  this function is
  disabled.

<comment>Return:</comment>
  <info>int</info>  Returns a control constant which will be one of the Win32Service Service Control Message
       Constants: <info>WIN32_SERVICE_CONTROL_CONTINUE</info>, <info>WIN32_SERVICE_CONTROL_DEVICEEVENT</info>,
       <info>WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE</info>, <info>WIN32_SERVICE_CONTROL_INTERROGATE</info>,
       <info>WIN32_SERVICE_CONTROL_NETBINDADD</info>, <info>WIN32_SERVICE_CONTROL_NETBINDDISABLE</info>,
       <info>WIN32_SERVICE_CONTROL_NETBINDENABLE</info>, <info>WIN32_SERVICE_CONTROL_NETBINDREMOVE</info>,
       <info>WIN32_SERVICE_CONTROL_PARAMCHANGE</info>, <info>WIN32_SERVICE_CONTROL_PAUSE</info>,
       <info>WIN32_SERVICE_CONTROL_POWEREVENT</info>, <info>WIN32_SERVICE_CONTROL_PRESHUTDOWN</info>,
       <info>WIN32_SERVICE_CONTROL_SESSIONCHANGE</info>, <info>WIN32_SERVICE_CONTROL_SHUTDOWN</info>,
       <info>WIN32_SERVICE_CONTROL_STOP</info>.
       
       If the value is between 128 and 255, the control code is custom.

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_set_service_exit_mode()</strong>
   * <strong>win32_set_service_exit_code()</strong>
   * Win32Service Service Control Message Constants


id: win32_pause_service
type: function
doc:
<comment>Description:</comment>
  Pauses a service
  
  Pauses a named service. Requires administrative privileges or an account with appropriate rights
  set in the service's ACL.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  The short name of the service.
  <info>string</info>  <strong>$machine</strong>      Optional machine name.  If omitted, the local machine is used.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.
        
        Prior to version 1.0.0, retornava <info>WIN32_NO_ERROR</info> em caso de sucesso, <info>false</info> se houver um
        problema com os parâmetros ou um Código de Erro Win32 em caso de falha.

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_continue_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Win32 Error Codes


id: win32_query_service_status
type: function
doc:
<comment>Description:</comment>
  Queries the status of a service
  
  Queries the current status for a service, returning an array of information.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  The short name of the service.
  <info>string</info>  <strong>$machine</strong>      The optional machine name.  If omitted, the local machine will be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array consisting of the following information on success
         
         Prior version 1.0.0, <info>false</info> se houver um problema com os parâmetros ou um Código de Erro
         Win32 em caso de falha.
         
         <strong>$ServiceType</strong> The dwServiceType. See Win32Service Service Type Bitmasks. <strong>$CurrentState</strong> The
         dwCurrentState. See Win32Service Service Status Constants. <strong>$ControlsAccepted</strong> Which service
         controls are accepted by the service. See Win32Service Service Control Message Accepted
         Bitmasks. <strong>$Win32ExitCode</strong> If the service exited, the return code from the process. This
         value is equal to  <info>WIN32_ERROR_SERVICE_SPECIFIC_ERROR</info>  if the exit mode is not gracefuly.
         See  Win32Service error codes and  <strong>win32_set_service_exit_mode()</strong> <strong>$ServiceSpecificExitCode</strong>
         If the service exited with an error condition, the service specific code that is logged in
         the event log is visible here. This value is equal  to the value defined by
         <strong>win32_set_service_exit_code()</strong> <strong>$CheckPoint</strong> If the service is shutting down, holds the
         current check point number. This is used by the SCM as a kind of heart-beat to detect a
         wedged service process.  The value of the check point is best interpreted in conjunction
         with the WaitHint value. <strong>$WaitHint</strong> If the service is shutting down it will set WaitHint to
         a checkpoint value that will indicate 100% completion.  This can be used to implement a
         progress indicator. <strong>$ProcessId</strong> The Windows process identifier. If 0, the process is not
         running. <strong>$ServiceFlags</strong> The dwServiceFlags. See Win32Service Service Flag Constants.
         
         The dwServiceType. See Win32Service Service Type Bitmasks.
         
         The dwCurrentState. See Win32Service Service Status Constants.
         
         Which service controls are accepted by the service. See Win32Service Service Control
         Message Accepted Bitmasks.
         
         If the service exited, the return code from the process. This value is equal to
         <info>WIN32_ERROR_SERVICE_SPECIFIC_ERROR</info>  if the exit mode is not gracefuly. See  Win32Service
         error codes and  <strong>win32_set_service_exit_mode()</strong>
         
         If the service exited with an error condition, the service specific code that is logged in
         the event log is visible here. This value is equal  to the value defined by
         <strong>win32_set_service_exit_code()</strong>
         
         If the service is shutting down, holds the current check point number. This is used by the
         SCM as a kind of heart-beat to detect a wedged service process.  The value of the check
         point is best interpreted in conjunction with the WaitHint value.
         
         If the service is shutting down it will set WaitHint to a checkpoint value that will
         indicate 100% completion.  This can be used to implement a progress indicator.
         
         The Windows process identifier. If 0, the process is not running.
         
         The dwServiceFlags. See Win32Service Service Flag Constants.

<comment>See Also:</comment>
   * Win32Service Predefined Constants


id: win32_send_custom_control
type: function
doc:
<comment>Description:</comment>
  Send a custom control to the service
  
  See Microsoft ControlService function for more details

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  The short name of the service.
  <info>int</info>     <strong>$control</strong>      The custom contole value between 128 and 255.
  <info>string</info>  <strong>$machine</strong>      Optional machine name.  If omitted, the local machine is used.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.
        
        Prior to version 1.0.0, retornava <info>WIN32_NO_ERROR</info> em caso de sucesso, <info>false</info> se houver um
        problema com os parâmetros ou um Código de Erro Win32 em caso de falha.

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_continue_service()</strong>
   * Win32 Error Codes


id: win32_set_service_exit_code
type: function
doc:
<comment>Description:</comment>
  Define or return the exit code for the current running service
  
  Change or return the exit code. The exit code is used only if the exit mode is not graceful.  If
  the value is not zero, the recovery configuration can be used after  service fail. See  Microsoft
  system error codes  for more details
  
  This function work only in "cli" SAPI. On other SAPI  this function is disabled.

<comment>Param:</comment>
  <info>int</info>  <strong>$exitCode</strong>  The return code used on exit.

<comment>Return:</comment>
  <info>int</info>  Return the current or old exit code.

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_set_service_exit_mode()</strong>


id: win32_set_service_exit_mode
type: function
doc:
<comment>Description:</comment>
  Define or return the exit mode for the current running service
  
  If <strong>$gracefulMode</strong> parameter is provided, the exit mode 
  is changed. When the exit mode is not gracefuly, the exit code used can be set 
  with the <strong>win32_set_service_exit_code()</strong> function.
  
  This function work only in "cli" SAPI. On other SAPI  this function is disabled.

<comment>Param:</comment>
  <info>bool</info>  <strong>$gracefulMode</strong>  <info>true</info> for exit graceful. <info>false</info> for exit with error.

<comment>Return:</comment>
  <info>bool</info>  Return the current or old exit mode.

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_set_service_exit_code()</strong>


id: win32_set_service_status
type: function
doc:
<comment>Description:</comment>
  Update the service status
  
  Informs the SCM of the current status of a running service. This call is only valid for a running
  service process.
  
  Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI  this function is
  disabled.

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>      The service status code, one of <info>WIN32_SERVICE_RUNNING</info>, <info>WIN32_SERVICE_STOPPED</info>,
                    <info>WIN32_SERVICE_STOP_PENDING</info>, <info>WIN32_SERVICE_START_PENDING</info>,
                    <info>WIN32_SERVICE_CONTINUE_PENDING</info>, <info>WIN32_SERVICE_PAUSE_PENDING</info>,
                    <info>WIN32_SERVICE_PAUSED</info>.
  <info>int</info>  <strong>$checkpoint</strong>  The checkpoint value the service increments periodically to report its progress
                    during a lengthy start, stop, pause, or continue operation. For example, the
                    service should increment this value as it completes each step of its
                    initialization when it is starting up.
                    
                    The <strong>$checkpoint</strong> is only valid when the <strong>$status</strong> is one of
                    <info>WIN32_SERVICE_STOP_PENDING</info>, <info>WIN32_SERVICE_START_PENDING</info>,
                    <info>WIN32_SERVICE_CONTINUE_PENDING</info> or <info>WIN32_SERVICE_PAUSE_PENDING</info>.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.
        
        Prior to version 1.0.0, retornava <info>WIN32_NO_ERROR</info> em caso de sucesso, <info>false</info> se houver um
        problema com os parâmetros ou um Código de Erro Win32 em caso de falha.

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_get_last_control_message()</strong>
   * <strong>win32_set_service_exit_mode()</strong>
   * <strong>win32_set_service_exit_code()</strong>
   * Win32Service Service Status Constants


id: win32_start_service
type: function
doc:
<comment>Description:</comment>
  Starts a service
  
  Attempts to start the named service. Requires administrative privileges or  an account with
  appropriate rights set in the service's ACL.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  The short name of the service.
  <info>string</info>  <strong>$machine</strong>      Optional machine name.  If omitted, the local machine is used.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.
        
        Prior to version 1.0.0, retornava <info>WIN32_NO_ERROR</info> em caso de sucesso, <info>false</info> se houver um
        problema com os parâmetros ou um Código de Erro Win32 em caso de falha.

<comment>See Also:</comment>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_continue_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Win32 Error Codes


id: win32_start_service_ctrl_dispatcher
type: function
doc:
<comment>Description:</comment>
  Registers the script with the SCM, so that it can act as the service with the given name
  
  When launched via the Service Control Manager, a service process is required to "check-in" with it
  to establish service monitoring and communication facilities.  This function performs the check-in
  by spawning a thread to handle the lower-level communication with the service control manager.
  
  Once started, the service process should do 2 things. The first is to tell the Service Control
  Manager that the service is running. This is achieved by calling <strong>win32_set_service_status()</strong> with
  the <info>WIN32_SERVICE_RUNNING</info> constant. If you need to perform some lengthy process before the service
  is actually running, then you can use the <info>WIN32_SERVICE_START_PENDING</info> constant. The second is to
  continue to check-in with the service control manager so that it can determine if it should
  terminate. This is achieved by periodically calling <strong>win32_get_last_control_message()</strong> and handling
  the return code appropriately.
  
  Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI  this function is
  disabled.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>          The short-name of the service, as registered by <strong>win32_create_service()</strong>.
  <info>bool</info>    <strong>$gracefulMode</strong>  <info>true</info> for exit graceful. <info>false</info> for exit with error. See
                         <strong>win32_set_service_exit_mode()</strong> for more details.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.
        
        Prior to version 1.0.0, retornava <info>WIN32_NO_ERROR</info> em caso de sucesso, <info>false</info> se houver um
        problema com os parâmetros ou um Código de Erro Win32 em caso de falha.

<comment>See Also:</comment>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_get_last_control_message()</strong>
   * <strong>win32_set_service_exit_mode()</strong>
   * <strong>win32_set_service_exit_code()</strong>
   * Win32 Error Codes


id: win32_stop_service
type: function
doc:
<comment>Description:</comment>
  Stops a service
  
  Stops a named service. Requires administrative privileges or an account with appropriate rights
  set in the service's ACL.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  The short name of the service.
  <info>string</info>  <strong>$machine</strong>      Optional machine name.  If omitted, the local machine is used.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.
        
        Prior to version 1.0.0, retornava <info>WIN32_NO_ERROR</info> em caso de sucesso, <info>false</info> se houver um
        problema com os parâmetros ou um Código de Erro Win32 em caso de falha.

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_continue_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Win32 Error Codes


id: wincache_fcache_fileinfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about files cached in the file cache
    
  
  Retrieves information about file cache content and its usage.

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  Controls whether the returned array will contain information about individual
                      cache entries  along with the file cache summary.

<comment>Return:</comment>
  <info>array|false</info>  Array of meta data about file cache  ou <info>false</info> em caso de falha
               
               The array returned by this function contains the following elements:
               <return>total_cache_uptime</return> - total time in seconds that the file cache has been active
               <return>total_file_count</return> - total number of files that are currently in the file cache
               <return>total_hit_count</return> - number of times the files have been served from the file cache
               <return>total_miss_count</return> - number of times the files have not been found in the file cache
               <return>file_entries</return> - an array that contains the information about all the cached files:
               <return>file_name</return> - absolute file name of the cached file <return>add_time</return> - time in seconds since
               the file has been added to the file cache <return>use_time</return> - time in seconds since the file
               has been accessed in the file cache <return>last_check</return> - time in seconds since the file has
               been checked for modifications <return>hit_count</return> - number of times the file has been served
               from the cache <return>file_size</return> - size of the cached file in bytes
               
               <return>total_cache_uptime</return> - total time in seconds that the file cache has been active
               
               <return>total_file_count</return> - total number of files that are currently in the file cache
               
               <return>total_hit_count</return> - number of times the files have been served from the file cache
               
               <return>total_miss_count</return> - number of times the files have not been found in the file cache
               
               <return>file_entries</return> - an array that contains the information about all the cached files:
               <return>file_name</return> - absolute file name of the cached file <return>add_time</return> - time in seconds since
               the file has been added to the file cache <return>use_time</return> - time in seconds since the file
               has been accessed in the file cache <return>last_check</return> - time in seconds since the file has
               been checked for modifications <return>hit_count</return> - number of times the file has been served
               from the cache <return>file_size</return> - size of the cached file in bytes
               
               <return>file_name</return> - absolute file name of the cached file
               
               <return>add_time</return> - time in seconds since the file has been added to the file cache
               
               <return>use_time</return> - time in seconds since the file has been accessed in the file cache
               
               <return>last_check</return> - time in seconds since the file has been checked for modifications
               
               <return>hit_count</return> - number of times the file has been served from the cache
               
               <return>file_size</return> - size of the cached file in bytes

<comment>See Also:</comment>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_fcache_meminfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about file cache memory usage
    
  
  Retrieves information about memory usage by file cache.

<comment>Return:</comment>
  <info>array|false</info>  Array of meta data about file cache memory usage  ou <info>false</info> em caso de falha
               
               The array returned by this function contains the following elements: <return>memory_total</return> -
               amount of memory in bytes allocated for the file cache <return>memory_free</return> - amount of free
               memory in bytes available for the file cache <return>num_used_blks</return> - number of memory blocks
               used by the file cache <return>num_free_blks</return> - number of free memory blocks available for the
               file cache <return>memory_overhead</return> - amount of memory in bytes used for the file cache
               internal structures
               
               <return>memory_total</return> - amount of memory in bytes allocated for the file cache
               
               <return>memory_free</return> - amount of free memory in bytes available for the file cache
               
               <return>num_used_blks</return> - number of memory blocks used by the file cache
               
               <return>num_free_blks</return> - number of free memory blocks available for the file cache
               
               <return>memory_overhead</return> - amount of memory in bytes used for the file cache internal
               structures

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_lock
type: function
doc:
<comment>Description:</comment>
  Acquires an exclusive lock on a given key
    
  
  Obtains an exclusive lock on a given key. The execution of the current script will be blocked
  until the  lock can be obtained. Once the lock is obtained, the other scripts that try to request
  the lock by using the same  key will be blocked, until the current script releases the lock by
  using <strong>wincache_unlock()</strong>.
  
  Using of the <strong>wincache_lock()</strong> and <strong>wincache_unlock()</strong> can cause deadlocks when  executing PHP scripts
  in a multi-process environment like FastCGI. Do not use these functions unless you are  absolutely
  sure you need to use them. For the majority of the operations on the user cache it is not
  necessary to use these functions.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>       Name of the key in the cache to get the lock on.
  <info>bool</info>    <strong>$isglobal</strong>  Controls whether the scope of the lock is system-wide or local. Local locks are
                     scoped to the application pool  in IIS FastCGI case or to all php processes
                     that have the same parent process 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>wincache_unlock()</strong>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>


id: wincache_ocache_fileinfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about files cached in the opcode cache
    
  
  Retrieves information about opcode cache content and its usage.
  
  Esta função foi
  REMOVIDA a partir do PHP 7.0.0.

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  Controls whether the returned array will contain information about individual
                      cache entries  along with the opcode cache summary.

<comment>Return:</comment>
  <info>array|false</info>  Array of meta data about opcode cache  ou <info>false</info> em caso de falha
               
               The array returned by this function contains the following elements:
               <return>total_cache_uptime</return> - total time in seconds that the opcode cache has been active
               <return>total_file_count</return> - total number of files that are currently in the opcode cache
               <return>total_hit_count</return> - number of times the compiled opcode have been served from the cache
               <return>total_miss_count</return> - number of times the compiled opcode have not been found in the
               cache <return>is_local_cache</return> - true is the cache metadata is for a local cache instance,
               false if the metadata is for the global cache <return>file_entries</return> - an array that contains
               the information about all the cached files: <return>file_name</return> - absolute file name of the
               cached file <return>add_time</return> - time in seconds since the file has been added to the opcode
               cache <return>use_time</return> - time in seconds since the file has been accessed in the opcode cache
               <return>last_check</return> - time in seconds since the file has been checked for modifications
               <return>hit_count</return> - number of times the file has been served from the cache <return>function_count</return> -
               number of functions in the cached file <return>class_count</return> - number of classes in the cached
               file
               
               <return>total_cache_uptime</return> - total time in seconds that the opcode cache has been active
               
               <return>total_file_count</return> - total number of files that are currently in the opcode cache
               
               <return>total_hit_count</return> - number of times the compiled opcode have been served from the cache
               
               <return>total_miss_count</return> - number of times the compiled opcode have not been found in the
               cache
               
               <return>is_local_cache</return> - true is the cache metadata is for a local cache instance,  false if
               the metadata is for the global cache
               
               <return>file_entries</return> - an array that contains the information about all the cached files:
               <return>file_name</return> - absolute file name of the cached file <return>add_time</return> - time in seconds since
               the file has been added to the opcode cache <return>use_time</return> - time in seconds since the file
               has been accessed in the opcode cache <return>last_check</return> - time in seconds since the file has
               been checked for modifications <return>hit_count</return> - number of times the file has been served
               from the cache <return>function_count</return> - number of functions in the cached file <return>class_count</return> -
               number of classes in the cached file
               
               <return>file_name</return> - absolute file name of the cached file
               
               <return>add_time</return> - time in seconds since the file has been added to the opcode cache
               
               <return>use_time</return> - time in seconds since the file has been accessed in the opcode cache
               
               <return>last_check</return> - time in seconds since the file has been checked for modifications
               
               <return>hit_count</return> - number of times the file has been served from the cache
               
               <return>function_count</return> - number of functions in the cached file
               
               <return>class_count</return> - number of classes in the cached file

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_ocache_meminfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about opcode cache memory usage
    
  
  Retrieves information about memory usage by opcode cache.

<comment>Return:</comment>
  <info>array|false</info>  Array of meta data about opcode cache memory usage  ou <info>false</info> em caso de falha
               
               The array returned by this function contains the following elements: <return>memory_total</return> -
               amount of memory in bytes allocated for the opcode cache <return>memory_free</return> - amount of free
               memory in bytes available for the opcode cache <return>num_used_blks</return> - number of memory
               blocks used by the opcode cache <return>num_free_blks</return> - number of free memory blocks
               available for the opcode cache <return>memory_overhead</return> - amount of memory in bytes used for
               the opcode cache internal structures
               
               <return>memory_total</return> - amount of memory in bytes allocated for the opcode cache
               
               <return>memory_free</return> - amount of free memory in bytes available for the opcode cache
               
               <return>num_used_blks</return> - number of memory blocks used by the opcode cache
               
               <return>num_free_blks</return> - number of free memory blocks available for the opcode cache
               
               <return>memory_overhead</return> - amount of memory in bytes used for the opcode cache internal
               structures
               
               Esta função foi
               REMOVIDA a partir do PHP 7.0.0.

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_refresh_if_changed
type: function
doc:
<comment>Description:</comment>
  Refreshes the cache entries for the cached files
    
  
  Refreshes the cache entries for the files, whose names were passed in the input argument.  If no
  argument is specified then refreshes all the entries in the cache.

<comment>Param:</comment>
  <info>array</info>  <strong>$files</strong>  An array of file names for files that need to be refreshed.  An absolute or
                 relative file paths can be used.

<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>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_rplist_fileinfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about resolve file path cache
    
  
  Retrieves information about cached mappings between relative file paths  and corresponding
  absolute file paths.

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

<comment>Return:</comment>
  <info>array|false</info>  Array of meta data about the resolve file path cache  ou <info>false</info> em caso de falha
               
               The array returned by this function contains the following elements: <return>total_file_count</return>
               - total number of file path  mappings stored in the cache <return>rplist_entries</return> - an array
               that contains the information about all  the cached file paths: <return>resolve_path</return> - path
               to a file <return>subkey_data</return> - corresponding absolute path to a file
               
               <return>total_file_count</return> - total number of file path  mappings stored in the cache
               
               <return>rplist_entries</return> - an array that contains the information about all  the cached file
               paths: <return>resolve_path</return> - path to a file <return>subkey_data</return> - corresponding absolute path to a
               file
               
               <return>resolve_path</return> - path to a file
               
               <return>subkey_data</return> - corresponding absolute path to a file

<comment>See Also:</comment>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_rplist_meminfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about memory usage by the resolve file path cache
    
  
  Retrieves information about memory usage by resolve file path cache.

<comment>Return:</comment>
  <info>array|false</info>  Array of meta data that describes memory usage by resolve file path cache.  ou <info>false</info>
               em caso de falha
               
               The array returned by this function contains the following elements: <return>memory_total</return> -
               amount of memory in bytes allocated for the resolve file path cache <return>memory_free</return> -
               amount of free memory in bytes available for the resolve file path cache
               <return>num_used_blks</return> - number of memory blocks used by the resolve file path cache
               <return>num_free_blks</return> - number of free memory blocks available for the resolve file path
               cache <return>memory_overhead</return> - amount of memory in bytes used for the internal structures of
               resolve file path cache
               
               <return>memory_total</return> - amount of memory in bytes allocated for the resolve file path cache
               
               <return>memory_free</return> - amount of free memory in bytes available for the resolve file path
               cache
               
               <return>num_used_blks</return> - number of memory blocks used by the resolve file path cache
               
               <return>num_free_blks</return> - number of free memory blocks available for the resolve file path
               cache
               
               <return>memory_overhead</return> - amount of memory in bytes used for the internal structures of
               resolve file path cache

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_scache_info
type: function
doc:
<comment>Description:</comment>
  Retrieves information about files cached in the session cache
    
  
  Retrieves information about session cache content and its usage.

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  Controls whether the returned array will contain information about individual
                      cache entries  along with the session cache summary.

<comment>Return:</comment>
  <info>array|false</info>  Array of meta data about session cache  ou <info>false</info> em caso de falha
               
               The array returned by this function contains the following elements:
               <return>total_cache_uptime</return> - total time in seconds that the session cache has been active
               <return>total_item_count</return> - total number of elements that are currently in the session cache
               <return>is_local_cache</return> - true is the cache metadata is for a local cache instance,  false if
               the metadata is for the global cache <return>total_hit_count</return> - number of times the data has
               been served from the cache <return>total_miss_count</return> - number of times the data has not been
               found in the cache <return>scache_entries</return> - an array that contains the information about all
               the cached items: <return>key_name</return> - name of the key which is used to store the data
               <return>value_type</return> - type of value stored by the key <return>use_time</return> - time in seconds since the
               file has been accessed in the opcode cache <return>last_check</return> - time in seconds since the
               file has been checked for modifications <return>ttl_seconds</return> - time remaining for the data to
               live in the cache, 0 meaning infinite <return>age_seconds</return> - time elapsed from the time data
               has been added in the cache <return>hitcount</return> - number of times data has been served from the
               cache
               
               <return>total_cache_uptime</return> - total time in seconds that the session cache has been active
               
               <return>total_item_count</return> - total number of elements that are currently in the session cache
               
               <return>is_local_cache</return> - true is the cache metadata is for a local cache instance,  false if
               the metadata is for the global cache
               
               <return>total_hit_count</return> - number of times the data has been served from the cache
               
               <return>total_miss_count</return> - number of times the data has not been found in the cache
               
               <return>scache_entries</return> - an array that contains the information about all the cached items:
               <return>key_name</return> - name of the key which is used to store the data <return>value_type</return> - type of value
               stored by the key <return>use_time</return> - time in seconds since the file has been accessed in the
               opcode cache <return>last_check</return> - time in seconds since the file has been checked for
               modifications <return>ttl_seconds</return> - time remaining for the data to live in the cache, 0
               meaning infinite <return>age_seconds</return> - time elapsed from the time data has been added in the
               cache <return>hitcount</return> - number of times data has been served from the cache
               
               <return>key_name</return> - name of the key which is used to store the data
               
               <return>value_type</return> - type of value stored by the key
               
               <return>use_time</return> - time in seconds since the file has been accessed in the opcode cache
               
               <return>last_check</return> - time in seconds since the file has been checked for modifications
               
               <return>ttl_seconds</return> - time remaining for the data to live in the cache, 0 meaning infinite
               
               <return>age_seconds</return> - time elapsed from the time data has been added in the cache
               
               <return>hitcount</return> - number of times data has been served from the cache

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_scache_meminfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about session cache memory usage
    
  
  Retrieves information about memory usage by session cache.

<comment>Return:</comment>
  <info>array|false</info>  Array of meta data about session cache memory usage  ou <info>false</info> em caso de falha
               
               The array returned by this function contains the following elements: <return>memory_total</return> -
               amount of memory in bytes allocated for the session cache <return>memory_free</return> - amount of
               free memory in bytes available for the session cache <return>num_used_blks</return> - number of memory
               blocks used by the session cache <return>num_free_blks</return> - number of free memory blocks
               available for the session cache <return>memory_overhead</return> - amount of memory in bytes used for
               the session cache internal structures
               
               <return>memory_total</return> - amount of memory in bytes allocated for the session cache
               
               <return>memory_free</return> - amount of free memory in bytes available for the session cache
               
               <return>num_used_blks</return> - number of memory blocks used by the session cache
               
               <return>num_free_blks</return> - number of free memory blocks available for the session cache
               
               <return>memory_overhead</return> - amount of memory in bytes used for the session cache internal
               structures

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>


id: wincache_ucache_add
type: function
doc:
<comment>Description:</comment>
  Adds a variable in user cache only if variable does not already exist in the cache
    
  
  Adds a variable in user cache, only if this variable doesn't already exist in the cache.  The
  added variable remains in the user cache unless its time to live expires or it is  deleted by
  using <strong>wincache_ucache_delete()</strong> or <strong>wincache_ucache_clear()</strong> functions.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     Store the variable using this <strong>$key</strong> name. If a variable with same key is already
                   present the function will fail and return <info>false</info>. <strong>$key</strong> is case sensitive. To
                   override the value even if  <strong>$key</strong> is present use <strong>wincache_ucache_set()</strong> function
                   instad.  <strong>$key</strong> can also take array of name =&gt; value pairs where names will be
                   used as keys.  This can be used to add multiple values in the cache in one
                   operation, thus avoiding race condition.
  <info>mixed</info>   <strong>$value</strong>   Value of a variable to store. <strong>$Value</strong> supports all data types except resources,
                   such as file handles. This paramter is ignored if first argument is an array. A
                   general guidance is to pass <info>null</info>  as <strong>$value</strong> while using array as <strong>$key</strong>. If <strong>$value</strong>
                   is an object, or an array containing objects, then the objects will be
                   serialized. See __sleep() for details on serializing objects.
  <info>array</info>   <strong>$values</strong>  Associative array of keys and values.
  <info>int</info>     <strong>$ttl</strong>     Time for the variable to live in the cache in seconds. After the value specified
                   in <strong>$ttl</strong> has passed  the stored variable will be deleted from the cache. This
                   parameter takes a default value of <return>0</return> which means  the variable will stay in the
                   cache unless explicitly deleted by using <strong>wincache_ucache_delete()</strong>  or
                   <strong>wincache_ucache_clear()</strong> functions.

<comment>Return:</comment>
  <info>bool</info>  If <strong>$key</strong> is string, the function returns <info>true</info> on success and <info>false</info> on failure.
        
        If <strong>$key</strong> is an array, the function returns:  If all the name =&gt; value pairs in the array
        can be set, function returns an empty array;  If all the name =&gt; value pairs in the array
        cannot be set, function returns <info>false</info>;  If some can be set while others cannot, function
        returns an array with name=&gt;value pair for which the addition failed in the user cache.
        
        If all the name =&gt; value pairs in the array can be set, function returns an empty array;
        
        If all the name =&gt; value pairs in the array cannot be set, function returns <info>false</info>;
        
        If some can be set while others cannot, function returns an array with name=&gt;value pair
        for which the addition failed in the user cache.

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * __sleep()


id: wincache_ucache_cas
type: function
doc:
<comment>Description:</comment>
  Compares the variable with old value and assigns new value to it
    
  
  Compares the variable associated with the <strong>$key</strong> with <strong>$old_value</strong>  and if it matches then assigns the
  <strong>$new_value</strong> to it.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>        The <strong>$key</strong> that is used to store the variable in the cache.  <strong>$key</strong> is case
                      sensitive.
  <info>int</info>     <strong>$old_value</strong>  Old value of the variable pointed by <strong>$key</strong> in the user cache.  The value should
                      be of type <return>long</return>, otherwise the function returns  <info>false</info>.
  <info>int</info>     <strong>$new_value</strong>  New value which will get assigned to variable pointer by <strong>$key</strong> if a  match is
                      found. The value should be of type <return>long</return>, otherwise  the function returns
                      <info>false</info>.

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

<comment>See Also:</comment>
   * <strong>wincache_ucache_inc()</strong>
   * <strong>wincache_ucache_dec()</strong>


id: wincache_ucache_clear
type: function
doc:
<comment>Description:</comment>
  Deletes entire content of the user cache
    
  
  Clears/deletes all the values stored in the user cache.

<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>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_ucache_dec
type: function
doc:
<comment>Description:</comment>
  Decrements the value associated with the key
    
  
  Decrements the value associated with the <strong>$key</strong> by 1 or as specified  by <strong>$dec_by</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>      The <strong>$key</strong> that was used to store the variable in the cache.  <strong>$key</strong> is case
                    sensitive.
  <info>int</info>     <strong>$dec_by</strong>   The value by which the variable associated with the <strong>$key</strong> will get decremented.
                    If the argument is a floating point number it will be truncated to nearest
                    integer. The variable  associated with the <strong>$key</strong> should be of type <return>long</return>,
                    otherwise  the function fails and returns <info>false</info>.
  <info>bool</info>    <strong>$success</strong>  Will be set to <info>true</info> on success and <info>false</info> on failure.

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

<comment>See Also:</comment>
   * <strong>wincache_ucache_inc()</strong>
   * <strong>wincache_ucache_cas()</strong>


id: wincache_ucache_delete
type: function
doc:
<comment>Description:</comment>
  Deletes variables from the user cache
    
  
  Deletes the elements in the user cache pointed by <strong>$key</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  The <strong>$key</strong> that was used to store the variable in the cache.  <strong>$key</strong> is case sensitive.
               <strong>$key</strong> can be an  array of keys.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
        
        If <strong>$key</strong> is an array then the function returns <info>false</info>  if every element of the array fails to
        get deleted from the user cache, otherwise returns an  array which consists of all the keys
        that are deleted.

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_ucache_exists
type: function
doc:
<comment>Description:</comment>
  Checks if a variable exists in the user cache
    
  
  Checks if a variable with the <strong>$key</strong> exists in the user cache or not.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The <strong>$key</strong> that was used to store the variable in the cache.  <strong>$key</strong> is case sensitive.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if variable with the <strong>$key</strong> exitsts,  otherwise returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_ucache_get
type: function
doc:
<comment>Description:</comment>
  Gets a variable stored in the user cache
    
  
  Gets a variable stored in the user cache.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>      The <strong>$key</strong> that was used to store the variable in the cache.  <strong>$key</strong> is case
                   sensitive. <strong>$key</strong> can be an  array of keys. In this case the return value will be
                   an array of values of each element  in the <strong>$key</strong> array. If an object, or an array
                   containing objects, is returned, then the objects will be unserialized. See
                   __wakeup() for details on unserializing objects.
  <info>bool</info>   <strong>$success</strong>  Will be set to <info>true</info> on success and <info>false</info> on failure.

<comment>Return:</comment>
  <info>mixed</info>  If <strong>$key</strong> is a string, the function returns the value of the variable stored with that key.
         The <strong>$success</strong> is set to <info>true</info> on success and  to <info>false</info> on failure.
         
         The <strong>$key</strong> is an array, the parameter <strong>$success</strong>  is always set to <info>true</info>. The returned array
         (name =&gt; value pairs) will  contain only those name =&gt; value pairs for which the get
         operation in user cache was  successful. If none of the keys in the key array finds a match
         in the user cache  an empty array will be returned.

<comment>See Also:</comment>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * __wakeup()


id: wincache_ucache_inc
type: function
doc:
<comment>Description:</comment>
  Increments the value associated with the key
    
  
  Increments the value associated with the <strong>$key</strong> by 1 or as specified  by <strong>$inc_by</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>      The <strong>$key</strong> that was used to store the variable in the cache.  <strong>$key</strong> is case
                    sensitive.
  <info>int</info>     <strong>$inc_by</strong>   The value by which the variable associated with the <strong>$key</strong> will get incremented.
                    If the argument is a floating point number it will be truncated to nearest
                    integer. The variable  associated with the <strong>$key</strong> should be of type <return>long</return>,
                    otherwise  the function fails and returns <info>false</info>.
  <info>bool</info>    <strong>$success</strong>  Will be set to <info>true</info> on success and <info>false</info> on failure.

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

<comment>See Also:</comment>
   * <strong>wincache_ucache_dec()</strong>
   * <strong>wincache_ucache_cas()</strong>


id: wincache_ucache_info
type: function
doc:
<comment>Description:</comment>
  Retrieves information about data stored in the user cache
    
  
  Retrieves information about data stored in the user cache.

<comment>Param:</comment>
  <info>bool</info>    <strong>$summaryonly</strong>  Controls whether the returned array will contain information about
                        individual cache entries  along with the user cache summary.
  <info>string</info>  <strong>$key</strong>          The key of an entry in the user cache. If specified then the returned array
                        will contain information  only about that cache entry. If not specified and
                        <strong>$summaryonly</strong> is set to  <info>false</info> then the returned array will contain
                        information about all entries in the cache.

<comment>Return:</comment>
  <info>array|false</info>  Array of meta data about user cache  ou <info>false</info> em caso de falha
               
               The array returned by this function contains the following elements:
               <return>total_cache_uptime</return> - total time in seconds that the user cache has been active
               <return>total_item_count</return> - total number of elements that are currently in the user cache
               <return>is_local_cache</return> - true is the cache metadata is for a local cache instance,  false if
               the metadata is for the global cache <return>total_hit_count</return> - number of times the data has
               been served from the cache <return>total_miss_count</return> - number of times the data has not been
               found in the cache <return>ucache_entries</return> - an array that contains the information about all
               the cached items: <return>key_name</return> - name of the key which is used to store the data
               <return>value_type</return> - type of value stored by the key <return>use_time</return> - time in seconds since the
               file has been accessed in the opcode cache <return>last_check</return> - time in seconds since the
               file has been checked for modifications <return>is_session</return> - indicates if the data is a
               session variable <return>ttl_seconds</return> - time remaining for the data to live in the cache, 0
               meaning infinite <return>age_seconds</return> - time elapsed from the time data has been added in the
               cache <return>hitcount</return> - number of times data has been served from the cache
               
               <return>total_cache_uptime</return> - total time in seconds that the user cache has been active
               
               <return>total_item_count</return> - total number of elements that are currently in the user cache
               
               <return>is_local_cache</return> - true is the cache metadata is for a local cache instance,  false if
               the metadata is for the global cache
               
               <return>total_hit_count</return> - number of times the data has been served from the cache
               
               <return>total_miss_count</return> - number of times the data has not been found in the cache
               
               <return>ucache_entries</return> - an array that contains the information about all the cached items:
               <return>key_name</return> - name of the key which is used to store the data <return>value_type</return> - type of value
               stored by the key <return>use_time</return> - time in seconds since the file has been accessed in the
               opcode cache <return>last_check</return> - time in seconds since the file has been checked for
               modifications <return>is_session</return> - indicates if the data is a session variable <return>ttl_seconds</return> -
               time remaining for the data to live in the cache, 0 meaning infinite <return>age_seconds</return> -
               time elapsed from the time data has been added in the cache <return>hitcount</return> - number of
               times data has been served from the cache
               
               <return>key_name</return> - name of the key which is used to store the data
               
               <return>value_type</return> - type of value stored by the key
               
               <return>use_time</return> - time in seconds since the file has been accessed in the opcode cache
               
               <return>last_check</return> - time in seconds since the file has been checked for modifications
               
               <return>is_session</return> - indicates if the data is a session variable
               
               <return>ttl_seconds</return> - time remaining for the data to live in the cache, 0 meaning infinite
               
               <return>age_seconds</return> - time elapsed from the time data has been added in the cache
               
               <return>hitcount</return> - number of times data has been served from the cache

<comment>See Also:</comment>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_ucache_meminfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about user cache memory usage
    
  
  Retrieves information about memory usage by user cache.

<comment>Return:</comment>
  <info>array|false</info>  Array of meta data about user cache memory usage  ou <info>false</info> em caso de falha
               
               The array returned by this function contains the following elements: <return>memory_total</return> -
               amount of memory in bytes allocated for the user cache <return>memory_free</return> - amount of free
               memory in bytes available for the user cache <return>num_used_blks</return> - number of memory blocks
               used by the user cache <return>num_free_blks</return> - number of free memory blocks available for the
               user cache <return>memory_overhead</return> - amount of memory in bytes used for the user cache
               internal structures
               
               <return>memory_total</return> - amount of memory in bytes allocated for the user cache
               
               <return>memory_free</return> - amount of free memory in bytes available for the user cache
               
               <return>num_used_blks</return> - number of memory blocks used by the user cache
               
               <return>num_free_blks</return> - number of free memory blocks available for the user cache
               
               <return>memory_overhead</return> - amount of memory in bytes used for the user cache internal
               structures

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_ucache_set
type: function
doc:
<comment>Description:</comment>
  Adds a variable in user cache and overwrites a variable if it already exists in the cache
    
  
  Adds a variable in user cache. Overwrites a variable if it already exists in the cache.  The added
  or updated variable remains in the user cache unless its time to live expires or it is  deleted by
  using <strong>wincache_ucache_delete()</strong> or <strong>wincache_ucache_clear()</strong> functions.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>     Store the variable using this <strong>$key</strong> name. If a variable with same  <strong>$key</strong> is already
                  present the function will overwrite the previous  value with the new one. <strong>$key</strong> is
                  case sensitive.  <strong>$key</strong> can also take array of name =&gt; value pairs where names
                  will be used as  keys. This can be used to add multiple values in the cache in one
                  operation, thus avoiding  race condition.
  <info>mixed</info>  <strong>$value</strong>   Value of a variable to store. <strong>$Value</strong> supports all data types except resources,
                  such as file handles. This paramter is ignored if first argument is an array. A
                  general guidance is to pass <info>null</info>  as <strong>$value</strong> while using array as <strong>$key</strong>. If <strong>$value</strong>
                  is an object, or an array containing objects, then the objects will be serialized.
                  See __sleep() for details on serializing objects.
  <info>array</info>  <strong>$values</strong>  Associative array of keys and values.
  <info>int</info>    <strong>$ttl</strong>     Time for the variable to live in the cache in seconds. After the value specified
                  in <strong>$ttl</strong> has passed  the stored variable will be deleted from the cache. This
                  parameter takes a default value of <return>0</return> which means  the variable will stay in the
                  cache unless explicitly deleted by using <strong>wincache_ucache_delete()</strong>  or
                  <strong>wincache_ucache_clear()</strong> functions.

<comment>Return:</comment>
  <info>bool</info>  If <strong>$key</strong> is string, the function returns <info>true</info> on success and <info>false</info> on failure.
        
        If <strong>$key</strong> is an array, the function returns:  If all the name =&gt; value pairs in the array
        can be set, function returns an empty array;  If all the name =&gt; value pairs in the array
        cannot be set, function returns <info>false</info>;  If some can be set while others cannot, function
        returns an array with name=&gt;value pair for which the addition failed in the user cache.
        
        If all the name =&gt; value pairs in the array can be set, function returns an empty array;
        
        If all the name =&gt; value pairs in the array cannot be set, function returns <info>false</info>;
        
        If some can be set while others cannot, function returns an array with name=&gt;value pair
        for which the addition failed in the user cache.

<comment>See Also:</comment>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * __sleep()


id: wincache_unlock
type: function
doc:
<comment>Description:</comment>
  Releases an exclusive lock on a given key
    
  
  Releases an exclusive lock that was obtained on a given key by using <strong>wincache_lock()</strong>.  If any
  other process was blocked waiting for the lock on this key, that process will be able to obtain
  the lock.
  
  Using of the <strong>wincache_lock()</strong> and <strong>wincache_unlock()</strong> can cause deadlocks when  executing PHP scripts
  in a multi-process environment like FastCGI. Do not use these functions unless you are  absolutely
  sure you need to use them. For the majority of the operations on the user cache it is not
  necessary to use these functions.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  Name of the key in the cache to release the lock on.

<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>wincache_lock()</strong>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>


id: wkhtmltox\Image\Converter::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new Image converter
  
  Creates an Image converter, optionally taking an input buffer and configuration settings

<comment>Param:</comment>
  <info>string</info>  <strong>$buffer</strong>    HTML
  <info>array</info>   <strong>$settings</strong>  NameDescriptionValuesChangeloginURL or path of the input file, if "-" stdin is
                     used/path/to/markup.html&gt;= 0.1.0outpath of output file, if "-" stdout is
                     used, by default an internal buffer is used/path/to/output.png&gt;=
                     0.1.0fmtoutput format to use""defaultjpgoutput as JPEGpngoutput as PNGbmpoutput
                     as bitmapsvgoutput as SVG&gt;= 0.1.0transparentwhen outputting a PNG or SVG,
                     make the white background transparentboolean&gt;= 0.1.0screenWidththe with of
                     the screen used to render in pixels800&gt;= 0.1.0smartWidthwhen true,
                     screenWidth is expanded to the content widthboolean&gt;=
                     0.1.0qualitycompression factor to use when outputting a JPEG image94&gt;=
                     0.1.0crop.leftleft/x coordinate of the window to capture in pixels200&gt;=
                     0.1.0crop.toptop/y coordinate of the window to capture in pixels200&gt;=
                     0.1.0crop.widthwidth of the window to capture in pixels200&gt;=
                     0.1.0crop.heightheight of the window to capture in pixels200&gt;=
                     0.1.0load.cookieJarpath of file used to load and store
                     cookies/tmp/cookies.txt&gt;= 0.1.0load.usernameuser name to use when loging
                     into a websitebart&gt;= 0.1.0load.passwordthe password to used when logging
                     into a websiteelbarto&gt;= 0.1.0load.jsdelaythe amount of time in milliseconds
                     to wait after a page is loaded until it is captured1200&gt;=
                     0.1.0load.zoomFactorhow much zoom should be applied to the content2.2&gt;=
                     0.1.0load.customHeaderscustom headers to send when requesting the main web
                     page&gt;= 0.1.0load.repertCustomHeadersset true to send with all
                     requestsboolean&gt;= 0.1.0load.cookiescookie string to send when requesting the
                     main web page&gt;= 0.1.0load.postpost string to send when requesting the main
                     web page&gt;= 0.1.0load.blockLocalFileAccessdisallow local and piped files to
                     access other local filesboolean&gt;= 0.1.0load.stopSlowScriptstop slow running
                     javascriptbooleanload.debugJavascriptallow javascript to raise
                     warningsboolean&gt;= 0.1.0load.loadErrorHandlingset error handling
                     strategyabortabort the convertion processskipdo not add the object to the final
                     outputignoretry to add the object to the final output&gt;= 0.1.0load.proxy&gt;=
                     0.1.0web.backgroundinclude background image in outputboolean&gt;=
                     0.1.0web.loadImagesinclude images in outputboolean&gt;=
                     0.1.0web.enableJavascriptenable or disable javascriptboolean&gt;=
                     0.1.0web.enableIntelligentShrinkingenable to attempt to fit more content on
                     page, only applies to PDF outputboolean&gt;= 0.1.0web.minimumFontSizethe
                     minimum font size allowed9&gt;= 0.1.0web.printMediaTypeprint content using
                     print media type instead of screen media typeboolean&gt;=
                     0.1.0web.defaultEncodingcontent to use where no encoding is specifiedutf-8&gt;=
                     0.1.0web.userStyleSheetURL or path to a user specified style
                     sheet/path/to/style.css&gt;= 0.1.0web.enablePluginsenable or disable NS
                     pluginsboolean&gt;= 0.1.0


id: wkhtmltox\Image\Converter::convert
type: function
doc:
<comment>Description:</comment>
  Perform Image conversion
  
  Performs conversion of the input buffer

<comment>Return:</comment>
  <info>string|null</info>  Where the return value is used, it will be populated with the contents of the
               conversion buffer


id: wkhtmltox\Image\Converter::getVersion
type: function
doc:
<comment>Description:</comment>
  Determine version of Converter
  
  Determines the version of Converter as reported by libwkhtmltox

<comment>Return:</comment>
  <info>string</info>  Returns a version string
          
          This is not yet implemented by libwkhtmltox


id: wkhtmltox\PDF\Converter::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new PDF converter
  
  Creates a PDF converter, using optional configuration settings

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  NameDescriptionValuesChangelogsize.pageSizepaper size of output documentA4&gt;=
                    0.1.0size.widthwith of the output document210mm&gt;= 0.1.0size.heightheight of
                    the output document297mm&gt;= 0.1.0orientationorientation of the output
                    documentLandscapePortrait&gt;= 0.1.0colorModecolor mode of the output
                    documentColorGreyscale&gt;= 0.1.0resolutionresoluition of the output
                    documentmost likely has no effect&gt;= 0.1.0dpidpi to use while printing80&gt;=
                    0.1.0pageOffsetinteger added to page numbers generating headers, footers, and
                    toc&gt;= 0.1.0copies&gt;= 0.1.0collatecollate copiesboolean&gt;=
                    0.1.0outlinegenerate PDF outlineboolean&gt;= 0.1.0outlineDepthmaximum depth of
                    outline&gt;= 0.1.0dumpOutlinepath of file to dump outline XML&gt;= 0.1.0outpath
                    of output file, if "-" stdout is used&gt;= 0.1.0documentTitletitle for the
                    output document&gt;= 0.1.0useCompressionenable or disable lossless
                    compressionboolean&gt;= 0.1.0margin.topsize of the top margin2cm&gt;=
                    0.1.0margin.bottomsize of the bottom margin2cm&gt;= 0.1.0margin.leftsize of the
                    left margin2cm&gt;= 0.1.0margin.rightsize of the right margin2cm&gt;=
                    0.1.0imageDPImaximum DPI for images in the output document&gt;=
                    0.1.0imageQualitythe jpeg compression factor for images in the output
                    document94&gt;= 0.1.0load.cookieJarpath of file used to load and store
                    cookies/tmp/cookies.txt&gt;= 0.1.0


id: wkhtmltox\PDF\Converter::add
type: function
doc:
<comment>Description:</comment>
  Add an object for conversion
  
  Adds the given object to conversion

<comment>Param:</comment>
  <info>wkhtmltox\PDF\Object</info>  <strong>$object</strong>  The object to add

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


id: wkhtmltox\PDF\Converter::convert
type: function
doc:
<comment>Description:</comment>
  Perform PDF conversion
  
  Performs conversion of all previously added Objects

<comment>Return:</comment>
  <info>string|null</info>  Where the return value is used, it will be populated with the contents of the
               conversion buffer


id: wkhtmltox\PDF\Converter::getVersion
type: function
doc:
<comment>Description:</comment>
  Determine version of Converter
  
  Determines the version of Converter as reported by libwkhtmltox

<comment>Return:</comment>
  <info>string</info>  Returns a version string


id: wkhtmltox\PDF\Object::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new PDF Object
  
  Creates a new PDF Object from the given buffer and optional configuration settings

<comment>Param:</comment>
  <info>string</info>  <strong>$buffer</strong>    HTML
  <info>array</info>   <strong>$settings</strong>  NameDescriptionValuesChangelogpageURL or path of the HTML to convert&gt;=
                     0.1.0useExternalLinksset true to convert external links in the input into
                     external PDF links in the outputboolean&gt;= 0.1.0useLocalLinksset true to
                     convert internal links in the input into internal PDF links in the
                     outputboolean&gt;= 0.1.0produceFormsset true to turn HTML forms into PDF
                     formsboolean&gt;= 0.1.0replacementsundocumented&gt;= 0.1.0includeInOutlineset
                     true to include sections from this object in the outline and tocboolean&gt;=
                     0.1.0pagesCountset true to make page count in toc inclusive of the number of
                     pages in this objectboolean&gt;= 0.1.0tocXslset to style sheet to convert this
                     object into a toc object&gt;= 0.1.0toc.useDottedLinesset true to use dotted
                     lines in tocboolean&gt;= 0.1.0toc.captionTextthe caption text for toc&gt;=
                     0.1.0toc.forwardLinksset true to create links from toc to contentboolean&gt;=
                     0.1.0toc.backLinksset true to create links from content to tocboolean&gt;=
                     0.1.0toc.indentationindentation for toc2em&gt;= 0.1.0toc.fontScalethe factor to
                     scale down the font at every toc level0.8&gt;= 0.1.0header.fontSizefont size
                     for use in header13&gt;= 0.1.0header.fontNamename of font for use in
                     headertimes&gt;= 0.1.0header.lefttext for left of header&gt;=
                     0.1.0header.centertext for center of header&gt;= 0.1.0header.righttext for
                     right of header&gt;= 0.1.0header.lineenable or disable horizontal rule under
                     headerboolean&gt;= 0.1.0header.spacingspace between header and content1.8&gt;=
                     0.1.0header.htmlUrlURL or path of HTML to use in header&gt;=
                     0.1.0footer.fontSizefont size for use in footer13&gt;= 0.1.0footer.fontNamename
                     of font for use in footertimes&gt;= 0.1.0footer.lefttext for left of
                     footer&gt;= 0.1.0footer.centertext for center of footer&gt;=
                     0.1.0footer.righttext for right of footer&gt;= 0.1.0footer.lineenable or
                     disable horizontal rule under footerboolean&gt;= 0.1.0footer.spacingspace
                     between footer and content1.8&gt;= 0.1.0footer.htmlUrlURL or path of HTML to
                     use in footer&gt;= 0.1.0load.usernameuser name to use when loging into a
                     websitebart&gt;= 0.1.0load.passwordthe password to used when logging into a
                     websiteelbarto&gt;= 0.1.0load.jsdelaythe amount of time in milliseconds to wait
                     after a page is loaded until it is captured1200&gt;= 0.1.0load.zoomFactorhow
                     much zoom should be applied to the content2.2&gt;=
                     0.1.0load.customHeaderscustom headers to send when requesting the main web
                     page&gt;= 0.1.0load.repertCustomHeadersset true to send with all
                     requestsboolean&gt;= 0.1.0load.cookiescookie string to send when requesting the
                     main web page&gt;= 0.1.0load.postpost string to send when requesting the main
                     web page&gt;= 0.1.0load.blockLocalFileAccessdisallow local and piped files to
                     access other local filesboolean&gt;= 0.1.0load.stopSlowScriptstop slow running
                     javascriptbooleanload.debugJavascriptallow javascript to raise
                     warningsboolean&gt;= 0.1.0load.loadErrorHandlingset error handling
                     strategyabortabort the convertion processskipdo not add the object to the final
                     outputignoretry to add the object to the final output&gt;= 0.1.0load.proxy&gt;=
                     0.1.0web.backgroundinclude background image in outputboolean&gt;=
                     0.1.0web.loadImagesinclude images in outputboolean&gt;=
                     0.1.0web.enableJavascriptenable or disable javascriptboolean&gt;=
                     0.1.0web.enableIntelligentShrinkingenable to attempt to fit more content on
                     page, only applies to PDF outputboolean&gt;= 0.1.0web.minimumFontSizethe
                     minimum font size allowed9&gt;= 0.1.0web.printMediaTypeprint content using
                     print media type instead of screen media typeboolean&gt;=
                     0.1.0web.defaultEncodingcontent to use where no encoding is specifiedutf-8&gt;=
                     0.1.0web.userStyleSheetURL or path to a user specified style
                     sheet/path/to/style.css&gt;= 0.1.0web.enablePluginsenable or disable NS
                     pluginsboolean&gt;= 0.1.0


id: wordwrap
type: function
doc:
<comment>Description:</comment>
  Quebra uma string em um dado número de caracteres
  
  Quebra uma string em um dado número de caracteres usando um caractere de quebra de string.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>          A string de entrada.
  <info>int</info>     <strong>$width</strong>           O número de caracteres nos quais a string será quebrada.
  <info>string</info>  <strong>$break</strong>           A linha é quebrada usando o parâmetro opcional <strong>$break</strong>.
  <info>bool</info>    <strong>$cut_long_words</strong>  Se <strong>$cut_long_words</strong> for definido para <info>true</info>, a string é sempre quebrada na
                           largura especificada em <strong>$width</strong> ou antes. Então se existir uma palavra
                           longa que a largura informada, ela será quebrada. (Veja o segundo
                           exemplo). Quando <info>false</info>, a função não quebra a palavra mesmo se <strong>$width</strong> for
                           menor que o comprimento dela.

<comment>Return:</comment>
  <info>string</info>  Retorna a string dada quebrada na largura especificada.

<comment>See Also:</comment>
   * <strong>nl2br()</strong>
   * <strong>chunk_split()</strong>


id: xattr_get
type: function
doc:
<comment>Description:</comment>
  Get an extended attribute
    
  
  This function gets the value of an extended attribute of a file.
  
  Os atributos estendidos têm dois namespaces diferentes: usuário
  e root. O namespace de usuário está disponível para todos os usuários, enquanto o namespace de
  root
  está disponível apenas para o usuário com privilégios de root. xattr opera no namespace de
  usuário por padrão, mas isso pode ser alterado com o parâmetro
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The file from which we get the attribute.
  <info>string</info>  <strong>$name</strong>      The name of the attribute.
  <info>int</info>     <strong>$flags</strong>     Supported xattr flags<info>XATTR_DONTFOLLOW</info>Do not follow the symbolic link but
                     operate on symbolic link itself.<info>XATTR_ROOT</info>Set attribute in root (trusted)
                     namespace. Requires root privileges.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the value or <info>false</info> if the attribute doesn't  exist.

<comment>See Also:</comment>
   * <strong>xattr_list()</strong>
   * <strong>xattr_set()</strong>
   * <strong>xattr_remove()</strong>


id: xattr_list
type: function
doc:
<comment>Description:</comment>
  Get a list of extended attributes
    
  
  This functions gets a list of names of extended attributes of a file.
  
  Os atributos estendidos têm dois namespaces diferentes: usuário
  e root. O namespace de usuário está disponível para todos os usuários, enquanto o namespace de
  root
  está disponível apenas para o usuário com privilégios de root. xattr opera no namespace de
  usuário por padrão, mas isso pode ser alterado com o parâmetro
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The path of the file.
  <info>int</info>     <strong>$flags</strong>     Supported xattr flags<info>XATTR_DONTFOLLOW</info>Do not follow the symbolic link but
                     operate on symbolic link itself.<info>XATTR_ROOT</info>Set attribute in root (trusted)
                     namespace. Requires root privileges.

<comment>Return:</comment>
  <info>array</info>  This function returns an array with names of extended attributes.

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


id: xattr_remove
type: function
doc:
<comment>Description:</comment>
  Remove an extended attribute
    
  
  This function removes an extended attribute of a file.
  
  Os atributos estendidos têm dois namespaces diferentes: usuário
  e root. O namespace de usuário está disponível para todos os usuários, enquanto o namespace de
  root
  está disponível apenas para o usuário com privilégios de root. xattr opera no namespace de
  usuário por padrão, mas isso pode ser alterado com o parâmetro
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The file from which we remove the attribute.
  <info>string</info>  <strong>$name</strong>      The name of the attribute to remove.
  <info>int</info>     <strong>$flags</strong>     Supported xattr flags<info>XATTR_DONTFOLLOW</info>Do not follow the symbolic link but
                     operate on symbolic link itself.<info>XATTR_ROOT</info>Set attribute in root (trusted)
                     namespace. Requires root privileges.

<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>xattr_list()</strong>
   * <strong>xattr_set()</strong>
   * <strong>xattr_get()</strong>


id: xattr_set
type: function
doc:
<comment>Description:</comment>
  Set an extended attribute
    
  
  This function sets the value of an extended attribute of a file.
  
  Os atributos estendidos têm dois namespaces diferentes: usuário
  e root. O namespace de usuário está disponível para todos os usuários, enquanto o namespace de
  root
  está disponível apenas para o usuário com privilégios de root. xattr opera no namespace de
  usuário por padrão, mas isso pode ser alterado com o parâmetro
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The file in which we set the attribute.
  <info>string</info>  <strong>$name</strong>      The name of the extended attribute. This attribute will be created if  it
                     doesn't exist or replaced otherwise. You can change this behaviour  by using
                     the <strong>$flags</strong> parameter.
  <info>string</info>  <strong>$value</strong>     The value of the attribute.
  <info>int</info>     <strong>$flags</strong>     Supported xattr flags<info>XATTR_CREATE</info>Function will fail if extended attribute
                     already exists.<info>XATTR_REPLACE</info>Function will fail if extended attribute doesn't
                     exist.<info>XATTR_DONTFOLLOW</info>Do not follow the symbolic link but operate on symbolic
                     link itself.<info>XATTR_ROOT</info>Set attribute in root (trusted) namespace. Requires root
                     privileges.

<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>xattr_get()</strong>
   * <strong>xattr_remove()</strong>


id: xattr_supported
type: function
doc:
<comment>Description:</comment>
  Check if filesystem supports extended attributes
    
  
  This functions checks if the filesystem holding the given file supports  extended attributes. Read
  access to the file is required.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The path of the tested file.
  <info>int</info>     <strong>$flags</strong>     Supported xattr flags<info>XATTR_DONTFOLLOW</info>Do not follow the symbolic link but
                     operate on symbolic link itself.

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if filesystem supports extended attributes, <info>false</info> if it doesn't
        and <info>null</info> if it can't be determined (for example wrong path or lack of permissions to file).

<comment>See Also:</comment>
   * <strong>xattr_get()</strong>
   * <strong>xattr_list()</strong>


id: xdiff_file_bdiff
type: function
doc:
<comment>Description:</comment>
  Make binary diff of two files
  
  Makes a binary diff of two files and stores the result in a patch file. This function works with
  both text and binary files. Resulting patch file can be later applied using
  <strong>xdiff_file_bpatch()</strong>/<strong>xdiff_string_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Path to the first file. This file acts as "old" file.
  <info>string</info>  <strong>$new_file</strong>  Path to the second file. This file acts as "new" file.
  <info>string</info>  <strong>$dest</strong>      Path of the resulting patch file. Resulting file contains differences between
                     "old" and "new" files. It is in binary format and is human-unreadable.

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


id: xdiff_file_bdiff_size
type: function
doc:
<comment>Description:</comment>
  Read a size of file created by applying a binary diff
  
  Returns a size of a result file that would be created after applying binary patch from file <strong>$file</strong>
  to the original file.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>  The path to the binary patch created by <strong>xdiff_string_bdiff()</strong> or
                 <strong>xdiff_string_rabdiff()</strong> function.

<comment>Return:</comment>
  <info>int</info>  Returns the size of file that would be created.

<comment>See Also:</comment>
   * <strong>xdiff_file_bdiff()</strong>
   * <strong>xdiff_file_rabdiff()</strong>
   * <strong>xdiff_file_bpatch()</strong>


id: xdiff_file_bpatch
type: function
doc:
<comment>Description:</comment>
  Patch a file with a binary diff
  
  Patches a <strong>$file</strong> with a binary <strong>$patch</strong> and stores the result in a file <strong>$dest</strong>.  This function accepts
  patches created both via <strong>xdiff_file_bdiff()</strong>  and <strong>xdiff_file_rabdiff()</strong> functions or their string
  counterparts.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>   The original file.
  <info>string</info>  <strong>$patch</strong>  The binary patch file.
  <info>string</info>  <strong>$dest</strong>   Path of the resulting file.

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

<comment>See Also:</comment>
   * <strong>xdiff_file_bdiff()</strong>
   * <strong>xdiff_file_rabdiff()</strong>


id: xdiff_file_diff
type: function
doc:
<comment>Description:</comment>
  Make unified diff of two files
  
  Makes an unified diff containing differences between <strong>$old_file</strong> and <strong>$new_file</strong> and stores it in
  <strong>$dest</strong> file. The resulting file is human-readable. An optional <strong>$context</strong> parameter specifies how
  many lines of context should be added around each change. Setting <strong>$minimal</strong> parameter to true will
  result in outputting the shortest patch file possible (can take a long time).

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Path to the first file. This file acts as "old" file.
  <info>string</info>  <strong>$new_file</strong>  Path to the second file. This file acts as "new" file.
  <info>string</info>  <strong>$dest</strong>      Path of the resulting patch file.
  <info>int</info>     <strong>$context</strong>   Indicates how many lines of context you want to include in diff result.
  <info>bool</info>    <strong>$minimal</strong>   Set this parameter to <info>true</info> if you want to minimalize size of the result (can
                     take a long time).

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


id: xdiff_file_diff_binary
type: function
doc:
<comment>Description:</comment>
  Sinônimo de xdiff_file_bdiff
  
  Makes a binary diff of two files and stores the result in a patch file. This function works with
  both text and binary files. Resulting patch file can be later applied using <strong>xdiff_file_bpatch()</strong>.
  
  Starting with version 1.5.0 this function is an alias of <strong>xdiff_file_bdiff()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Path to the first file. This file acts as "old" file.
  <info>string</info>  <strong>$new_file</strong>  Path to the second file. This file acts as "new" file.
  <info>string</info>  <strong>$dest</strong>      Path of the resulting patch file. Resulting file contains differences between
                     "old" and "new" files. It is in binary format and is human-unreadable.

<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>xdiff_file_bdiff()</strong>
   * <strong>xdiff_file_bpatch()</strong>


id: xdiff_file_merge3
type: function
doc:
<comment>Description:</comment>
  Merge 3 files into one
  
  Merges three files into one and stores the result in a file <strong>$dest</strong>.  The <strong>$old_file</strong> is an original
  version while <strong>$new_file1</strong> and <strong>$new_file2</strong> are modified versions of an original.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>   Path to the first file. It acts as "old" file.
  <info>string</info>  <strong>$new_file1</strong>  Path to the second file. It acts as modified version of <strong>$old_file</strong>.
  <info>string</info>  <strong>$new_file2</strong>  Path to the third file. It acts as modified version of <strong>$old_file</strong>.
  <info>string</info>  <strong>$dest</strong>       Path of the resulting file, containing merged changed from both <strong>$new_file1</strong> and
                      <strong>$new_file2</strong>.

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>true</info> if merge was successful, string with rejected chunks if it was not or <info>false</info> if
         an internal error happened.

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


id: xdiff_file_patch
type: function
doc:
<comment>Description:</comment>
  Patch a file with an unified diff
  
  Patches a <strong>$file</strong> with a <strong>$patch</strong> and stores the result in a file. <strong>$patch</strong> has to be an unified diff
  created by  <strong>xdiff_file_diff()</strong>/<strong>xdiff_string_diff()</strong> function.  An optional <strong>$flags</strong> parameter
  specifies mode of operation.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>   The original file.
  <info>string</info>  <strong>$patch</strong>  The unified patch file. It has to be created using <strong>xdiff_string_diff()</strong>,
                  <strong>xdiff_file_diff()</strong> functions or compatible tools.
  <info>string</info>  <strong>$dest</strong>   Path of the resulting file.
  <info>int</info>     <strong>$flags</strong>  Can be either <info>XDIFF_PATCH_NORMAL</info> (default mode, normal patch) or
                  <info>XDIFF_PATCH_REVERSE</info> (reversed patch).
                  
                  Starting from version 1.5.0, you can also use binary OR to enable
                  <info>XDIFF_PATCH_IGNORESPACE</info> flag.

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>false</info> if an internal error happened, string with rejected chunks if patch couldn't
         be applied or <info>true</info> if patch has been successfully applied.

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


id: xdiff_file_patch_binary
type: function
doc:
<comment>Description:</comment>
  Sinônimo de xdiff_file_bpatch
  
  Patches a <strong>$file</strong> with a binary <strong>$patch</strong> and stores the result in a file <strong>$dest</strong>.  This function accepts
  patches created both via <strong>xdiff_file_bdiff()</strong>  or <strong>xdiff_file_rabdiff()</strong> functions or their string
  counterparts.
  
  Starting with version 1.5.0 this function is an alias of <strong>xdiff_file_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>   The original file.
  <info>string</info>  <strong>$patch</strong>  The binary patch file.
  <info>string</info>  <strong>$dest</strong>   Path of the resulting file.

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

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


id: xdiff_file_rabdiff
type: function
doc:
<comment>Description:</comment>
  Make binary diff of two files using the Rabin's polynomial fingerprinting algorithm
  
  Makes a binary diff of two files and stores the result in a patch file. The difference between
  this function and <strong>xdiff_file_bdiff()</strong> is different algorithm used which should result in faster
  execution and smaller diff produced. This function works with both text and binary files.
  Resulting patch file can be later applied using <strong>xdiff_file_bpatch()</strong>/<strong>xdiff_string_bpatch()</strong>.
  
  For more details about differences between algorithm used please check libxdiff  website.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Path to the first file. This file acts as "old" file.
  <info>string</info>  <strong>$new_file</strong>  Path to the second file. This file acts as "new" file.
  <info>string</info>  <strong>$dest</strong>      Path of the resulting patch file. Resulting file contains differences between
                     "old" and "new" files. It is in binary format and is human-unreadable.

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


id: xdiff_string_bdiff
type: function
doc:
<comment>Description:</comment>
  Make binary diff of two strings
  
  Makes a binary diff of two strings and returns the result. This function works with both text and
  binary data. Resulting patch can be later applied using <strong>xdiff_string_bpatch()</strong>/<strong>xdiff_file_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  First string with binary data. It acts as "old" data.
  <info>string</info>  <strong>$new_data</strong>  Second string with binary data. It acts as "new" data.

<comment>Return:</comment>
  <info>string</info>  Returns string with binary diff containing differences between "old" and "new" data or
          <info>false</info> if an internal error occurred.

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


id: xdiff_string_bdiff_size
type: function
doc:
<comment>Description:</comment>
  Read a size of file created by applying a binary diff
  
  Returns a size of a result file that would be created after applying binary <strong>$patch</strong> to the original
  file.

<comment>Param:</comment>
  <info>string</info>  <strong>$patch</strong>  The binary patch created by <strong>xdiff_string_bdiff()</strong> or  <strong>xdiff_string_rabdiff()</strong>
                  function.

<comment>Return:</comment>
  <info>int</info>  Returns the size of file that would be created.

<comment>See Also:</comment>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_rabdiff()</strong>
   * <strong>xdiff_string_bpatch()</strong>


id: xdiff_string_bpatch
type: function
doc:
<comment>Description:</comment>
  Patch a string with a binary diff
  
  Patches a string <strong>$str</strong> with a binary <strong>$patch</strong>. This function accepts patches created both via
  <strong>xdiff_string_bdiff()</strong>  and <strong>xdiff_string_rabdiff()</strong> functions or their file counterparts.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>    The original binary string.
  <info>string</info>  <strong>$patch</strong>  The binary patch string.

<comment>Return:</comment>
  <info>string</info>  Returns the patched string, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_rabdiff()</strong>


id: xdiff_string_diff
type: function
doc:
<comment>Description:</comment>
  Make unified diff of two strings
  
  Makes an unified diff containing differences between <strong>$old_data</strong> string and <strong>$new_data</strong> string and
  returns it. The resulting diff is human-readable.  An optional <strong>$context</strong> parameter specifies how
  many lines of context should be added around each change. Setting <strong>$minimal</strong> parameter  to true will
  result in outputting the shortest patch file possible (can take a long time).

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  First string with data. It acts as "old" data.
  <info>string</info>  <strong>$new_data</strong>  Second string with data. It acts as "new" data.
  <info>int</info>     <strong>$context</strong>   Indicates how many lines of context you want to include in the diff result.
  <info>bool</info>    <strong>$minimal</strong>   Set this parameter to <info>true</info> if you want to minimalize the size of the result
                     (can take a long time).

<comment>Return:</comment>
  <info>string</info>  Returns string with resulting diff or <info>false</info> if an internal error happened.

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


id: xdiff_string_diff_binary
type: function
doc:
<comment>Description:</comment>
  Sinônimo de xdiff_string_bdiff
  
  Makes a binary diff of two strings and returns the result. This function works with both text and
  binary data. Resulting patch can be later applied using <strong>xdiff_string_bpatch()</strong>/<strong>xdiff_file_bpatch()</strong>.
  
  Starting with version 1.5.0 this function is an alias of <strong>xdiff_string_bdiff()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  First string with binary data. It acts as "old" data.
  <info>string</info>  <strong>$new_data</strong>  Second string with binary data. It acts as "new" data.

<comment>Return:</comment>
  <info>string</info>  Returns string with result or <info>false</info> if an internal error happened.

<comment>See Also:</comment>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_bpatch()</strong>


id: xdiff_string_merge3
type: function
doc:
<comment>Description:</comment>
  Merge 3 strings into one
  
  Merges three strings into one and returns the result. The <strong>$old_data</strong> is an original version of data
  while <strong>$new_data1</strong> and <strong>$new_data2</strong> are modified  versions of an original. An optional <strong>$error</strong> is used
  to pass any rejected parts during merging process.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>   First string with data. It acts as "old" data.
  <info>string</info>  <strong>$new_data1</strong>  Second string with data. It acts as modified version of <strong>$old_data</strong>.
  <info>string</info>  <strong>$new_data2</strong>  Third string with data. It acts as modified version of <strong>$old_data</strong>.
  <info>string</info>  <strong>$error</strong>      If provided then rejected parts are stored inside this variable.

<comment>Return:</comment>
  <info>mixed</info>  Returns the merged string, <info>false</info> if an internal error happened, or <info>true</info> if merged string is
         empty.

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


id: xdiff_string_patch
type: function
doc:
<comment>Description:</comment>
  Patch a string with an unified diff
  
  Patches a <strong>$str</strong> string with an unified patch in <strong>$patch</strong> parameter  and returns the result. <strong>$patch</strong>
  has to be an unified diff created by  <strong>xdiff_file_diff()</strong>/<strong>xdiff_string_diff()</strong> function.  An optional
  <strong>$flags</strong> parameter specifies mode of operation. Any rejected parts of the patch will be stored
  inside <strong>$error</strong> variable if  it is provided.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>    The original string.
  <info>string</info>  <strong>$patch</strong>  The unified patch string. It has to be created using <strong>xdiff_string_diff()</strong>,
                  <strong>xdiff_file_diff()</strong> functions or compatible tools.
  <info>int</info>     <strong>$flags</strong>  <strong>$flags</strong> can be either <info>XDIFF_PATCH_NORMAL</info> (default mode, normal patch) or
                  <info>XDIFF_PATCH_REVERSE</info> (reversed patch).
                  
                  Starting from version 1.5.0, you can also use binary OR to enable
                  <info>XDIFF_PATCH_IGNORESPACE</info> flag.
  <info>string</info>  <strong>$error</strong>  If provided then rejected parts are stored inside this variable.

<comment>Return:</comment>
  <info>string</info>  Returns the patched string, or <info>false</info> on error.

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


id: xdiff_string_patch_binary
type: function
doc:
<comment>Description:</comment>
  Sinônimo de xdiff_string_bpatch
  
  Patches a string <strong>$str</strong> with a binary <strong>$patch</strong>. This function accepts patches created both via
  <strong>xdiff_string_bdiff()</strong>  and <strong>xdiff_string_rabdiff()</strong> functions or their file counterparts.
  
  Starting with version 1.5.0 this function is an alias of <strong>xdiff_string_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>    The original binary string.
  <info>string</info>  <strong>$patch</strong>  The binary patch string.

<comment>Return:</comment>
  <info>string</info>  Returns the patched string, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>xdiff_string_bpatch()</strong>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_rabdiff()</strong>


id: xdiff_string_rabdiff
type: function
doc:
<comment>Description:</comment>
  Make binary diff of two strings using the Rabin's polynomial fingerprinting algorithm
  
  Makes a binary diff of two strings and returns the result. The difference between this function
  and <strong>xdiff_string_bdiff()</strong> is different algorithm used which should result in faster execution and
  smaller diff produced. This function works with both text and binary data. Resulting patch can be
  later applied using <strong>xdiff_string_bpatch()</strong>/<strong>xdiff_file_bpatch()</strong>.
  
  For more details about differences between algorithm used please check libxdiff  website.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  First string with binary data. It acts as "old" data.
  <info>string</info>  <strong>$new_data</strong>  Second string with binary data. It acts as "new" data.

<comment>Return:</comment>
  <info>string</info>  Returns string with binary diff containing differences between "old" and "new" data or
          <info>false</info> if an internal error occurred.

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


id: xhprof_disable
type: function
doc:
<comment>Description:</comment>
  Stops xhprof profiler
  
  Stops the profiler, and returns xhprof data from the run.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of xhprof data, from the run.


id: xhprof_enable
type: function
doc:
<comment>Description:</comment>
  Start xhprof profiler
  
  Start xhprof profiling.

<comment>Param:</comment>
  <info>int</info>    <strong>$flags</strong>    Optional flags to add additional information to the profiling. See the XHprof
                   constants for further information about these flags, e.g., <info>XHPROF_FLAGS_MEMORY</info> to
                   enable memory profiling.
  <info>array</info>  <strong>$options</strong>  An <info>array</info> of optional options, namely, the 'ignored_functions' option to pass in
                   functions to be ignored during profiling.

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

<comment>See Also:</comment>
   * <strong>xhprof_disable()</strong>
   * <strong>xhprof_sample_enable()</strong>
   * <strong>memory_get_usage()</strong>
   * <strong>getrusage()</strong>


id: xhprof_sample_disable
type: function
doc:
<comment>Description:</comment>
  Stops xhprof sample profiler
  
  Stops the sample mode xhprof profiler, and

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of xhprof sample data, from the run.


id: xhprof_sample_enable
type: function
doc:
<comment>Description:</comment>
  Start XHProf profiling in sampling mode
  
  Starts profiling in sample mode, which is a lighter weight version of <strong>xhprof_enable()</strong>. The
  sampling interval is 0.1 seconds, and samples record the full function call stack. The main use
  case is when lower overhead is required when doing performance monitoring and diagnostics.

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

<comment>See Also:</comment>
   * <strong>xhprof_sample_disable()</strong>
   * <strong>xhprof_enable()</strong>
   * <strong>memory_get_usage()</strong>
   * <strong>getrusage()</strong>


id: xml_error_string
type: function
doc:
<comment>Description:</comment>
  Obtém uma string de erro do analisador XML
  
  Obtém a string do erro do analisador XML associada com o código de erro fornecido em <strong>$error_code</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$error_code</strong>  Um código de erro de <strong>xml_get_error_code()</strong>.

<comment>Return:</comment>
  <info>string|null</info>  Retorna uma string com uma descrição textual do código de erro <strong>$error_code</strong>, ou <info>null</info>
               se nenhuma descrição for encontrada.

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


id: xml_get_current_byte_index
type: function
doc:
<comment>Description:</comment>
  Get current byte index for an XML parser
  
  Gets the current byte index of the given XML parser.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  A reference to the XML parser to get byte index from.

<comment>Return:</comment>
  <info>int</info>  Returns which byte index the parser is currently at in its data buffer (starting at 0).

<comment>See Also:</comment>
   * <strong>xml_get_current_column_number()</strong>
   * <strong>xml_get_current_line_number()</strong>


id: xml_get_current_column_number
type: function
doc:
<comment>Description:</comment>
  Get current column number for an XML parser
    
  
  Gets the current column number of the given XML parser.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  A reference to the XML parser to get column number from.

<comment>Return:</comment>
  <info>int</info>  Returns which column on the current line (as given by <strong>xml_get_current_line_number()</strong>) the
       parser is currently at.

<comment>See Also:</comment>
   * <strong>xml_get_current_byte_index()</strong>
   * <strong>xml_get_current_line_number()</strong>


id: xml_get_current_line_number
type: function
doc:
<comment>Description:</comment>
  Get current line number for an XML parser
  
  Gets the current line number for the given XML parser.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  A reference to the XML parser to get line number from.

<comment>Return:</comment>
  <info>int</info>  Returns which line the parser is currently at in its data buffer.

<comment>See Also:</comment>
   * <strong>xml_get_current_column_number()</strong>
   * <strong>xml_get_current_byte_index()</strong>


id: xml_get_error_code
type: function
doc:
<comment>Description:</comment>
  Obtém um código de erro do analisador XML
  
  Obtém o código de erro do analisador XML.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Uma referência para o analisador XML obter código de erro.

<comment>Return:</comment>
  <info>int</info>  Retorna um dos códigos de erro listados na seção de código de erros.

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


id: xml_parse
type: function
doc:
<comment>Description:</comment>
  Start parsing an XML document
  
  <strong>xml_parse()</strong> parses an XML document. The handlers for the configured events are called as many
  times as necessary.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>    A reference to the XML parser to use.
  <info>string</info>     <strong>$data</strong>      Chunk of data to parse.  A document may be parsed piece-wise by calling
                        <strong>xml_parse()</strong> several times with new data, as long as the <strong>$is_final</strong> parameter
                        is set and <info>true</info> when the last data is parsed.
  <info>bool</info>       <strong>$is_final</strong>  If set and <info>true</info>, <strong>$data</strong> is the last piece of data sent in this parse.

<comment>Return:</comment>
  <info>int</info>  Returns 1 on success or 0 on failure.
       
       For unsuccessful parses, error information can be retrieved with <strong>xml_get_error_code()</strong>,
       <strong>xml_error_string()</strong>, <strong>xml_get_current_line_number()</strong>, <strong>xml_get_current_column_number()</strong> and
       <strong>xml_get_current_byte_index()</strong>.
       
       Some errors (such as entity errors) are reported at the end of the data, thus only if
       <strong>$is_final</strong> is set and <info>true</info>.


id: xml_parse_into_struct
type: function
doc:
<comment>Description:</comment>
  Analisa dados XML dentro de uma estrutura de array
  
  Esta função analisa uma string XML para 2 estruturas de array paralelas, uma (<strong>$index</strong>) contendo
  indicadores para a localização dos valores apropriados no array identificado por <strong>$values</strong>. Estes
  dois últimos parâmetros deve ser passados por referência.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Uma referência ao analisador XML.
  <info>string</info>     <strong>$data</strong>    Uma string contendo os dados XML.
  <info>array</info>      <strong>$values</strong>  Um array contendo os valores do dados XML
  <info>array</info>      <strong>$index</strong>   Um array contendo ponteiros para a localização dos valores apropriados em
                      $values.

<comment>Return:</comment>
  <info>int</info>  <strong>xml_parse_into_struct()</strong> retorna 0 para falha e 1 para sucesso. Isto não é o mesmo que <info>false</info> e
       <info>true</info>, deve-se ter cuidado ao usar operadores como ===.


id: xml_parser_create
type: function
doc:
<comment>Description:</comment>
  Cria um analisador XML
  
  <strong>xml_parser_create()</strong> cria um novo analisador XML e retorna uma instância de <class>XMLParser</class> para ser
  usada pelas outras funções XML.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$encoding</strong>  A codificação de entrada é detectada automaticamente, de forma que o
                          parâmetro <strong>$encoding</strong> especifica apenas a codificação de saída. Se uma
                          string vazia for passada, o analisador tenta identificar qual a
                          codificação do documento verificando 3 ou 4 bytes do cabeçalho. O conjunto
                          de caracteres de saída padrão é o UTF-8. As codificações suportadas são
                          <return>ISO-8859-1</return>, <return>UTF-8</return> e <return>US-ASCII</return>.

<comment>Return:</comment>
  <info>XMLParser</info>  Retorna uma nova instância de <class>XMLParser</class>.

<comment>See Also:</comment>
   * <strong>xml_parser_create_ns()</strong>
   * <strong>xml_parser_free()</strong>


id: xml_parser_create_ns
type: function
doc:
<comment>Description:</comment>
  Cria um analisador XML com suporte a espaço de nomes
  
  <strong>xml_parser_create_ns()</strong> cria um novo analisador XML com suporte a espaço de nomes do XML e retorna
  uma instância de <class>XMLParser</class> para ser usada pelas outras funções XML.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$encoding</strong>   A codificação de entrada é automaticamente detectada, de forma que o
                           parâmetro <strong>$encoding</strong> especifica somente a codificação de saída. O conjunto
                           de caracteres de saída padrão é o UTF-8. As codificações suportadas são
                           <return>ISO-8859-1</return>, <return>UTF-8</return> e <return>US-ASCII</return>.
  <info>string</info>       <strong>$separator</strong>  Com um analisador ciente do espaço de nomes, os parâmetros de etiquetas
                           passados às várias funções de manupulação consistirão do nome do espaço e
                           do nome da etiqueta separados pela string especificada em <strong>$separator</strong>.

<comment>Return:</comment>
  <info>XMLParser</info>  Retorna uma nova instância de <class>XMLParser</class>.

<comment>See Also:</comment>
   * <strong>xml_parser_create()</strong>
   * <strong>xml_parser_free()</strong>


id: xml_parser_free
type: function
doc:
<comment>Description:</comment>
  Libera um analisador XML
  
  Esta função não tem efeito. Antes do PHP 8.0.0, esta função era usada para fechar o recurso.
  
  Libera o analisador XML informado em <strong>$parser</strong>.
  
  Além de chamar <strong>xml_parser_free()</strong> quando a análise está terminada, antes do PHP 8.0.0, era
  necessário também explicitamente remover a definição da referência ao analisador informado em
  <strong>$parser</strong> para evitar vazamentos de memória, se o recurso do analisador fosse referenciado de um
  objeto, e este objeto referenciasse o recurso do analisador.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Uma referência para o analisador XML a ser liberado.

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


id: xml_parser_get_option
type: function
doc:
<comment>Description:</comment>
  Obtém as opções de um analisador XML
  
  Obtém um valor de opção de um analisador XML.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Uma referência para o analisador XML do qual a opção será obtida.
  <info>int</info>        <strong>$option</strong>  Qual opção buscar. <info>XML_OPTION_CASE_FOLDING</info>, <info>XML_OPTION_SKIP_TAGSTART</info>,
                      <info>XML_OPTION_SKIP_WHITE</info> e <info>XML_OPTION_TARGET_ENCODING</info> estão disponíveis. Consulte
                      <strong>xml_parser_set_option()</strong> para suas descrições.

<comment>Return:</comment>
  <info>string|int|bool</info>  Retorna o valor da opção.


id: xml_parser_set_option
type: function
doc:
<comment>Description:</comment>
  Define opções em um analisador XML
  
  Define uma opção em uma analisador XML.

<comment>Param:</comment>
  <info>XMLParser</info>        <strong>$parser</strong>  Uma referência ao analisador XML ao qual se deseja definir uma opção.
  <info>int</info>              <strong>$option</strong>  Qual a opção a definir. Veja abaixo.
                            
                            As opções a seguir estão disponíveis: Opções do analisador XMLConstante
                            da opçãoTipo de dadosDescrição<info>XML_OPTION_CASE_FOLDING</info>bool Controla se
                            case-folding está habilitado para este analisador XML. Ativado por
                            padrão. <info>XML_OPTION_SKIP_TAGSTART</info>integer Especifica quantos caracteres
                            devem ser ignorados no início do nome de uma etiqueta.
                            <info>XML_OPTION_SKIP_WHITE</info>bool Controla se deve-se ignorar valores
                            constituídos por espaços em branco. <info>XML_OPTION_TARGET_ENCODING</info>string
                            Define qual codificação de destino será usada neste analisador XML. Por
                            pradrão, é definida com a mesma codificação usada por
                            <strong>xml_parser_create()</strong>. Codificações de destino suportadas são <return>ISO-8859-1</return>,
                            <return>US-ASCII</return> e <return>UTF-8</return>.
  <info>string|int|bool</info>  <strong>$value</strong>   O novo valor da opção.

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


id: xml_set_character_data_handler
type: function
doc:
<comment>Description:</comment>
  Set up character data handler
  
  Sets the character data handler function for the XML parser <strong>$parser</strong>.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   O analisador XML.
  <info>callable</info>   <strong>$handler</strong>  Se <info>null</info> ou uma string vazia for passada, o manipulador será redefinido para
                       seu estado padrão.
                       
                       Se <strong>$handler</strong> for um <info>callable</info>, o callable será definido como o manipulador.
                       
                       Se <strong>$handler</strong> for uma <info>string</info>, ela pode ser o nome de um método de um objet
                       definido com <strong>xml_set_object()</strong>.
                       
                       The signature of the handler must be: <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$data</strong>
                       <strong>$parser</strong> O analisador XML que chama o manipulador. <strong>$data</strong> Character data as a
                       string.
                       
                       O analisador XML que chama o manipulador.
                       
                       Character data as a string.
                       
                       Character data handler is called for every piece of a text in the XML
                       document. It can be called multiple times inside each fragment (e.g. for
                       non-ASCII strings).
  <info>XMLParser</info>  <strong>$parser</strong>   O analisador XML que chama o manipulador.
  <info>string</info>     <strong>$data</strong>     Character data as a string.

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


id: xml_set_default_handler
type: function
doc:
<comment>Description:</comment>
  Set up default handler
  
  Sets the default handler function for the XML parser <strong>$parser</strong>.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   O analisador XML.
  <info>callable</info>   <strong>$handler</strong>  Se <info>null</info> ou uma string vazia for passada, o manipulador será redefinido para
                       seu estado padrão.
                       
                       Se <strong>$handler</strong> for um <info>callable</info>, o callable será definido como o manipulador.
                       
                       Se <strong>$handler</strong> for uma <info>string</info>, ela pode ser o nome de um método de um objet
                       definido com <strong>xml_set_object()</strong>.
                       
                       The signature of the handler must be: <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$data</strong>
                       <strong>$parser</strong> O analisador XML que chama o manipulador. <strong>$data</strong><strong>$data</strong> contains the
                       character data. This may be the XML declaration, document type declaration,
                       entities or other data for which no other handler exists.
                       
                       O analisador XML que chama o manipulador.
                       
                       <strong>$data</strong> contains the character data. This may be the XML declaration, document
                       type declaration, entities or other data for which no other handler exists.
  <info>XMLParser</info>  <strong>$parser</strong>   O analisador XML que chama o manipulador.
  <info>string</info>     <strong>$data</strong>     <strong>$data</strong> contains the character data. This may be the XML declaration, document
                       type declaration, entities or other data for which no other handler exists.

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


id: xml_set_element_handler
type: function
doc:
<comment>Description:</comment>
  Set up start and end element handlers
  
  Sets the element handler functions for the XML <strong>$parser</strong>.
  
  <strong>$start_handler</strong> is called when a new XML element is opened. <strong>$end_handler</strong> is called when an XML
  element is closed.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>         O analisador XML.
  <info>callable</info>   <strong>$start_handler</strong>  Se <info>null</info> ou uma string vazia for passada, o manipulador será redefinido
                             para seu estado padrão.
                             
                             Se <strong>$handler</strong> for um <info>callable</info>, o callable será definido como o
                             manipulador.
                             
                             Se <strong>$handler</strong> for uma <info>string</info>, ela pode ser o nome de um método de um
                             objet definido com <strong>xml_set_object()</strong>.
                             
                             The signature of the handler must be:
                             <info>void</info>start_element_handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$name</strong><info>array</info><strong>$attributes</strong>
                             <strong>$parser</strong> O analisador XML que chama o manipulador. <strong>$name</strong> Contains the
                             name of the element for which this handler is called. If case-folding
                             is in effect for this parser, the element name will be in uppercase
                             letters. <strong>$attributes</strong> An associative array with the element's
                             attributes. The array is empty if the element has no attributes. The
                             keys of this array are the attribute names, the values are the
                             attribute values. Attribute names are case-folded on the same criteria
                             as element names. Attribute values are not case-folded.  The order in
                             which <strong>$attributes</strong> is traversed is identical to the order in which the
                             attributes were declared.
                             
                             O analisador XML que chama o manipulador.
                             
                             Contains the name of the element for which this handler is called. If
                             case-folding is in effect for this parser, the element name will be in
                             uppercase letters.
                             
                             An associative array with the element's attributes. The array is empty
                             if the element has no attributes. The keys of this array are the
                             attribute names, the values are the attribute values. Attribute names
                             are case-folded on the same criteria as element names. Attribute values
                             are not case-folded.
                             
                             The order in which <strong>$attributes</strong> is traversed is identical to the order
                             in which the attributes were declared.
  <info>XMLParser</info>  <strong>$parser</strong>         O analisador XML que chama o manipulador.
  <info>string</info>     <strong>$name</strong>           Contains the name of the element for which this handler is called. If
                             case-folding is in effect for this parser, the element name will be in
                             uppercase letters.
  <info>array</info>      <strong>$attributes</strong>     An associative array with the element's attributes. The array is empty
                             if the element has no attributes. The keys of this array are the
                             attribute names, the values are the attribute values. Attribute names
                             are case-folded on the same criteria as element names. Attribute values
                             are not case-folded.
                             
                             The order in which <strong>$attributes</strong> is traversed is identical to the order
                             in which the attributes were declared.
  <info>callable</info>   <strong>$end_handler</strong>    Se <info>null</info> ou uma string vazia for passada, o manipulador será redefinido
                             para seu estado padrão.
                             
                             Se <strong>$handler</strong> for um <info>callable</info>, o callable será definido como o
                             manipulador.
                             
                             Se <strong>$handler</strong> for uma <info>string</info>, ela pode ser o nome de um método de um
                             objet definido com <strong>xml_set_object()</strong>.
                             
                             The signature of the handler must be:
                             <info>void</info>end_element_handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$name</strong> <strong>$parser</strong> O analisador
                             XML que chama o manipulador. <strong>$name</strong> Contains the name of the element for
                             which this handler is called. If case-folding is in effect for this
                             parser, the element name will be in uppercase letters.
                             
                             O analisador XML que chama o manipulador.
                             
                             Contains the name of the element for which this handler is called. If
                             case-folding is in effect for this parser, the element name will be in
                             uppercase letters.
  <info>XMLParser</info>  <strong>$parser</strong>         O analisador XML que chama o manipulador.
  <info>string</info>     <strong>$name</strong>           Contains the name of the element for which this handler is called. If
                             case-folding is in effect for this parser, the element name will be in
                             uppercase letters.

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


id: xml_set_end_namespace_decl_handler
type: function
doc:
<comment>Description:</comment>
  Set up end namespace declaration handler
  
  Set a handler to be called when leaving the scope of a namespace declaration. This will be called,
  for each namespace declaration, after the handler for the end tag of the element in which the
  namespace was declared.
  
  This event is not supported under libXML, so a registered handler wouldn't be called.

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>   O analisador XML.
  <info>callable</info>      <strong>$handler</strong>  Se <info>null</info> ou uma string vazia for passada, o manipulador será redefinido
                          para seu estado padrão.
                          
                          Se <strong>$handler</strong> for um <info>callable</info>, o callable será definido como o manipulador.
                          
                          Se <strong>$handler</strong> for uma <info>string</info>, ela pode ser o nome de um método de um objet
                          definido com <strong>xml_set_object()</strong>.
                          
                          The signature of the handler must be:
                          handler<info>XMLParser</info><strong>$parser</strong><info>string</info><info>false</info></info><strong>$prefix</strong> <strong>$parser</strong> O analisador XML que
                          chama o manipulador. <strong>$prefix</strong> The prefix is a string used to reference the
                          namespace within an XML object. <info>false</info> if no prefix exists.
                          
                          O analisador XML que chama o manipulador.
                          
                          The prefix is a string used to reference the namespace within an XML
                          object. <info>false</info> if no prefix exists.
  <info>XMLParser</info>     <strong>$parser</strong>   O analisador XML que chama o manipulador.
  <info>string|false</info>  <strong>$prefix</strong>   The prefix is a string used to reference the namespace within an XML
                          object. <info>false</info> if no prefix exists.

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

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


id: xml_set_external_entity_ref_handler
type: function
doc:
<comment>Description:</comment>
  Set up external entity reference handler
  
  Sets the external entity reference handler function for the XML parser <strong>$parser</strong>.

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>             O analisador XML.
  <info>callable</info>      <strong>$handler</strong>            Se <info>null</info> ou uma string vazia for passada, o manipulador será
                                    redefinido para seu estado padrão.
                                    
                                    Se <strong>$handler</strong> for um <info>callable</info>, o callable será definido como o
                                    manipulador.
                                    
                                    Se <strong>$handler</strong> for uma <info>string</info>, ela pode ser o nome de um método de
                                    um objet definido com <strong>xml_set_object()</strong>.
                                    
                                    The signature of the handler must be:
                                    <info>bool</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$open_entity_names</strong><info>string</info><info>false</info></info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><info>false</info></info><strong>$public_id</strong>
                                    <strong>$parser</strong> O analisador XML que chama o manipulador.
                                    <strong>$open_entity_names</strong> A space-separated list of the names of the
                                    entities that are open for the parse of this entity (including
                                    the name of the referenced entity). <strong>$base</strong> This is the base for
                                    resolving the system identifier (<strong>$system_id</strong>) of the external
                                    entity. <strong>$system_id</strong> The system identifier as specified in the
                                    entity declaration. <strong>$public_id</strong> The public identifier as
                                    specified in the entity declaration, or an empty string if none
                                    was specified; the whitespace in the public identifier will have
                                    been normalized as required by the XML spec.
                                    
                                    O analisador XML que chama o manipulador.
                                    
                                    A space-separated list of the names of the entities that are
                                    open for the parse of this entity (including the name of the
                                    referenced entity).
                                    
                                    This is the base for resolving the system identifier
                                    (<strong>$system_id</strong>) of the external entity.
                                    
                                    The system identifier as specified in the entity declaration.
                                    
                                    The public identifier as specified in the entity declaration, or
                                    an empty string if none was specified; the whitespace in the
                                    public identifier will have been normalized as required by the
                                    XML spec.
                                    
                                    The handler should return <info>true</info> if the entity was handled, <info>false</info>
                                    otherwise. When returning <info>false</info> the XML parser will stop parsing
                                    and <strong>xml_get_error_code()</strong> will return
                                    <info>XML_ERROR_EXTERNAL_ENTITY_HANDLING</info>.
  <info>XMLParser</info>     <strong>$parser</strong>             O analisador XML que chama o manipulador.
  <info>string</info>        <strong>$open_entity_names</strong>  A space-separated list of the names of the entities that are
                                    open for the parse of this entity (including the name of the
                                    referenced entity).
  <info>string|false</info>  <strong>$base</strong>               This is the base for resolving the system identifier
                                    (<strong>$system_id</strong>) of the external entity.
  <info>string</info>        <strong>$system_id</strong>          The system identifier as specified in the entity declaration.
  <info>string|false</info>  <strong>$public_id</strong>          The public identifier as specified in the entity declaration, or
                                    an empty string if none was specified; the whitespace in the
                                    public identifier will have been normalized as required by the
                                    XML spec.

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


id: xml_set_notation_decl_handler
type: function
doc:
<comment>Description:</comment>
  Set up notation declaration handler
  
  Sets the notation declaration handler function for the XML parser <strong>$parser</strong>.
  
  A notation declaration is part of the document's DTD and has the following format:     $name</strong>
  { <strong>$systemId</strong> | <strong>$publicId</strong>?>
  ]]> See section 4.7 of the XML 1.0 spec for the definition of notation declarations.

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>         O analisador XML.
  <info>callable</info>      <strong>$handler</strong>        Se <info>null</info> ou uma string vazia for passada, o manipulador será
                                redefinido para seu estado padrão.
                                
                                Se <strong>$handler</strong> for um <info>callable</info>, o callable será definido como o
                                manipulador.
                                
                                Se <strong>$handler</strong> for uma <info>string</info>, ela pode ser o nome de um método de um
                                objet definido com <strong>xml_set_object()</strong>.
                                
                                The signature of the handler must be:
                                <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$notation_name</strong><info>string</info><info>false</info></info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><info>false</info></info><strong>$public_id</strong>
                                <strong>$parser</strong> O analisador XML que chama o manipulador. <strong>$notation_name</strong>
                                This is the notation's name, as per the notation format described
                                above. <strong>$base</strong> This is the base for resolving the system identifier
                                (<return>system_id</return>) of the notation declaration. <strong>$system_id</strong> System
                                identifier of the external notation declaration. <strong>$public_id</strong> Public
                                identifier of the external notation declaration.
                                
                                O analisador XML que chama o manipulador.
                                
                                This is the notation's name, as per the notation format described
                                above.
                                
                                This is the base for resolving the system identifier (<return>system_id</return>) of
                                the notation declaration.
                                
                                System identifier of the external notation declaration.
                                
                                Public identifier of the external notation declaration.
  <info>XMLParser</info>     <strong>$parser</strong>         O analisador XML que chama o manipulador.
  <info>string</info>        <strong>$notation_name</strong>  This is the notation's name, as per the notation format described
                                above.
  <info>string|false</info>  <strong>$base</strong>           This is the base for resolving the system identifier (<return>system_id</return>) of
                                the notation declaration.
  <info>string</info>        <strong>$system_id</strong>      System identifier of the external notation declaration.
  <info>string|false</info>  <strong>$public_id</strong>      Public identifier of the external notation declaration.

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


id: xml_set_object
type: function
doc:
<comment>Description:</comment>
  Use XML Parser within an object
  
  This function allows to use <strong>$parser</strong> inside <strong>$object</strong>. All callback functions could be set with
  <strong>xml_set_element_handler()</strong> etc and assumed to be methods of <strong>$object</strong>.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  A reference to the XML parser to use inside the object.
  <info>object</info>     <strong>$object</strong>  The object where to use the XML parser.

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


id: xml_set_processing_instruction_handler
type: function
doc:
<comment>Description:</comment>
  Set up processing instruction (PI) handler
    
  
  Sets the processing instruction (PI) handler function for the XML parser <strong>$parser</strong>.
  
  A processing instruction has the following format: 
  ]]>
  
  PHP code is delimited by the <return>\<?php</return> processing instruction. As such it is possible to have PHP code within an XML document. However, the PI end tag (<return>?&gt;</return>) must not be part of the data. If a PI end tag exists as part of the embedded PHP code, the rest of the PHP code and the "real" PI end tag, will be treated as character data.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   O analisador XML.
  <info>callable</info>   <strong>$handler</strong>  Se <info>null</info> ou uma string vazia for passada, o manipulador será redefinido para
                       seu estado padrão.
                       
                       Se <strong>$handler</strong> for um <info>callable</info>, o callable será definido como o manipulador.
                       
                       Se <strong>$handler</strong> for uma <info>string</info>, ela pode ser o nome de um método de um objet
                       definido com <strong>xml_set_object()</strong>.
                       
                       The signature of the handler must be:
                       <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$target</strong><info>string</info><strong>$data</strong> <strong>$parser</strong> O analisador XML
                       que chama o manipulador. <strong>$target</strong> The processing instruction target. <strong>$data</strong> The
                       processing instruction data.
                       
                       O analisador XML que chama o manipulador.
                       
                       The processing instruction target.
                       
                       The processing instruction data.
  <info>XMLParser</info>  <strong>$parser</strong>   O analisador XML que chama o manipulador.
  <info>string</info>     <strong>$target</strong>   The processing instruction target.
  <info>string</info>     <strong>$data</strong>     The processing instruction data.

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


id: xml_set_start_namespace_decl_handler
type: function
doc:
<comment>Description:</comment>
  Set up start namespace declaration handler
    
  
  Set a handler to be called when a namespace is declared. Namespace declarations occur inside start
  tags. But the namespace declaration start handler is called before the start tag handler for each
  namespace declared in that start tag.

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>   O analisador XML.
  <info>callable</info>      <strong>$handler</strong>  Se <info>null</info> ou uma string vazia for passada, o manipulador será redefinido
                          para seu estado padrão.
                          
                          Se <strong>$handler</strong> for um <info>callable</info>, o callable será definido como o manipulador.
                          
                          Se <strong>$handler</strong> for uma <info>string</info>, ela pode ser o nome de um método de um objet
                          definido com <strong>xml_set_object()</strong>.
                          
                          The signature of the handler must be:
                          <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><info>false</info></info><strong>$prefix</strong><info>string</info><strong>$uri</strong> <strong>$parser</strong> O
                          analisador XML que chama o manipulador. <strong>$prefix</strong> The prefix is a string
                          used to reference the namespace within an XML object. <info>false</info> if no prefix
                          exists. <strong>$uri</strong> Uniform Resource Identifier (URI) of namespace.
                          
                          O analisador XML que chama o manipulador.
                          
                          The prefix is a string used to reference the namespace within an XML
                          object. <info>false</info> if no prefix exists.
                          
                          Uniform Resource Identifier (URI) of namespace.
  <info>XMLParser</info>     <strong>$parser</strong>   O analisador XML que chama o manipulador.
  <info>string|false</info>  <strong>$prefix</strong>   The prefix is a string used to reference the namespace within an XML
                          object. <info>false</info> if no prefix exists.
  <info>string</info>        <strong>$uri</strong>      Uniform Resource Identifier (URI) of namespace.

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

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


id: xml_set_unparsed_entity_decl_handler
type: function
doc:
<comment>Description:</comment>
  Set up unparsed entity declaration handler
    
  
  Sets the unparsed entity declaration handler function for the XML parser <strong>$parser</strong>.
  
  The <strong>$handler</strong> will be called if the XML parser encounters an external entity declaration with an
  NDATA declaration, like the following: $name</strong> {<strong>$publicId</strong> | <strong>$systemId</strong>} NDATA <strong>$notationName</strong>
  ]]>
  
  See section 4.2.2 of the XML 1.0 spec for the definition of notation declared external entities.

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>         O analisador XML.
  <info>callable</info>      <strong>$handler</strong>        Se <info>null</info> ou uma string vazia for passada, o manipulador será
                                redefinido para seu estado padrão.
                                
                                Se <strong>$handler</strong> for um <info>callable</info>, o callable será definido como o
                                manipulador.
                                
                                Se <strong>$handler</strong> for uma <info>string</info>, ela pode ser o nome de um método de um
                                objet definido com <strong>xml_set_object()</strong>.
                                
                                The signature of the handler must be:
                                <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$entity_name</strong><info>string</info><info>false</info></info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><info>false</info></info><strong>$public_id</strong><info>string</info><info>false</info></info><strong>$notation_name</strong>
                                <strong>$parser</strong> O analisador XML que chama o manipulador. <strong>$entity_name</strong> The
                                name of the entity that is about to be defined. <strong>$base</strong> This is the
                                base for resolving the system identifier (<strong>$systemId</strong>) of the external
                                entity. <strong>$system_id</strong> System identifier for the external entity.
                                <strong>$public_id</strong>  Public identifier for the external entity.
                                <strong>$notation_name</strong>  Name of the notation of this entity (see
                                <strong>xml_set_notation_decl_handler()</strong>).
                                
                                O analisador XML que chama o manipulador.
                                
                                The name of the entity that is about to be defined.
                                
                                This is the base for resolving the system identifier (<strong>$systemId</strong>) of
                                the external entity.
                                
                                System identifier for the external entity.
                                
                                Public identifier for the external entity.
                                
                                Name of the notation of this entity (see
                                <strong>xml_set_notation_decl_handler()</strong>).
  <info>XMLParser</info>     <strong>$parser</strong>         O analisador XML que chama o manipulador.
  <info>string</info>        <strong>$entity_name</strong>    The name of the entity that is about to be defined.
  <info>string|false</info>  <strong>$base</strong>           This is the base for resolving the system identifier (<strong>$systemId</strong>) of
                                the external entity.
  <info>string</info>        <strong>$system_id</strong>      System identifier for the external entity.
  <info>string|false</info>  <strong>$public_id</strong>      Public identifier for the external entity.
  <info>string|false</info>  <strong>$notation_name</strong>  Name of the notation of this entity (see
                                <strong>xml_set_notation_decl_handler()</strong>).

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


id: xmlrpc_decode
type: function
doc:
<comment>Description:</comment>
  Decodifica XML para tipos nativos do PHP
  
  Esta função é
  EXPERIMENTAL. O comportamento desta função, seu nome e
  documentação poderão mudar sem aviso prévio em futuras versões do PHP.
  Use por sua conta e risco.

<comment>Param:</comment>
  <info>string</info>  <strong>$xml</strong>       Resposta XML retornada por método XMLRPC.
  <info>string</info>  <strong>$encoding</strong>  Codificação da entrada suportada por iconv.

<comment>Return:</comment>
  <info>mixed</info>  Retorna ou um array, ou um inteiro, ou uma string, ou um booleano de acordo com a resposta
         retornada via XMLRPC.

<comment>See Also:</comment>
   * <strong>xmlrpc_encode_request()</strong>
   * <strong>xmlrpc_is_fault()</strong>


id: xmlrpc_decode_request
type: function
doc:
<comment>Description:</comment>
  Decodifica XML para tipos nativos do PHP
  
  Esta função é
  EXPERIMENTAL. O comportamento desta função, seu nome e
  documentação poderão mudar sem aviso prévio em futuras versões do PHP.
  Use por sua conta e risco.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>mixed</info>  


id: xmlrpc_encode
type: function
doc:
<comment>Description:</comment>
  Gera XML para um valor do PHP
  
  Esta função é
  EXPERIMENTAL. O comportamento desta função, seu nome e
  documentação poderão mudar sem aviso prévio em futuras versões do PHP.
  Use por sua conta e risco.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: xmlrpc_encode_request
type: function
doc:
<comment>Description:</comment>
  Gera XML para uma requisição de método
  
  Esta função é
  EXPERIMENTAL. O comportamento desta função, seu nome e
  documentação poderão mudar sem aviso prévio em futuras versões do PHP.
  Use por sua conta e risco.

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>          Nome do método a ser chamado.
  <info>mixed</info>   <strong>$params</strong>          Parâmetros do método compatível com assinatura do método.
  <info>array</info>   <strong>$output_options</strong>  Array especificando opções de saída. Pode conter (valores padrão estão em
                           negrito): output_type: php, xmlverbosity: no_white_space, newlines_only,
                           prettyescaping: cdata, non-ascii, non-print, markup (pode ser uma string
                           com um valor ou um array com múltiplos valores)version: simple, xmlrpc,
                           soap 1.1, autoencoding: iso-8859-1, outra codificação suportada por iconv
                           
                           output_type: php, xml
                           
                           verbosity: no_white_space, newlines_only, pretty
                           
                           escaping: cdata, non-ascii, non-print, markup (pode ser uma string com um
                           valor ou um array com múltiplos valores)
                           
                           version: simple, xmlrpc, soap 1.1, auto
                           
                           encoding: iso-8859-1, outra codificação suportada por iconv

<comment>Return:</comment>
  <info>string</info>  Retorna uma string contendo a representação XML da requisição.

<comment>See Also:</comment>
   * <strong>stream_context_create()</strong>
   * <strong>file_get_contents()</strong>
   * <strong>xmlrpc_decode()</strong>


id: xmlrpc_get_type
type: function
doc:
<comment>Description:</comment>
  Obtém o tipo XML-RPC para um valor PHP
  
  Esta função é
  EXPERIMENTAL. O comportamento desta função, seu nome e
  documentação poderão mudar sem aviso prévio em futuras versões do PHP.
  Use por sua conta e risco.
  
  Essa função é especialmente útil para strings datetime e base64.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Valor PHP

<comment>Return:</comment>
  <info>string</info>  Retorna o tipo XML-RPC.

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


id: xmlrpc_is_fault
type: function
doc:
<comment>Description:</comment>
  Determina se um valor de array representa uma falha XML-RPC
  
  Esta função é
  EXPERIMENTAL. O comportamento desta função, seu nome e
  documentação poderão mudar sem aviso prévio em futuras versões do PHP.
  Use por sua conta e risco.

<comment>Param:</comment>
  <info>array</info>  <strong>$arg</strong>  Array retornado por <strong>xmlrpc_decode()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se o argumento significa falha, <info>false</info> caso contrário. Descrição da falha está
        disponível em <return>$arg["faultString"]</return>, código da falha está em <return>$arg["faultCode"]</return>.

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


id: xmlrpc_parse_method_descriptions
type: function
doc:
<comment>Description:</comment>
  Decodifica XML e gera uma lista de descrição de métodos
  
  Esta função é
  EXPERIMENTAL. O comportamento desta função, seu nome e
  documentação poderão mudar sem aviso prévio em futuras versões do PHP.
  Use por sua conta e risco.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: xmlrpc_server_add_introspection_data
type: function
doc:
<comment>Description:</comment>
  Adiciona documentação de introspecção
  
  Esta função é
  EXPERIMENTAL. O comportamento desta função, seu nome e
  documentação poderão mudar sem aviso prévio em futuras versões do PHP.
  Use por sua conta e risco.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: xmlrpc_server_call_method
type: function
doc:
<comment>Description:</comment>
  Trata requisiçães de XML e chamadas de métodos
  
  Esta função é
  EXPERIMENTAL. O comportamento desta função, seu nome e
  documentação poderão mudar sem aviso prévio em futuras versões do PHP.
  Use por sua conta e risco.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: xmlrpc_server_create
type: function
doc:
<comment>Description:</comment>
  Cria um servidor xmlrpc
  
  Esta função é
  EXPERIMENTAL. O comportamento desta função, seu nome e
  documentação poderão mudar sem aviso prévio em futuras versões do PHP.
  Use por sua conta e risco.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: xmlrpc_server_destroy
type: function
doc:
<comment>Description:</comment>
  Destrói recursos de servidor
  
  Esta função é
  EXPERIMENTAL. O comportamento desta função, seu nome e
  documentação poderão mudar sem aviso prévio em futuras versões do PHP.
  Use por sua conta e risco.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: xmlrpc_server_register_introspection_callback
type: function
doc:
<comment>Description:</comment>
  Registra uma função do PHP para gerar documentação
  
  Esta função é
  EXPERIMENTAL. O comportamento desta função, seu nome e
  documentação poderão mudar sem aviso prévio em futuras versões do PHP.
  Use por sua conta e risco.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: xmlrpc_server_register_method
type: function
doc:
<comment>Description:</comment>
  Registra uma função do PHP para o método com nome method_name
  
  Esta função é
  EXPERIMENTAL. O comportamento desta função, seu nome e
  documentação poderão mudar sem aviso prévio em futuras versões do PHP.
  Use por sua conta e risco.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: xmlrpc_set_type
type: function
doc:
<comment>Description:</comment>
  Sets xmlrpc type, base64 or datetime, for a PHP string value
  
  Sets xmlrpc type, base64 or datetime, for a PHP string value.
  
  Esta função é
  EXPERIMENTAL. O comportamento desta função, seu nome e
  documentação poderão mudar sem aviso prévio em futuras versões do PHP.
  Use por sua conta e risco.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Value to set the type
  <info>string</info>  <strong>$type</strong>   'base64' or 'datetime'

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. If successful, <strong>$value</strong> is
        converted to an object.


id: yaml_emit
type: function
doc:
<comment>Description:</comment>
  Returns the YAML representation of a value
  
  Generate a YAML representation of the provided <strong>$data</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$data</strong>       The <strong>$data</strong> being encoded. Can be any type except a <info>resource</info>.
  <info>int</info>    <strong>$encoding</strong>   Output character encoding chosen from <info>YAML_ANY_ENCODING</info>, <info>YAML_UTF8_ENCODING</info>,
                     <info>YAML_UTF16LE_ENCODING</info>, <info>YAML_UTF16BE_ENCODING</info>.
  <info>int</info>    <strong>$linebreak</strong>  Output linebreak style chosen from <info>YAML_ANY_BREAK</info>, <info>YAML_CR_BREAK</info>,
                     <info>YAML_LN_BREAK</info>, <info>YAML_CRLN_BREAK</info>.
  <info>array</info>  <strong>$callbacks</strong>  Content handlers for emitting YAML nodes. Associative <info>array</info> of classname =&gt;
                     <info>callable</info> mappings. See emit callbacks for more details.

<comment>Return:</comment>
  <info>string</info>  Returns a YAML encoded <info>string</info> on success.

<comment>See Also:</comment>
   * <strong>yaml_emit_file()</strong>
   * <strong>yaml_parse()</strong>


id: yaml_emit_file
type: function
doc:
<comment>Description:</comment>
  Send the YAML representation of a value to a file
  
  Generate a YAML representation of the provided <strong>$data</strong> in the <strong>$filename</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>   Path to the file.
  <info>mixed</info>   <strong>$data</strong>       The <strong>$data</strong> being encoded. Can be any type except a <info>resource</info>.
  <info>int</info>     <strong>$encoding</strong>   Output character encoding chosen from <info>YAML_ANY_ENCODING</info>, <info>YAML_UTF8_ENCODING</info>,
                      <info>YAML_UTF16LE_ENCODING</info>, <info>YAML_UTF16BE_ENCODING</info>.
  <info>int</info>     <strong>$linebreak</strong>  Output linebreak style chosen from <info>YAML_ANY_BREAK</info>, <info>YAML_CR_BREAK</info>,
                      <info>YAML_LN_BREAK</info>, <info>YAML_CRLN_BREAK</info>.
  <info>array</info>   <strong>$callbacks</strong>  Content handlers for emitting YAML nodes. Associative <info>array</info> of classname =&gt;
                      <info>callable</info> mappings. See emit callbacks for more details.

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

<comment>See Also:</comment>
   * <strong>yaml_emit()</strong>
   * <strong>yaml_parse()</strong>


id: yaml_parse
type: function
doc:
<comment>Description:</comment>
  Parse a YAML stream
  
  Convert all or part of a YAML document stream to a PHP variable.

<comment>Param:</comment>
  <info>string</info>  <strong>$input</strong>      The <info>string</info> to parse as a YAML document stream.
  <info>int</info>     <strong>$pos</strong>        Document to extract from stream (<return>-1</return> for all documents, <return>0</return> for first document,
                      ...).
  <info>int</info>     <strong>$ndocs</strong>      If <strong>$ndocs</strong> is provided, then it is filled with the number of documents found in
                      stream.
  <info>array</info>   <strong>$callbacks</strong>  Content handlers for YAML nodes. Associative <info>array</info> of YAML tag =&gt; <info>callable</info>
                      mappings. See parse callbacks for more details.

<comment>Return:</comment>
  <info>mixed</info>  Returns the value encoded in <strong>$input</strong> in appropriate PHP type ou <info>false</info> em caso de falha. If
         <strong>$pos</strong> is <return>-1</return> an <info>array</info> will be returned with one entry for each document found in the stream.

<comment>See Also:</comment>
   * <strong>yaml_parse_file()</strong>
   * <strong>yaml_parse_url()</strong>
   * <strong>yaml_emit()</strong>


id: yaml_parse_file
type: function
doc:
<comment>Description:</comment>
  Parse a YAML stream from a file
  
  Convert all or part of a YAML document stream read from a file to a PHP variable.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>   Path to the file.
  <info>int</info>     <strong>$pos</strong>        Document to extract from stream (<return>-1</return> for all documents, <return>0</return> for first document,
                      ...).
  <info>int</info>     <strong>$ndocs</strong>      If <strong>$ndocs</strong> is provided, then it is filled with the number of documents found in
                      stream.
  <info>array</info>   <strong>$callbacks</strong>  Content handlers for YAML nodes. Associative <info>array</info> of YAML tag =&gt; <info>callable</info>
                      mappings. See parse callbacks for more details.

<comment>Return:</comment>
  <info>mixed</info>  Returns the value encoded in <strong>$input</strong> in appropriate PHP type ou <info>false</info> em caso de falha. If
         <strong>$pos</strong> is <return>-1</return> an <info>array</info> will be returned with one entry for each document found in the stream.

<comment>See Also:</comment>
   * <strong>yaml_parse()</strong>
   * <strong>yaml_parse_url()</strong>
   * <strong>yaml_emit()</strong>


id: yaml_parse_url
type: function
doc:
<comment>Description:</comment>
  Parse a Yaml stream from a URL
  
  Convert all or part of a YAML document stream read from a URL to a PHP variable.

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>        <strong>$url</strong> should be of the form "scheme://...". PHP will search for a protocol
                      handler (also known as a wrapper) for that scheme. If no wrappers for that
                      protocol are registered, PHP will emit a notice to help you track potential
                      problems in your script and then continue as though filename specifies a
                      regular file.
  <info>int</info>     <strong>$pos</strong>        Document to extract from stream (<return>-1</return> for all documents, <return>0</return> for first document,
                      ...).
  <info>int</info>     <strong>$ndocs</strong>      If <strong>$ndocs</strong> is provided, then it is filled with the number of documents found in
                      stream.
  <info>array</info>   <strong>$callbacks</strong>  Content handlers for YAML nodes. Associative <info>array</info> of YAML tag =&gt; <info>callable</info>
                      mappings. See parse callbacks for more

<comment>Return:</comment>
  <info>mixed</info>  Returns the value encoded in <strong>$input</strong> in appropriate PHP type ou <info>false</info> em caso de falha. If
         <strong>$pos</strong> is <return>-1</return> an <info>array</info> will be returned with one entry for each document found in the stream.

<comment>See Also:</comment>
   * <strong>yaml_parse()</strong>
   * <strong>yaml_parse_file()</strong>
   * <strong>yaml_emit()</strong>


id: yaz_addinfo
type: function
doc:
<comment>Description:</comment>
  Returns additional error information
  
  Returns additional error information for the last request on the server.
  
  With some servers, this function may return the same string as  <strong>yaz_error()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  The connection resource returned by <strong>yaz_connect()</strong>.

<comment>Return:</comment>
  <info>string</info>  A string containing additional error information or an empty string if the last operation
          was successful or if no additional information was provided by the server.

<comment>See Also:</comment>
   * <strong>yaz_error()</strong>
   * <strong>yaz_errno()</strong>


id: yaz_ccl_conf
type: function
doc:
<comment>Description:</comment>
  Configure CCL parser
  
  This function configures the CCL query parser for a server with  definitions of access points (CCL
  qualifiers) and their mapping to RPN.
  
  To map a specific CCL query to RPN afterwards call the  <strong>yaz_ccl_parse()</strong> function.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      The connection resource returned by <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$config</strong>  An array of configuration. Each key of the array is the name of a CCL field and
                     the corresponding value holds a string that specifies a  mapping to RPN.
                     
                     The mapping is a sequence of attribute-type, attribute-value pairs.
                     Attribute-type and attribute-value is separated by an equal sign  (<return>=</return>). Each
                     pair is separated by white space.
                     
                     Additional information can be found on the CCL page.

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

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


id: yaz_ccl_parse
type: function
doc:
<comment>Description:</comment>
  Invoke CCL Parser
  
  This function invokes a CCL parser. It converts a given CCL FIND query to an RPN query which may
  be passed to the <strong>yaz_search()</strong>  function to perform a search.
  
  To define a set of valid CCL fields call <strong>yaz_ccl_conf()</strong>  prior to this function.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      The connection resource returned by <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$query</strong>   The CCL FIND query.
  <info>array</info>     <strong>$result</strong>  If the function was executed successfully, this will be an array  containing
                     the valid RPN query under the key <return>rpn</return>.
                     
                     Upon failure, three indexes are set in this array to indicate the cause of
                     failure:  <return>errorcode</return> - the CCL error code (integer) <return>errorstring</return> - the CCL error
                     string <return>errorpos</return> - approximate position in query of failure (integer is
                     character position)
                     
                     <return>errorcode</return> - the CCL error code (integer)
                     
                     <return>errorstring</return> - the CCL error string
                     
                     <return>errorpos</return> - approximate position in query of failure (integer is character
                     position)

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


