# php_manual

id: APCUIterator
type: class
doc:
<comment>Description:</comment>
  The <class>APCUIterator</class> class makes it easier to iterate over large APCu caches. This is helpful as it
  allows iterating over large caches in steps, while grabbing a defined number of entries per lock
  instance, so it frees the cache locks for other activities rather than hold up the entire cache to
  grab 100 (the default) entries. Also, using regular expression matching is more efficient as it's
  been moved to the C level.


id: APCUIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs an APCUIterator iterator object
  
  Constructs an <class>APCUIterator</class> <info>object</info>.

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$search</strong>      Either a PCRE regular expression that matches against APCu key
                                  names, given as a <info>string</info>. Or an <info>array</info> of <info>string</info>s with APCu key
                                  names. Or, optionally <info>null</info> to skip the search.
  <info>int</info>                <strong>$format</strong>      The desired format, as configured with one or more of the
                                  APC_ITER_* constants.
  <info>int</info>                <strong>$chunk_size</strong>  The chunk size. Must be a value greater than 0. The default value
                                  is 100.
  <info>int</info>                <strong>$list</strong>        The type to list. Either pass in <info>APC_LIST_ACTIVE</info> or
                                  <info>APC_LIST_DELETED</info>.

<comment>See Also:</comment>
   * <strong>apcu_exists()</strong>
   * <strong>apcu_cache_info()</strong>


id: APCUIterator::current
type: function
doc:
<comment>Description:</comment>
  Get current item
  
  Gets the current item from the <class>APCUIterator</class> stack.

<comment>Return:</comment>
  <info>mixed</info>  Returns the current item on success, or <info>false</info> if no more items or exist, or on failure.

<comment>See Also:</comment>
   * APCUIterator::next
   * Iterator::current


id: APCUIterator::getTotalCount
type: function
doc:
<comment>Description:</comment>
  Get total count
  
  Get the total count.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  The total count.

<comment>See Also:</comment>
   * APCUIterator::getTotalHits
   * APCUIterator::getTotalSize
   * <strong>apcu_cache_info()</strong>


id: APCUIterator::getTotalHits
type: function
doc:
<comment>Description:</comment>
  Get total cache hits
  
  Gets the total number of cache hits.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  The number of hits on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * APCUIterator::getTotalCount
   * APCUIterator::getTotalSize
   * <strong>apcu_cache_info()</strong>


id: APCUIterator::getTotalSize
type: function
doc:
<comment>Description:</comment>
  Get total cache size
  
  Gets the total cache size.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  The total cache size.

<comment>See Also:</comment>
   * APCUIterator::getTotalCount
   * APCUIterator::getTotalHits
   * <strong>apc_cache_info()</strong>


id: APCUIterator::key
type: function
doc:
<comment>Description:</comment>
  Get iterator key
  
  Gets the current iterator key.

<comment>Return:</comment>
  <info>string</info>  Returns the key on success, or <info>false</info> upon failure.

<comment>See Also:</comment>
   * APCUIterator::current
   * Iterator::key


id: APCUIterator::next
type: function
doc:
<comment>Description:</comment>
  Move pointer to next item
  
  Moves the iterator pointer to the next element.

<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>
   * APCUIterator::current
   * APCUIterator::rewind
   * Iterator::next


id: APCUIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewinds iterator
  
  Rewinds back the iterator to the first element.

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

<comment>See Also:</comment>
   * APCUIterator::next
   * Iterator::next


id: APCUIterator::valid
type: function
doc:
<comment>Description:</comment>
  Checks if current position is valid
  
  Checks if the current iterator position is valid.

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

<comment>See Also:</comment>
   * APCUIterator::current
   * Iterator::valid


id: ARRAY_FILTER_USE_BOTH
type: constant
doc:
<comment>Description:</comment>
  <info>ARRAY_FILTER_USE_BOTH</info> é utilizado com a função <strong>array_filter()</strong> para passar tanto chave, quanto
  valor, para a função callback informada.


id: ARRAY_FILTER_USE_KEY
type: constant
doc:
<comment>Description:</comment>
  <info>ARRAY_FILTER_USE_KEY</info> é utilizado com a função <strong>array_filter()</strong> para passar cada chave como primeiro
  argumento de uma função callback informada.


id: ASSERT_ACTIVE
type: constant
doc:
<comment>Description:</comment>
  assert.active
  
  Enable <strong>assert()</strong> evaluation. Este recurso tornou-se
  OBSOLETO a partir do PHP 8.3.0. O uso deste recurso
  é fortemente desencorajado.


id: ASSERT_BAIL
type: constant
doc:
<comment>Description:</comment>
  assert.bail
  
  Terminate execution on failed assertions. Este recurso tornou-se
  OBSOLETO a partir do PHP 8.3.0. O uso deste recurso
  é fortemente desencorajado.


id: ASSERT_CALLBACK
type: constant
doc:
<comment>Description:</comment>
  assert.callback
  
  Callback to call on failed assertions. Este recurso tornou-se
  OBSOLETO a partir do PHP 8.3.0. O uso deste recurso
  é fortemente desencorajado.


id: ASSERT_EXCEPTION
type: constant
doc:
<comment>Description:</comment>
  assert.exception
  
  Issues a PHP warning for each failed assertion Este recurso tornou-se
  OBSOLETO a partir do PHP 8.3.0. O uso deste recurso
  é fortemente desencorajado.


id: ASSERT_QUIET_EVAL
type: constant
doc:
<comment>Description:</comment>
  assert.quiet_eval
  
  Disable <return>error_reporting</return> during assertion expression evaluation. Este recurso foi REMOVIDO a partir
  do PHP 8.0.0.


id: ASSERT_WARNING
type: constant
doc:
<comment>Description:</comment>
  assert.warning
  
  Issues a PHP warning for each failed assertion Este recurso tornou-se
  OBSOLETO a partir do PHP 8.3.0. O uso deste recurso
  é fortemente desencorajado.


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


id: AllowDynamicProperties
type: class
doc:
<comment>Description:</comment>
  Este atributo é usado para marcar classes que permitem propriedades dinâmicas.


id: AllowDynamicProperties::__construct
type: function
doc:
<comment>Description:</comment>
  Constrói uma nova instância do atributo AllowDynamicProperties
  
  Constrói uma nova instância de <class>AllowDynamicProperties</class>.


id: AppendIterator
type: class
doc:
<comment>Description:</comment>
  An Iterator that iterates over several iterators one after the other.


id: AppendIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs an AppendIterator
  
  Constructs an AppendIterator.

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


id: AppendIterator::append
type: function
doc:
<comment>Description:</comment>
  Appends an iterator
  
  Appends an iterator.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  The iterator to append.

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

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


id: AppendIterator::current
type: function
doc:
<comment>Description:</comment>
  Gets the current value
  
  Gets the current value.

<comment>Return:</comment>
  <info>mixed</info>  The current value if it is valid or <info>null</info> otherwise.

<comment>See Also:</comment>
   * Iterator::current
   * AppendIterator::key
   * AppendIterator::valid
   * AppendIterator::next
   * AppendIterator::rewind


id: AppendIterator::getArrayIterator
type: function
doc:
<comment>Description:</comment>
  Gets the ArrayIterator
  
  This method gets the <class>ArrayIterator</class> that is used to  store the iterators added with
  AppendIterator::append.

<comment>Return:</comment>
  <info>ArrayIterator</info>  Returns an <class>ArrayIterator</class> containing the appended iterators.

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


id: AppendIterator::getIteratorIndex
type: function
doc:
<comment>Description:</comment>
  Gets an index of iterators
  
  Gets the index of the current inner iterator.

<comment>Return:</comment>
  <info>int|null</info>  Returns the zero-based, integer index of the current inner iterator if it exists, or
            <info>null</info> otherwise.

<comment>See Also:</comment>
   * AppendIterator::getInnerIterator
   * AppendIterator::getArrayIterator


id: AppendIterator::key
type: function
doc:
<comment>Description:</comment>
  Gets the current key
  
  Get the current key.

<comment>Return:</comment>
  <info>scalar</info>  The current key if it is valid or <info>null</info> otherwise.

<comment>See Also:</comment>
   * Iterator::key
   * AppendIterator::current
   * AppendIterator::valid
   * AppendIterator::next
   * AppendIterator::rewind


id: AppendIterator::next
type: function
doc:
<comment>Description:</comment>
  Moves to the next element
  
  Moves to the next element. If this means to another Iterator then it rewinds that Iterator.

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

<comment>See Also:</comment>
   * Iterator::next
   * AppendIterator::current
   * AppendIterator::key
   * AppendIterator::valid
   * AppendIterator::rewind


id: AppendIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewinds the Iterator
  
  Rewind to the first element of the first inner Iterator.

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

<comment>See Also:</comment>
   * Iterator::rewind
   * AppendIterator::current
   * AppendIterator::key
   * AppendIterator::next
   * AppendIterator::valid


id: AppendIterator::valid
type: function
doc:
<comment>Description:</comment>
  Checks validity of the current element
  
  Checks validity of the current element.

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

<comment>See Also:</comment>
   * AppendIterator::current
   * AppendIterator::key
   * AppendIterator::next
   * AppendIterator::rewind


id: ArrayAccess::offsetExists
type: function
doc:
<comment>Description:</comment>
  Verifica se uma posição existe
  
  Verifica se uma posição existe ou não.
  
  Este método é executado ao utilizar-se a função <strong>isset()</strong> ou <strong>empty()</strong> em objetos que implementem
  <class>ArrayAccess</class>.
  
  Ao utilizar a função <strong>empty()</strong>, o método <strong>ArrayAccess::offsetGet()</strong> será chamado e checado por vazio
  somente se o método <strong>ArrayAccess::offsetExists()</strong> retornar <info>true</info>

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  Uma posição a ser checada.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
        
        O valor de retorno será convertido para <info>bool</info> se um não booleano for retornado.


id: ArrayAccess::offsetGet
type: function
doc:
<comment>Description:</comment>
  Posição a ser obtida
  
  Retorna o valor de uma posição específica.
  
  Este método é executado ao checar se uma posição está vazia, com a função <strong>empty()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  A posição a ser obtida.

<comment>Return:</comment>
  <info>mixed</info>  Pode retornar valores de qualquer tipo.

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


id: ArrayAccess::offsetSet
type: function
doc:
<comment>Description:</comment>
  Atribui um valor a uma posição específica
  
  Atribui um valor a uma posição específica.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  A posição na qual se deseja atribuir um valor.
  <info>mixed</info>  <strong>$value</strong>   O valor a ser atribuído.

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


id: ArrayAccess::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Remove uma posição
  
  Destrói uma posição.
  
  Este método não será chamado ao se fazer conversão de tipo com (unset)

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  A posição a ser removida.

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


id: ArrayIterator
type: class
doc:
<comment>Description:</comment>
  Permite a remoção de elementos, e a modificação de chaves e valores enquanto iterando sobre arrays
  ou objetos.
  
  Quando você quiser iterar o mesmo array múltiplas vezes você precisa instanciar ArrayObject e
  criar instâncias de ArrayIterator que é consultado usando foreach ou chamando o método
  getIterator() diretamente.


id: ArrayIterator::STD_PROP_LIST
type: constant
doc:
<comment>Description:</comment>
  As propriedades de objeto tem sua funcionalidade normal quando acessados via listagem (var_dump,
  foreach, etc.).


id: ArrayIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construct an ArrayIterator
  
  Constructs an <class>ArrayIterator</class> <info>object</info>.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  The array or object to be iterated on.
  <info>int</info>           <strong>$flags</strong>  Flags to control the behaviour of the <class>ArrayIterator</class> object. See
                        ArrayIterator::setFlags.

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


id: ArrayIterator::append
type: function
doc:
<comment>Description:</comment>
  Append an element
  
  Appends value as the last element.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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

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

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


id: ArrayIterator::asort
type: function
doc:
<comment>Description:</comment>
  Sort entries by values
  
  Sorts entries by their values.
  
  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.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  O segundo parâmetro opcional <strong>$flags</strong> pode ser usado para modificar o comportamento da
               ordenação usando estes valores:
               
               Flags dos tipos de ordenação: <info>SORT_REGULAR</info> - compara os elementos normalmente; os
               detalhes são descritos na seção operadores de comparação<info>SORT_NUMERIC</info> - compara os
               elementos numericamente<info>SORT_STRING</info> - compara os elementos como
               strings<info>SORT_LOCALE_STRING</info> - compara os elementos como strings, com base na localidade
               atual. A localidade pode ser alterada usando <strong>setlocale()</strong> <info>SORT_NATURAL</info> - compara os
               elementos como strings usando "ordenação natural" como <strong>natsort()</strong> <info>SORT_FLAG_CASE</info> -
               pode ser combinada (usando o operador bit a bit OR) com <info>SORT_STRING</info> ou <info>SORT_NATURAL</info>
               para ordenar strings sem fazer distinção entre maiúsculas e minúsculas
               
               <info>SORT_REGULAR</info> - compara os elementos normalmente; os detalhes são descritos na seção
               operadores de comparação
               
               <info>SORT_NUMERIC</info> - compara os elementos numericamente
               
               <info>SORT_STRING</info> - compara os elementos como strings
               
               <info>SORT_LOCALE_STRING</info> - compara os elementos como strings, com base na localidade atual.
               A localidade pode ser alterada usando <strong>setlocale()</strong>
               
               <info>SORT_NATURAL</info> - compara os elementos como strings usando "ordenação natural" como
               <strong>natsort()</strong>
               
               <info>SORT_FLAG_CASE</info> - pode ser combinada (usando o operador bit a bit OR) com <info>SORT_STRING</info>
               ou <info>SORT_NATURAL</info> para ordenar strings sem fazer distinção entre maiúsculas e
               minúsculas

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

<comment>See Also:</comment>
   * ArrayIterator::ksort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>asort()</strong>


id: ArrayIterator::count
type: function
doc:
<comment>Description:</comment>
  Conta os elementos
  
  Retorna o número de elementos no <info>array</info>, ou o número de atributos públicos no <info>object</info>.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  O número de elementos ou atributos públicos no <info>array</info> ou <info>object</info>, respectivamente.

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


id: ArrayIterator::current
type: function
doc:
<comment>Description:</comment>
  Retorna o valor do elemento atual do array
  
  Obtém o atual elemento do <info>array</info>

<comment>Return:</comment>
  <info>mixed</info>  O atual elemento do <info>array</info>.


id: ArrayIterator::getArrayCopy
type: function
doc:
<comment>Description:</comment>
  Get array copy
  
  Get a copy of an array.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>array</info>  A copy of the <info>array</info>, or array of public properties if ArrayIterator refers to an <info>object</info>.

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


id: ArrayIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  Retorna as flags de comportamento
  
  Retorna as flags de comportamento do <class>ArrayIterator</class>. Veja o método ArrayIterator::setFlags para
  saber as flags disponíveis.

<comment>Return:</comment>
  <info>int</info>  Retorna as flags de comportamento do ArrayIterator.

<comment>See Also:</comment>
   * ArrayIterator::setFlags
   * ArrayIterator::valid


id: ArrayIterator::key
type: function
doc:
<comment>Description:</comment>
  Retorna a chave do elemento atual do array
  
  Esta função retorna a chave do elemento atual do array

<comment>Return:</comment>
  <info>string|int|null</info>  A chave do atual elemento do <info>array</info>.


id: ArrayIterator::ksort
type: function
doc:
<comment>Description:</comment>
  Sort entries by keys
  
  Sorts entries by their keys.
  
  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.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  O segundo parâmetro opcional <strong>$flags</strong> pode ser usado para modificar o comportamento da
               ordenação usando estes valores:
               
               Flags dos tipos de ordenação: <info>SORT_REGULAR</info> - compara os elementos normalmente; os
               detalhes são descritos na seção operadores de comparação<info>SORT_NUMERIC</info> - compara os
               elementos numericamente<info>SORT_STRING</info> - compara os elementos como
               strings<info>SORT_LOCALE_STRING</info> - compara os elementos como strings, com base na localidade
               atual. A localidade pode ser alterada usando <strong>setlocale()</strong> <info>SORT_NATURAL</info> - compara os
               elementos como strings usando "ordenação natural" como <strong>natsort()</strong> <info>SORT_FLAG_CASE</info> -
               pode ser combinada (usando o operador bit a bit OR) com <info>SORT_STRING</info> ou <info>SORT_NATURAL</info>
               para ordenar strings sem fazer distinção entre maiúsculas e minúsculas
               
               <info>SORT_REGULAR</info> - compara os elementos normalmente; os detalhes são descritos na seção
               operadores de comparação
               
               <info>SORT_NUMERIC</info> - compara os elementos numericamente
               
               <info>SORT_STRING</info> - compara os elementos como strings
               
               <info>SORT_LOCALE_STRING</info> - compara os elementos como strings, com base na localidade atual.
               A localidade pode ser alterada usando <strong>setlocale()</strong>
               
               <info>SORT_NATURAL</info> - compara os elementos como strings usando "ordenação natural" como
               <strong>natsort()</strong>
               
               <info>SORT_FLAG_CASE</info> - pode ser combinada (usando o operador bit a bit OR) com <info>SORT_STRING</info>
               ou <info>SORT_NATURAL</info> para ordenar strings sem fazer distinção entre maiúsculas e
               minúsculas

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>ksort()</strong>


id: ArrayIterator::natcasesort
type: function
doc:
<comment>Description:</comment>
  Sort entries naturally, case insensitive
  
  Sort the entries by values using a case insensitive "natural order" algorithm.
  
  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.

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>natcasesort()</strong>


id: ArrayIterator::natsort
type: function
doc:
<comment>Description:</comment>
  Sort entries naturally
  
  Sort the entries by values using a "natural order" algorithm.
  
  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.

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>natsort()</strong>


id: ArrayIterator::next
type: function
doc:
<comment>Description:</comment>
  Avança para o próximo elemento
  
  O iterador para o próximo elemento do array.

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


id: ArrayIterator::offsetExists
type: function
doc:
<comment>Description:</comment>
  Check if offset exists
  
  Checks if the offset exists.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  The offset being checked.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the offset exists, otherwise <info>false</info>

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


id: ArrayIterator::offsetGet
type: function
doc:
<comment>Description:</comment>
  Get value for an offset
  
  Gets the value from the provided offset.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  The offset to get the value from.

<comment>Return:</comment>
  <info>mixed</info>  The value at offset <strong>$key</strong>.

<comment>See Also:</comment>
   * ArrayIterator::offsetSet
   * ArrayIterator::offsetUnset


id: ArrayIterator::offsetSet
type: function
doc:
<comment>Description:</comment>
  Set value for an offset
  
  Sets a value for a given offset.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>    The index to set for.
  <info>mixed</info>  <strong>$value</strong>  The new value to store at the index.

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

<comment>See Also:</comment>
   * ArrayIterator::offsetGet
   * ArrayIterator::offsetUnset


id: ArrayIterator::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Unset value for an offset
  
  Unsets a value for an offset.
  
  If iteration is in progress, and ArrayIterator::offsetUnset is used to unset the current index of
  iteration, the iteration position will be advanced to the next index. Since the iteration position
  is also advanced at the end of a foreach loop body, use of ArrayIterator::offsetUnset inside a
  <return>foreach</return> loop may result in indices being skipped.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  The offset to unset.

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

<comment>See Also:</comment>
   * ArrayIterator::offsetGet
   * ArrayIterator::offsetSet


id: ArrayIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Recoloca o array no início
  
  Esta função recoloca o iterador no início do array.

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


id: ArrayIterator::seek
type: function
doc:
<comment>Description:</comment>
  Aponta para determinada posição
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  A posição para qual quer apontar.

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


id: ArrayIterator::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize
  
  Serialize.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>string</info>  The serialized <class>ArrayIterator</class>.

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


id: ArrayIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  Define as flags que irão alterar o comportamento
  
  Define as flags que alteram o comportamento do ArrayIterator

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  O novo comportamento do ArrayIterator. Pode ser utilizado bitmask ou constantes. O
               uso de constantes é fortemente encorajado para garantir compatibilidade com versões
               futuras.
               
               As flags disponíveis estão listadas abaixo. O atual significado das flags estão
               descritas nas constantes pré-definidas. Flags do comportamento do
               ArrayIteratorvalueconstant1ArrayIterator::STD_PROP_LIST2ArrayIterator::ARRAY_AS_PROPS

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

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


id: ArrayIterator::uasort
type: function
doc:
<comment>Description:</comment>
  Sort with a user-defined comparison function and maintain index association
  
  This method sorts the elements such that indices maintain their correlation with the values they
  are associated with, using a user-defined comparison function.
  
  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.

<comment>Param:</comment>
  <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>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uksort
   * <strong>uasort()</strong>


id: ArrayIterator::uksort
type: function
doc:
<comment>Description:</comment>
  Sort by keys using a user-defined comparison function
  
  This method sorts the elements by keys using a user-supplied comparison function.
  
  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.

<comment>Param:</comment>
  <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>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uksort
   * <strong>uksort()</strong>


id: ArrayIterator::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize
  
  Unserialize.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized ArrayIterator object to be unserialized.

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

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


id: ArrayIterator::valid
type: function
doc:
<comment>Description:</comment>
  Verifica se o array possui mais elementos
  
  Verifica se o <info>array</info> possui mais algum elemento.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se o iterador for válido, caso contrário <info>false</info>


id: ArrayObject::ARRAY_AS_PROPS
type: constant
doc:
<comment>Description:</comment>
  Entries can be accessed as properties (read and write). The <class>ArrayObject</class> class uses its own logic
  to access properties, thus no warning or error is raised when trying to read or write dynamic
  properties.


id: ArrayObject::STD_PROP_LIST
type: constant
doc:
<comment>Description:</comment>
  Properties of the object have their normal functionality when accessed as list (<strong>var_dump()</strong>,
  foreach, etc.).


id: ArrayObject::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new array object
  
  This constructs a new array <info>object</info>.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>          The <strong>$array</strong> parameter accepts an  <info>array</info> or an <info>Object</info>.
  <info>int</info>           <strong>$flags</strong>          Flags to control the behaviour of the <class>ArrayObject</class> object. See
                                ArrayObject::setFlags.
  <info>string</info>        <strong>$iteratorClass</strong>  Specify the class that will be used for iteration of the <class>ArrayObject</class>
                                object. The class must implement ArrayIterator.

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


id: ArrayObject::append
type: function
doc:
<comment>Description:</comment>
  Appends the value
  
  Appends a new value as the last element.
  
  This method cannot be called when the <class>ArrayObject</class> was constructed from an object. Use
  ArrayObject::offsetSet instead.

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

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

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


id: ArrayObject::asort
type: function
doc:
<comment>Description:</comment>
  Sort the entries by value
  
  Sorts the entries in ascending order, such that its keys maintain their correlation with the
  values they are associated with.
  
  This is used mainly when sorting associative arrays where the actual element order is significant.
  
  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.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  O segundo parâmetro opcional <strong>$flags</strong> pode ser usado para modificar o comportamento da
               ordenação usando estes valores:
               
               Flags dos tipos de ordenação: <info>SORT_REGULAR</info> - compara os elementos normalmente; os
               detalhes são descritos na seção operadores de comparação<info>SORT_NUMERIC</info> - compara os
               elementos numericamente<info>SORT_STRING</info> - compara os elementos como
               strings<info>SORT_LOCALE_STRING</info> - compara os elementos como strings, com base na localidade
               atual. A localidade pode ser alterada usando <strong>setlocale()</strong> <info>SORT_NATURAL</info> - compara os
               elementos como strings usando "ordenação natural" como <strong>natsort()</strong> <info>SORT_FLAG_CASE</info> -
               pode ser combinada (usando o operador bit a bit OR) com <info>SORT_STRING</info> ou <info>SORT_NATURAL</info>
               para ordenar strings sem fazer distinção entre maiúsculas e minúsculas
               
               <info>SORT_REGULAR</info> - compara os elementos normalmente; os detalhes são descritos na seção
               operadores de comparação
               
               <info>SORT_NUMERIC</info> - compara os elementos numericamente
               
               <info>SORT_STRING</info> - compara os elementos como strings
               
               <info>SORT_LOCALE_STRING</info> - compara os elementos como strings, com base na localidade atual.
               A localidade pode ser alterada usando <strong>setlocale()</strong>
               
               <info>SORT_NATURAL</info> - compara os elementos como strings usando "ordenação natural" como
               <strong>natsort()</strong>
               
               <info>SORT_FLAG_CASE</info> - pode ser combinada (usando o operador bit a bit OR) com <info>SORT_STRING</info>
               ou <info>SORT_NATURAL</info> para ordenar strings sem fazer distinção entre maiúsculas e
               minúsculas

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

<comment>See Also:</comment>
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>asort()</strong>


id: ArrayObject::count
type: function
doc:
<comment>Description:</comment>
  Get the number of public properties in the ArrayObject
  
  Get the number of public properties in the <class>ArrayObject</class>.

<comment>Return:</comment>
  <info>int</info>  The number of public properties in the <class>ArrayObject</class>.
       
       When the <class>ArrayObject</class> is constructed from an array all properties are public.


id: ArrayObject::exchangeArray
type: function
doc:
<comment>Description:</comment>
  Exchange the array for another one
  
  Exchange the current <info>array</info> with another <info>array</info> or <info>object</info>.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  The new <info>array</info> or <info>object</info> to exchange with the current array.

<comment>Return:</comment>
  <info>array</info>  Returns the old <info>array</info>.


id: ArrayObject::getArrayCopy
type: function
doc:
<comment>Description:</comment>
  Creates a copy of the ArrayObject
  
  Exports the <class>ArrayObject</class> to an array.

<comment>Return:</comment>
  <info>array</info>  Returns a copy of the array. When the <class>ArrayObject</class> refers to an object, an array of the
         properties of that object will be returned.


id: ArrayObject::getFlags
type: function
doc:
<comment>Description:</comment>
  Gets the behavior flags
  
  Gets the behavior flags of the <class>ArrayObject</class>. See the ArrayObject::setFlags method for a list of the
  available flags.

<comment>Return:</comment>
  <info>int</info>  Returns the behavior flags of the ArrayObject.

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


id: ArrayObject::getIterator
type: function
doc:
<comment>Description:</comment>
  Retorna o iterador do ArrayObject
  
  Cria um novo iterador a partir de uma instância de <class>ArrayObject</class>.

<comment>Return:</comment>
  <info>Iterator</info>  Um iterador de um <class>ArrayObject</class>.


id: ArrayObject::getIteratorClass
type: function
doc:
<comment>Description:</comment>
  Gets the iterator classname for the ArrayObject
  
  Gets the class name of the array iterator that is used by ArrayObject::getIterator().

<comment>Return:</comment>
  <info>string</info>  Returns the iterator class name that is used to iterate over this object.

<comment>See Also:</comment>
   * The ArrayObject::setIteratorClass method


id: ArrayObject::ksort
type: function
doc:
<comment>Description:</comment>
  Sort the entries by key
  
  Sorts the entries by key, maintaining key to entry correlations. This is useful mainly for
  associative arrays.
  
  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.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  O segundo parâmetro opcional <strong>$flags</strong> pode ser usado para modificar o comportamento da
               ordenação usando estes valores:
               
               Flags dos tipos de ordenação: <info>SORT_REGULAR</info> - compara os elementos normalmente; os
               detalhes são descritos na seção operadores de comparação<info>SORT_NUMERIC</info> - compara os
               elementos numericamente<info>SORT_STRING</info> - compara os elementos como
               strings<info>SORT_LOCALE_STRING</info> - compara os elementos como strings, com base na localidade
               atual. A localidade pode ser alterada usando <strong>setlocale()</strong> <info>SORT_NATURAL</info> - compara os
               elementos como strings usando "ordenação natural" como <strong>natsort()</strong> <info>SORT_FLAG_CASE</info> -
               pode ser combinada (usando o operador bit a bit OR) com <info>SORT_STRING</info> ou <info>SORT_NATURAL</info>
               para ordenar strings sem fazer distinção entre maiúsculas e minúsculas
               
               <info>SORT_REGULAR</info> - compara os elementos normalmente; os detalhes são descritos na seção
               operadores de comparação
               
               <info>SORT_NUMERIC</info> - compara os elementos numericamente
               
               <info>SORT_STRING</info> - compara os elementos como strings
               
               <info>SORT_LOCALE_STRING</info> - compara os elementos como strings, com base na localidade atual.
               A localidade pode ser alterada usando <strong>setlocale()</strong>
               
               <info>SORT_NATURAL</info> - compara os elementos como strings usando "ordenação natural" como
               <strong>natsort()</strong>
               
               <info>SORT_FLAG_CASE</info> - pode ser combinada (usando o operador bit a bit OR) com <info>SORT_STRING</info>
               ou <info>SORT_NATURAL</info> para ordenar strings sem fazer distinção entre maiúsculas e
               minúsculas

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>ksort()</strong>


id: ArrayObject::natcasesort
type: function
doc:
<comment>Description:</comment>
  Sort an array using a case insensitive "natural order" algorithm
  
  This method is a case insensitive version of ArrayObject::natsort.
  
  This method implements a sort algorithm that orders alphanumeric strings in the way a human being
  would while maintaining key/value associations.  This is described as a "natural ordering".
  
  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.

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>natcasesort()</strong>


id: ArrayObject::natsort
type: function
doc:
<comment>Description:</comment>
  Sort entries using a "natural order" algorithm
  
  This method implements a sort algorithm that orders alphanumeric strings in the way a human being
  would while maintaining key/value associations. This is described as a "natural ordering".  An
  example of the difference between this algorithm and the regular computer string sorting
  algorithms (used in ArrayObject::asort) method can be seen in the example below.
  
  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.

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>natsort()</strong>


id: ArrayObject::offsetExists
type: function
doc:
<comment>Description:</comment>
  Returns whether the requested index exists

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  The index being checked.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the requested index exists, otherwise <info>false</info>


id: ArrayObject::offsetGet
type: function
doc:
<comment>Description:</comment>
  Returns the value at the specified index

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  The index with the value.

<comment>Return:</comment>
  <info>mixed</info>  The value at the specified index or <info>null</info>.


id: ArrayObject::offsetSet
type: function
doc:
<comment>Description:</comment>
  Sets the value at the specified index to newval
  
  Sets the value at the specified index to newval.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>    The index being set.
  <info>mixed</info>  <strong>$value</strong>  The new value for the <strong>$key</strong>.

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

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


id: ArrayObject::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Unsets the value at the specified index
  
  Unsets the value at the specified index.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  The index being unset.

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


id: ArrayObject::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize an ArrayObject
  
  Serializes an <class>ArrayObject</class>.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>string</info>  The serialized representation of the <class>ArrayObject</class>.

<comment>See Also:</comment>
   * ArrayObject::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: ArrayObject::setFlags
type: function
doc:
<comment>Description:</comment>
  Sets the behavior flags
  
  Set the flags that change the behavior of the ArrayObject.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  The new ArrayObject behavior. It takes on either a bitmask, or named constants. Using
               named constants is strongly encouraged to ensure compatibility for future versions.
               
               The available behavior flags are listed below. The actual meanings of these flags are
               described in the predefined constants. ArrayObject behavior
               flagsvalueconstant1ArrayObject::STD_PROP_LIST2ArrayObject::ARRAY_AS_PROPS

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


id: ArrayObject::setIteratorClass
type: function
doc:
<comment>Description:</comment>
  Sets the iterator classname for the ArrayObject
  
  Sets the classname of the array iterator that is used by ArrayObject::getIterator().

<comment>Param:</comment>
  <info>string</info>  <strong>$iteratorClass</strong>  The classname of the array iterator to use when iterating over this
                          object.

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


id: ArrayObject::uasort
type: function
doc:
<comment>Description:</comment>
  Sort the entries with a user-defined comparison function and maintain key association
  
  This function sorts the entries such that keys maintain their correlation with the entry that they
  are associated with, using a user-defined comparison function.
  
  This is used mainly when sorting associative arrays where the actual element order is significant.
  
  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.

<comment>Param:</comment>
  <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>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uksort
   * <strong>uasort()</strong>


id: ArrayObject::uksort
type: function
doc:
<comment>Description:</comment>
  Sort the entries by keys using a user-defined comparison function
  
  This function sorts the keys of the entries using a user-supplied comparison function. The key to
  entry correlations will be maintained.
  
  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.

<comment>Param:</comment>
  <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>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * <strong>uksort()</strong>


id: ArrayObject::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize an ArrayObject
  
  Unserializes a serialized <class>ArrayObject</class>.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>ArrayObject</class>.

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

<comment>See Also:</comment>
   * ArrayIterator::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: Attribute
type: class
doc:
<comment>Description:</comment>
  As instâncias de Attribute oferecem a capacidade de adicionar informações estruturadas de
  metadados e legíveis por máquina em declarações no código: Classes, métodos, funções, parâmetros,
  propriedades e constantes de classes podem ser um alvo de um atributo. Os metadados definidos
  pelas instâncias podem ser inspecionados em tempo de execução pelas Reflection APIs. Dessa forma,
  os atributos podem ser pensados como uma linguagem de configuração incorporada diretamente no
  código.


id: Attribute::__construct
type: function
doc:
<comment>Description:</comment>
  Constrói uma nova instância da classe Attribute
  
  Constrói um nova instância de <class>Attribute</class>.

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


id: BackedEnum
type: class
doc:
<comment>Description:</comment>
  A interface <class>BackedEnum</class> é aplicada automaticamente pelo motor do PHP a enumerações lastreadas. Não
  pode ser implementada por classes definidas pelo usuário. Enumerações não podem substituir seu
  métodos, já que as implementações padrões são fornecidas pelo motor. Está disponível apenas para
  verificações de tipo.


id: BackedEnum::from
type: function
doc:
<comment>Description:</comment>
  Mapeia um escalar para uma instância de enumeração
  
  O método from traduz uma <info>string</info> ou um <info>int</info> para o caso correspondente do Enum, se houver. Se não
  houver caso correspondente definido, ele irá emitir um <class>ValueError</class>.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$value</strong>  O valor escalar a ser mapeado para um caso de enumeração.

<comment>Return:</comment>
  <info>static</info>  Uma instância de caso para esta enumeração.

<comment>See Also:</comment>
   * UnitEnum::cases
   * BackedEnum::tryFrom


id: BackedEnum::tryFrom
type: function
doc:
<comment>Description:</comment>
  Mapeia um escalar para uma instância de enumeração ou nulo
  
  O método tryFrom traduz uma <info>string</info> ou um <info>int</info> para o caso correspondente do Enum, se houver. Se não
  houver caso correspondente definido, ele irá retornar nulo.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$value</strong>  O valor escalar a ser mapeado para um caso de enumeração.

<comment>Return:</comment>
  <info>static|null</info>  Uma instância de caso para esta enumeração, ou <info>null</info> se não encontrado.

<comment>See Also:</comment>
   * UnitEnum::cases
   * BackedEnum::from


id: BaseResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  Fetch warnings from last operation
  
  Fetches warnings generated by MySQL server's last operation.

<comment>Return:</comment>
  <info>array</info>  An array of Warning objects from the last operation. Each object defines an error
         'message', error 'level', and error 'code'. An empty array is returned if no errors are
         present.


id: BaseResult::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  Fetch warning count from last operation
  
  Returns the number of warnings raised by the last operation. Specifically,  these warnings are
  raised by the MySQL server.

<comment>Return:</comment>
  <info>int</info>  The number of warnings from the last operation.


id: CAL_DOW_DAYNO
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>jddayofweek()</strong>: o dia da semana como <info>int</info>, onde <return>0</return> representa domingo e <return>6</return> representa
  sábado.


id: CAL_DOW_LONG
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>jddayofweek()</strong>: o nome em inglês do dia da semana.


id: CAL_DOW_SHORT
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>jddayofweek()</strong>: o nome em inglês abreviado do dia da semana.


id: CAL_EASTER_ALWAYS_GREGORIAN
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>easter_days()</strong>: calcula a data da Páscoa de acordo com o calendário Gregoriano
  proléptico.


id: CAL_EASTER_ALWAYS_JULIAN
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>easter_days()</strong>: calcula a data da Páscoa de cordo com o calendário Juliano.


id: CAL_EASTER_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>easter_days()</strong>: calcula a data da Páscoa para anos anteriores a 1753 de acordo com o
  calendário Juliano, e para anos posteriores de acordo com o calendrário Gregoriano.


id: CAL_EASTER_ROMAN
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>easter_days()</strong>: calcula a data da Páscoa para anos anteriores a 1583 de acordo com o
  calendário Juliano, e para anos posteriores de acordo com o calendrário Gregoriano.


id: CAL_FRENCH
type: constant
doc:
<comment>Description:</comment>
  Para as funções <strong>cal_days_in_month()</strong>, <strong>cal_from_jd()</strong>, <strong>cal_info()</strong> e <strong>cal_to_jd()</strong>: usam o calendário
  Republicano Francês.


id: CAL_GREGORIAN
type: constant
doc:
<comment>Description:</comment>
  Para as funções <strong>cal_days_in_month()</strong>, <strong>cal_from_jd()</strong>, <strong>cal_info()</strong> e <strong>cal_to_jd()</strong>: usam o calendário
  Gregoriano proléptico.


id: CAL_JEWISH
type: constant
doc:
<comment>Description:</comment>
  Para as funções <strong>cal_days_in_month()</strong>, <strong>cal_from_jd()</strong>, <strong>cal_info()</strong> e <strong>cal_to_jd()</strong>: usam o calendário
  Judeu.


id: CAL_JEWISH_ADD_ALAFIM
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>jdtojewish()</strong>: adiciona a palavra alafim como separadora de milhares ao número do
  ano.


id: CAL_JEWISH_ADD_ALAFIM_GERESH
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>jdtojewish()</strong>: adiciona um símbolo de geresh (que lembra um apóstrofo) como separador
  de milhares ao número do ano.


id: CAL_JEWISH_ADD_GERESHAYIM
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>jdtojewish()</strong>: adiciona um símbolo gershayim (que lembra aspas duplas) antes da letra
  final dos número de dia e ano.


id: CAL_JULIAN
type: constant
doc:
<comment>Description:</comment>
  Para as funções <strong>cal_days_in_month()</strong>, <strong>cal_from_jd()</strong>, <strong>cal_info()</strong> e <strong>cal_to_jd()</strong>: usam o calendário
  Juliano.


id: CAL_MONTH_FRENCH
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>jdmonthname()</strong>: o nome do mês Republicano Francês.


id: CAL_MONTH_GREGORIAN_LONG
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>jdmonthname()</strong>: o nome do mês Gregoriano.


id: CAL_MONTH_GREGORIAN_SHORT
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>jdmonthname()</strong>: o nome do mês Gregoriano abreviado.


id: CAL_MONTH_JEWISH
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>jdmonthname()</strong>: o nome do mês Judeu.


id: CAL_MONTH_JULIAN_LONG
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>jdmonthname()</strong>: o nome do mês Juliano.


id: CAL_MONTH_JULIAN_SHORT
type: constant
doc:
<comment>Description:</comment>
  Para a função <strong>jdmonthname()</strong>: o nome do mês Juliano abreviado.


id: CASE_LOWER
type: constant
doc:
<comment>Description:</comment>
  <info>CASE_LOWER</info> é utilizado com a função <strong>array_change_key_case()</strong> para converter chaves de arrays para
  minúsculo. É o valor padrão utilizado na função <strong>array_change_key_case()</strong>. A partir do PHP 8.2.0,
  somente caracteres ASCII serão convertidos.


id: CASE_UPPER
type: constant
doc:
<comment>Description:</comment>
  <info>CASE_UPPER</info> é utilizado com a função <strong>array_change_key_case()</strong> para converter chaves de arrays para
  maiúsculo. A partir do PHP 8.2.0, somente caracteres ASCII serão convertidos.


id: CLSCTX_ALL
type: constant
doc:
<comment>Description:</comment>
  Indicates all class contexts. This definition ORs  <info>CLSCTX_INPROC_HANDLER</info> and  <info>CLSCTX_SERVER</info>.


id: CLSCTX_INPROC_HANDLER
type: constant
doc:
<comment>Description:</comment>
  The code that manages objects of this class is an in-process  handler. This is a DLL that runs in
  the client process and  implements client-side structures of this class when instances  of the
  class are accessed remotely.


id: CLSCTX_INPROC_SERVER
type: constant
doc:
<comment>Description:</comment>
  The code that creates and manages objects of this class is  a DLL that runs in the same process as
  the caller of the  function specifying the class context.


id: CLSCTX_LOCAL_SERVER
type: constant
doc:
<comment>Description:</comment>
  The EXE code that creates and manages objects of this class runs on  same machine but is loaded in
  a separate process space.


id: CLSCTX_REMOTE_SERVER
type: constant
doc:
<comment>Description:</comment>
  A remote context. The code that creates and manages objects of this  class is run on a different
  computer.


id: CLSCTX_SERVER
type: constant
doc:
<comment>Description:</comment>
  Indicates server code, whether in-process, local, or remote. This  definition ORs
  <info>CLSCTX_INPROC_SERVER</info>,  <info>CLSCTX_LOCAL_SERVER</info>, and  <info>CLSCTX_REMOTE_SERVER</info>.


id: CL_EXPUNGE
type: constant
doc:
<comment>Description:</comment>
  silently expunge the mailbox before closing when calling <strong>imap_close()</strong>


id: COMPersistHelper
type: class
doc:
<comment>Description:</comment>
  <class>COMPersistHelper</class> improves the interoperability of COM and PHP with regard to the php.ini directive
  open_basedir, and stream resources.


id: COMPersistHelper::GetCurFileName
type: function
doc:
<comment>Description:</comment>
  Get current filename
  
  Retrieves the current name of the file associated with the object.

<comment>Return:</comment>
  <info>string|false</info>  Returns the current name of the file associated with the object.


id: COMPersistHelper::GetMaxStreamSize
type: function
doc:
<comment>Description:</comment>
  Get maximum stream size
  
  Retrieves the size of the stream (in bytes) needed to save the object.

<comment>Return:</comment>
  <info>int</info>  Returns the size of the stream (in bytes) needed to save the object.


id: COMPersistHelper::InitNew
type: function
doc:
<comment>Description:</comment>
  Initialize object to default state
  
  Initializes an object to a default state.

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


id: COMPersistHelper::LoadFromFile
type: function
doc:
<comment>Description:</comment>
  Load object from file
  
  Opens the specified file and initializes an object from the file contents.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The name of the file from which to load the object.
  <info>int</info>     <strong>$flags</strong>     The access mode to be used when opening the file. Possible values are taken
                     from the STGM enumeration. The method can treat this value as a suggestion,
                     adding more restrictive permissions if necessary. If <strong>$flags</strong> is <return>0</return>, the
                     implementation is supposed to open the file using whatever default permissions
                     are used when a user opens the file.

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


id: COMPersistHelper::LoadFromStream
type: function
doc:
<comment>Description:</comment>
  Load object from stream
  
  Initializes an object from the stream where it was saved previously.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  The stream resource from which to load the object.

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


id: COMPersistHelper::SaveToFile
type: function
doc:
<comment>Description:</comment>
  Save object to file
  
  Saves a copy of the object to the specified file.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  The name of the file to which to save the object.
  <info>bool</info>         <strong>$remember</strong>  Indicates whether the <strong>$filename</strong> parameter is to be used as the current
                          working file. If <info>true</info>, <strong>$filename</strong> becomes the current file and the object
                          is supposed to clear its dirty flag after the save. If <info>false</info>, this save
                          operation is a "Save A Copy As ..." operation. In this case, the current
                          file is unchanged and the object is not supposed to clear its dirty flag.

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


id: COMPersistHelper::SaveToStream
type: function
doc:
<comment>Description:</comment>
  Save object to stream
  
  Saves an object to the specified stream.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  The stream resource to which to save the object.

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


id: COMPersistHelper::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a COMPersistHelper object
  
  Constructs a persistence helper object, usually associated with a <strong>$variant</strong>.

<comment>Param:</comment>
  <info>variant|null</info>  <strong>$variant</strong>  A COM object which implements IDispatch. To be able to successfully call
                          any of <class>COMPersistHelper</class>'s methods, the object has to implement
                          IPersistFile, IPersistStream and/or IPersistStreamInit.
                          
                          Passing <info>null</info> as <strong>$variant</strong> is only useful if the object is to be loaded from
                          a stream by calling COMPersistHelper::LoadFromStream.


id: CP_MOVE
type: constant
doc:
<comment>Description:</comment>
  Delete the messages from the current mailbox after copying with <strong>imap_mail_copy()</strong>


id: CREDITS_ALL
type: constant
doc:
<comment>Description:</comment>
  -1
  
  All the credits, equivalent to using: <return>CREDITS_DOCS + CREDITS_GENERAL + CREDITS_GROUP +
  CREDITS_MODULES + CREDITS_QA CREDITS_FULLPAGE</return>. It generates a complete stand-alone HTML page with
  the appropriate tags. This is the default value.


id: CREDITS_FULLPAGE
type: constant
doc:
<comment>Description:</comment>
  Usually used in combination with the other flags. Indicates that a complete stand-alone HTML page
  needs to be printed including the information indicated by the other flags.


id: CREDITS_GENERAL
type: constant
doc:
<comment>Description:</comment>
  General credits: Language design and concept, PHP authors and SAPI module.


id: CRYPT_BLOWFISH
type: constant
doc:
<comment>Description:</comment>
  Indica se hashes Blowfish são suportados em <strong>crypt()</strong>. Sempre <return>1</return>.


id: CRYPT_EXT_DES
type: constant
doc:
<comment>Description:</comment>
  Indica se hashes baseados em DES estendido são suportados em <strong>crypt()</strong>. Sempre <return>1</return>.


id: CRYPT_MD5
type: constant
doc:
<comment>Description:</comment>
  Indica se hashes MD5 são suportados em <strong>crypt()</strong>. Sempre <return>1</return>.


id: CRYPT_SHA256
type: constant
doc:
<comment>Description:</comment>
  Indica se hashes SHA-256 hashes são suportados em <strong>crypt()</strong>. Sempre <return>1</return>.


id: CRYPT_SHA512
type: constant
doc:
<comment>Description:</comment>
  Indica se hashes SHA-512 hashes são suportados em <strong>crypt()</strong>. Sempre <return>1</return>.


id: CRYPT_STD_DES
type: constant
doc:
<comment>Description:</comment>
  Indica se hashes baseados em DES padrão são suportados em <strong>crypt()</strong>. Sempre <return>1</return>.


id: CURLFile
type: class
doc:
<comment>Description:</comment>
  Esta classe ou <class>CURLStringFile</class> deve ser utilizada para fazer o envio de arquivos com
  <info>CURLOPT_POSTFIELDS</info>.
  
  A desserialização de instâncias <class>CURLFile</class> não é permitida. A partir do PHP 7.4.0, é explicitamente
  proibida.


id: CURLFile::__construct
type: function
doc:
<comment>Description:</comment>
  Criar um objeto CURLFile
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Cria um objeto <class>CURLFile</class>, usado para o upload de um arquivo <info>CURLOPT_POSTFIELDS</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>         Caminho para o arquivo que será enviado.
  <info>string|null</info>  <strong>$mime_type</strong>        O tipo de mídia do arquivo.
  <info>string|null</info>  <strong>$posted_filename</strong>  Nome do arquivo a ser usado nos dados de envio.

<comment>Return:</comment>
  <info>CURLFile</info>  Retorna um objeto <class>CURLFile</class>.

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


id: CURLFile::getFilename
type: function
doc:
<comment>Description:</comment>
  Obtém o nome do arquivo

<comment>Return:</comment>
  <info>string</info>  Retorna o nome do arquivo.


id: CURLFile::getMimeType
type: function
doc:
<comment>Description:</comment>
  Obtém o tipo mídia

<comment>Return:</comment>
  <info>string</info>  Retorna o tipo de MIME.


id: CURLFile::getPostFilename
type: function
doc:
<comment>Description:</comment>
  Obtém o nome do arquivo para requisição POST

<comment>Return:</comment>
  <info>string</info>  Retorna o nome do arquivo utilizando o POST.


id: CURLFile::setMimeType
type: function
doc:
<comment>Description:</comment>
  Define o tipo de mídia

<comment>Param:</comment>
  <info>string</info>  <strong>$mime_type</strong>  Tipo de mídia a ser utilizado nos dados da requisição POST.

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


id: CURLFile::setPostFilename
type: function
doc:
<comment>Description:</comment>
  Define o nome do arquivo para a requisição POST

<comment>Param:</comment>
  <info>string</info>  <strong>$posted_filename</strong>  Nome do arquivo a ser utilizado nos dados da requisição POST.

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


id: CURLINFO_HTTP_CODE
type: constant
doc:
<comment>Description:</comment>
  A partir de cURL 7.10.8 este é um apelido obsoleto de <info>CURLINFO_RESPONSE_CODE</info>


id: CURLOPT_DOH_SSL_VERIFYHOST
type: constant
doc:
<comment>Description:</comment>
  Compara os campos de nome do certificado SSL do servidor DNS-over-HTTPS com o nome do servidor.
  Disponível a partir do PHP 8.2.0 e cURL 7.76.0.


id: CURLOPT_DOH_SSL_VERIFYPEER
type: constant
doc:
<comment>Description:</comment>
  Verifica a autenticidade do certificado SSL do servidor DNS-over-HTTPS. Disponível a partir do PHP
  8.2.0 e cURL 7.76.0.


id: CURLOPT_DOH_SSL_VERIFYSTATUS
type: constant
doc:
<comment>Description:</comment>
  Solicia ao cURL que verifique o estado do certificado do servidor DNS-over-HTTPS usando a extensão
  TLS "Certificate Status Request" ("grampeador" OCSP). Disponível a partir do PHP 8.2.0 e cURL
  7.76.0.


id: CURLOPT_DOH_URL
type: constant
doc:
<comment>Description:</comment>
  Fornece a URL de DNS-over-HTTPS. Disponível a partir do PHP 8.1.0 e cURL 7.62.0.


id: CURLOPT_FOLLOWLOCATION
type: constant
doc:
<comment>Description:</comment>
  Esta constante não está disponível quando a diretiva open_basedir estiver ativa.


id: CURLOPT_HTTP09_ALLOWED
type: constant
doc:
<comment>Description:</comment>
  Disponível a partir do PHP 7.3.15 e 7.4.3, respectivamente, e cURL 7.64.0


id: CURLOPT_ISSUERCERT_BLOB
type: constant
doc:
<comment>Description:</comment>
  Blob de memória do emissor do certificado SSL. Disponível a partir do PHP 8.1.0 e cURL 7.71.0.


id: CURLOPT_MUTE
type: constant
doc:
<comment>Description:</comment>
  Removida desde o cURL 7.15.5; utilize <info>CURLOPT_RETURNTRANSFER</info>.


id: CURLOPT_PROXY_ISSUERCERT
type: constant
doc:
<comment>Description:</comment>
  Nome do arquivo do emissor proxy do certificado SSL. Disponível a partir do PHP 8.1.0 e cURL
  7.71.0.


id: CURLOPT_PROXY_ISSUERCERT_BLOB
type: constant
doc:
<comment>Description:</comment>
  Blob de memória do emissor proxy do certificado SSL. Disponível a partir do PHP 8.1.0 e cURL
  7.71.0.


id: CURLOPT_PROXY_SSLCERT_BLOB
type: constant
doc:
<comment>Description:</comment>
  Blob de memória do proxy do certificado SSL cliente. Disponível a partir do PHP 8.1.0 e cURL
  7.71.0.


id: CURLOPT_PROXY_SSLKEY_BLOB
type: constant
doc:
<comment>Description:</comment>
  Blob de memória da chave privada do certificado proxy. Disponível a partir do PHP 8.1.0 e cURL
  7.71.0.


id: CURLOPT_SSLCERT_BLOB
type: constant
doc:
<comment>Description:</comment>
  Blob de memória do certificado SSL cliente. Disponível a partir do PHP 8.1.0 e cURL 7.71.0.


id: CURLOPT_SSLKEY_BLOB
type: constant
doc:
<comment>Description:</comment>
  Blob de memória da chave privada do certificado cliente. Disponível a partir do PHP 8.1.0 e cURL
  7.71.0.


id: CURLStringFile
type: class
doc:
<comment>Description:</comment>
  <class>CURLStringFile</class> torna possível enviar um arquivo diretamente de uma variável. Isto é semelhante a
  <class>CURLFile</class>, mas funciona com o conteúdo do arquivo, não com o nome do arquivo. Esta classe ou
  <class>CURLFile</class> deve ser usada para enviar o conteúdo do arquivo com <info>CURLOPT_POSTFIELDS</info>.


id: CURLStringFile::__construct
type: function
doc:
<comment>Description:</comment>
  Crie um objeto CURLStringFile
  
  Cria um objeto <class>CURLStringFile</class>, usado para carregar um arquivo com <info>CURLOPT_POSTFIELDS</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>      O conteúdo a ser carregado.
  <info>string</info>  <strong>$postname</strong>  O nome do arquivo a ser usado nos dados de carregamento.
  <info>string</info>  <strong>$mime</strong>      Tipo MIME do arquivo (o padrão é <return>application/octet-stream</return>).

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


id: CURL_VERSION_ASYNCHDNS
type: constant
doc:
<comment>Description:</comment>
  Resolução de DNS assíncrona. Disponível a partir do PHP 7.3.0 e cURL 7.10.7


id: CURL_VERSION_CONV
type: constant
doc:
<comment>Description:</comment>
  Suporte a conversão de caracteres. Disponível a partir do PHP 7.3.0 e cURL 7.15.4


id: CURL_VERSION_CURLDEBUG
type: constant
doc:
<comment>Description:</comment>
  Rastreamento de memória para debug suportado. Disponível a partir do PHP 7.3.6 e cURL 7.19.6


id: CURL_VERSION_DEBUG
type: constant
doc:
<comment>Description:</comment>
  Compilado com suporte de debug. Disponível a partir do PHP 7.3.0 e cURL 7.10.6


id: CURL_VERSION_GSSAPI
type: constant
doc:
<comment>Description:</comment>
  Compilado com a biblioteca GSS-API. Disponível a partir do PHP 7.3.0 e cURL 7.38.0


id: CURL_VERSION_GSSNEGOTIATE
type: constant
doc:
<comment>Description:</comment>
  Negociação auth é suportada. Disponível a partir do PHP 7.3.0 e cURL 7.10.6 (obsoleto a partir do
  cURL 7.38.0)


id: CURL_VERSION_HTTP2
type: constant
doc:
<comment>Description:</comment>
  Suporte ao HTTP2 compilado. Disponível a partir do PHP 5.5.24 e 5.6.8 e cURL 7.33.0


id: CURL_VERSION_IDN
type: constant
doc:
<comment>Description:</comment>
  Internationized Domain Names é suportado. Disponível a partir do PHP 7.3.0 e cURL 7.12.0


id: CURL_VERSION_KERBEROS5
type: constant
doc:
<comment>Description:</comment>
  Autenticação Kerberos V5 é suportada. Disponível a partir do PHP 7.0.7 e cURL 7.40.0


id: CURL_VERSION_LARGEFILE
type: constant
doc:
<comment>Description:</comment>
  Suporte a arquivos maiores que 2GB. Disponível desde o cURL 7.33.0


id: CURL_VERSION_NTLM
type: constant
doc:
<comment>Description:</comment>
  NTLM auth é suportado. Disponível a partir do PHP 7.3.0 e cURL 7.10.6


id: CURL_VERSION_NTLM_WB
type: constant
doc:
<comment>Description:</comment>
  Delegação NTLM para winbind helper é suportado. Disponível a partir do PHP 7.3.0 e cURL 7.22.0


id: CURL_VERSION_PSL
type: constant
doc:
<comment>Description:</comment>
  Mozilla's Public Suffix List, utilizado para verificação de cookies de domínio. Disponível a
  partir do PHP 7.3.6 e cURL 7.47.0


id: CURL_VERSION_SPNEGO
type: constant
doc:
<comment>Description:</comment>
  Autenticação SPNEGO é suportado. Disponível a partir do PHP 7.3.0 e cURL 7.10.8


id: CURL_VERSION_SSPI
type: constant
doc:
<comment>Description:</comment>
  Compilado com Windows SSPI. Disponível a partir do PHP 7.3.0 e cURL 7.13.2


id: CURL_VERSION_TLSAUTH_SRP
type: constant
doc:
<comment>Description:</comment>
  Autenticação TLS-SRP auth é suportado. Disponível a partir do PHP 7.3.0 e cURL 7.21.4


id: CURL_VERSION_UNIX_SOCKETS
type: constant
doc:
<comment>Description:</comment>
  Sockets Unix domain suportados. Disponível a partir do PHP 7.0.7 e cURL 7.40.0


id: CachingIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new CachingIterator object for the iterator
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  Iterator to cache
  <info>int</info>       <strong>$flags</strong>     Bitmask of flags.


id: CachingIterator::__toString
type: function
doc:
<comment>Description:</comment>
  Return the string representation of the current element
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Get the string representation of the current element.

<comment>Return:</comment>
  <info>string</info>  The <info>string</info> representation of the current element.


id: CachingIterator::count
type: function
doc:
<comment>Description:</comment>
  The number of elements in the iterator
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  May return the number of elements in the iterator.

<comment>Return:</comment>
  <info>int</info>  The count of the elements iterated over.


id: CachingIterator::current
type: function
doc:
<comment>Description:</comment>
  Return the current element
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  May return the current element in the iteration.

<comment>Return:</comment>
  <info>mixed</info>  Mixed

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


id: CachingIterator::getCache
type: function
doc:
<comment>Description:</comment>
  Retrieve the contents of the cache
  
  Retrieve the contents of the cache.
  
  The <info>CachingIterator::FULL_CACHE</info> flag must be being used.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing the cache items.


id: CachingIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  Get flags used
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Get the bitmask of the flags used for this CachingIterator instance.

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


id: CachingIterator::hasNext
type: function
doc:
<comment>Description:</comment>
  Check whether the inner iterator has a valid next element
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: CachingIterator::key
type: function
doc:
<comment>Description:</comment>
  Return the key for the current element
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  This method may return a key for the current element.

<comment>Return:</comment>
  <info>scalar</info>  


id: CachingIterator::next
type: function
doc:
<comment>Description:</comment>
  Move the iterator forward
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Move the iterator forward.

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


id: CachingIterator::offsetExists
type: function
doc:
<comment>Description:</comment>
  The offsetExists purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The index being checked.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if an entry referenced by the offset exists, <info>false</info> otherwise.


id: CachingIterator::offsetGet
type: function
doc:
<comment>Description:</comment>
  The offsetGet purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  Description...

<comment>Return:</comment>
  <info>mixed</info>  Description...


id: CachingIterator::offsetSet
type: function
doc:
<comment>Description:</comment>
  The offsetSet purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    The index of the element to be set.
  <info>mixed</info>   <strong>$value</strong>  The new value for the <strong>$key</strong>.

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


id: CachingIterator::offsetUnset
type: function
doc:
<comment>Description:</comment>
  The offsetUnset purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The index of the element to be unset.

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


id: CachingIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the iterator
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Rewind the iterator.

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


id: CachingIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  The setFlags purpose
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Set the flags for the CachingIterator object.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Bitmask of the flags to set.

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


id: CachingIterator::valid
type: function
doc:
<comment>Description:</comment>
  Check whether the current element is valid
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.
  
  Check whether the current element is valid.

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


id: CallbackFilterIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Create a filtered iterator from another iterator
  
  Creates a filtered iterator using the <strong>$callback</strong> to  determine which items are accepted or
  rejected.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  The iterator to be filtered.
  <info>callable</info>  <strong>$callback</strong>  The callback, which should return <info>true</info> to accept the current item or <info>false</info>
                       otherwise. See Examples.
                       
                       May be any valid <info>callable</info> value.

<comment>See Also:</comment>
   * CallbackFilterIterator Examples
   * CallbackFilterIterator::accept


id: CallbackFilterIterator::accept
type: function
doc:
<comment>Description:</comment>
  Calls the callback with the current value, the current key and the inner iterator as arguments
  
  This method calls the callback with the current value, current key  and the inner iterator.
  
  The callback is expected to return <info>true</info> if the current item is  to be accepted, or <info>false</info>
  otherwise.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> to accept the current item, or <info>false</info> otherwise.

<comment>See Also:</comment>
   * CallbackFilterIterator Examples
   * CallbackFilterIterator::__construct


id: Client::getClient
type: function
doc:
<comment>Description:</comment>
  Get client session
  
  Get session associated with the client.

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  A Session object.


id: Closure
type: class
doc:
<comment>Description:</comment>
  Classe usada para representar funções anônimas.
  
  Funções anônimas, produzem objetos desse tipo. Esta classe possui métodos que permitem ainda mais
  controle de funções anônimas após sua criação.
  
  Além dos métodos listados aqui, a classe também possui o método <return>__invoke</return>. Para consistência com
  outras classes que implementam o invoque mágico, já que esse método não é utilizado para chamar a
  função.


id: Closure::__construct
type: function
doc:
<comment>Description:</comment>
  Construtor que desabilita a instanciação
  
  Este método exise somente para desabilitar a instanciação da classe <class>Closure</class>. Objetos desta classe
  são criados como descrito na página funções anônimas.

<comment>See Also:</comment>
   * Funções anônimas


id: Closure::bind
type: function
doc:
<comment>Description:</comment>
  Duplica uma closure com um objeto vinculado e um escopo de classe
    
  
  Este método é uma versão estática do Closure::bindTo. Veja a documentação do método para mais
  informações.

<comment>Param:</comment>
  <info>Closure</info>             <strong>$closure</strong>   A função anônima a ser vincular.
  <info>object|null</info>         <strong>$newThis</strong>   O objeto que a função anônima fornecida deve vincular, ou <info>null</info> para
                                 a closure não vincular.
  <info>object|string|null</info>  <strong>$newScope</strong>  O escopo da classe ao qual a closure deve ser informado, ou
                                 'static' para manter o atual. Se um objeto é fornecido, o tipo do
                                 objeto será usado. Isso determina a visibilidade dos métodos
                                 protegidos e privados do objeto vinculado. Não é permitido passar
                                 uma (objeto da) classe interna como parâmetro this.

<comment>Return:</comment>
  <info>Closure|null</info>  Retorna um novo objeto <class>Closure</class> ou <info>null</info> em caso de falha.

<comment>See Also:</comment>
   * Funções anônimas
   * Closure::bindTo


id: Closure::bindTo
type: function
doc:
<comment>Description:</comment>
  Duplica a closure com um novo objeto vinculado e escopo de classe.
    
  
  Cria e retorna uma nova função anônima com o mesmo corpo e mesmas variáveis ligadas como a
  original, mas possivelmente com um diferente objeto ligado e um novo escopo de classe.
  
  O “obeto ligado” determina o valor que <return>$this</return> terá no corpo da função e o “escopo de classe”
  representa uma classe que determina quais membros privados e protegidos a função anônima será
  capaz de acessar. Nomeadamente, os membros que estarão visíveis serão os mesmos que estariam, se a
  função anônima fosse um método da classe informada como valor do parâmetro <strong>$newScope</strong>.
  
  Closures estáticas não podem ter nenhum objeto ligado (o valor do parâmetro <strong>$newThis</strong> deveria ser
  <info>null</info>), mas esta função pode entretanto ser utilizada para alterar seus escopos de classe.
  
  Esta função vai assegurar que, para uma closure não estática, possuir uma instância ligada irá
  implicar em ter escopo definido e vice-versa. Para este fim, closures não estáticas que recebem um
  escopo com instância <info>null</info> são tornadas estáticas; e closures não estáticas sem escopo que recebem
  uma instância não nula têm o escopo definido para uma classe não especificada.
  
  Se for requerido duplicar as funções anônimas, pode ser utilizada clonagem alternativamente.

<comment>Param:</comment>
  <info>object|null</info>         <strong>$newThis</strong>   O objeto ao qual a função anônima informada deve ser ligada, ou
                                 <info>null</info> para que a closure seja não ligada.
  <info>object|string|null</info>  <strong>$newScope</strong>  O escopo de classe ao qual a closure deve ser associada, ou
                                 'static' para manter a atual. Se um objeto for informado, o tipo do
                                 objeto será usado no lugar. Isto determina a visibilidade de
                                 métodos protegidos e privados do objeto ligado. Não é permitido
                                 passar (um objeto de) uma classe interna neste parâmetro.

<comment>Return:</comment>
  <info>Closure|null</info>  Retorna o novo objeto <class>Closure</class> criado ou <info>null</info> em caso de falha.

<comment>See Also:</comment>
   * Funções Anônimas
   * Closure::bind


id: Closure::call
type: function
doc:
<comment>Description:</comment>
  Vincula e chama a closure
  
  Vincula temporáriamente a closure ao <strong>$newThis</strong>, e a chama com qualquer parâmetro fornecido.

<comment>Param:</comment>
  <info>object</info>  <strong>$newThis</strong>  O <info>object</info> a ser vinculado a closure enquanto durar a chamada.
  <info>mixed</info>   <strong>$args</strong>     Zero ou mais parâmetros, que serão fornecidos como parâmetros para a closure.

<comment>Return:</comment>
  <info>mixed</info>  Retorna o valor de retorna da closure.


id: Closure::fromCallable
type: function
doc:
<comment>Description:</comment>
  Converte um callable em uma closure
  
  Cria e retorna uma nova função anônima a patir do <strong>$callback</strong> fornecido usando o escopo atual. Esse
  método verifica se o <strong>$callback</strong> é chamável no escopo atual e lança um <class>TypeError</class> se ele não for.
  
  A partir do PHP 8.1.0, Sintaxe de callable de primeira classe possui a mesma semântica que este
  método.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  O callable para converter.

<comment>Return:</comment>
  <info>Closure</info>  Retorna a recém-criada <class>Closure</class> ou lança um <class>TypeError</class> se o <strong>$callback</strong> não é chamável no
           escopo atual.

<comment>See Also:</comment>
   * Funções anônimas
   * Sintaxe de callable de primeira classe


id: Collator
type: class
doc:
<comment>Description:</comment>
  Provides string comparison capability with support for appropriate locale-sensitive sort
  orderings.


id: Collator::ALTERNATE_HANDLING
type: constant
doc:
<comment>Description:</comment>
  The Alternate attribute is used to control the handling of the so called variable characters in
  the UCA: whitespace, punctuation and symbols. If Alternate is set to NonIgnorable (N), then
  differences among these characters are of the same importance as differences among letters. If
  Alternate is set to Shifted (S), then these characters are of only minor importance. The Shifted
  value is often used in combination with Strength set to Quaternary. In such a case, whitespace,
  punctuation, and symbols are considered when comparing strings, but only if all other aspects of
  the strings (base letters, accents, and case) are identical. If Alternate is not set to Shifted,
  then there is no difference between a Strength of 3 and a Strength of 4. For more information and
  examples, see Variable_Weighting in the UCA. The reason the Alternate values are not simply On and
  Off is that additional Alternate values may be added in the future. The UCA option Blanked is
  expressed with Strength set to 3, and Alternate set to Shifted. The default for most locales is
  NonIgnorable. If Shifted is selected, it may be slower if there are many strings that are the same
  except for punctuation; sort key length will not be affected unless the strength level is also
  increased.
  
  Possible values are: <info>Collator::NON_IGNORABLE</info>(default)<info>Collator::SHIFTED</info><info>Collator::DEFAULT_VALUE</info>
  
  ALTERNATE_HANDLING rules S=3, A=N di Silva
  \< Di Silva \< diSilva \< U.S.A. \< USA  S=3, A=S di Silva = diSilva \< Di Silva \< U.S.A. = USA  S=4, A=S di Silva \< diSilva \< Di Silva \< U.S.A. \< USA
  
   S=3, A=N di Silva
  \< Di Silva \< diSilva \< U.S.A. \< USA  S=3, A=S di Silva = diSilva \< Di Silva \< U.S.A. = USA  S=4, A=S di Silva \< diSilva \< Di Silva \< U.S.A. \< USA


id: Collator::CASE_FIRST
type: constant
doc:
<comment>Description:</comment>
  The Case_First attribute is used to control whether uppercase letters come before lowercase
  letters or vice versa, in the absence of other differences in the strings. The possible values are
  Uppercase_First (U) and Lowercase_First (L), plus the standard Default and Off. There is almost no
  difference between the Off and Lowercase_First options in terms of results, so typically users
  will not use Lowercase_First: only Off or Uppercase_First. (People interested in the detailed
  differences between X and L should consult the <return>Collation Customization</return>). Specifying either L or U
  won't affect string comparison performance, but will affect the sort key length.
  
  Possible values are:
  <info>Collator::OFF</info>(default)<info>Collator::LOWER_FIRST</info><info>Collator::UPPER_FIRST</info><info>Collator:DEFAULT</info>
  
  CASE_FIRST rulesC=X or C=L "china"
  \< "China" \< "denmark" \< "Denmark"C=U "China" \< "china" \< "Denmark" \< "denmark"
  
  C=X or C=L "china"
  \< "China" \< "denmark" \< "Denmark"C=U "China" \< "china" \< "Denmark" \< "denmark"


id: Collator::CASE_LEVEL
type: constant
doc:
<comment>Description:</comment>
  The Case_Level attribute is used when ignoring accents but not case. In such a situation, set
  Strength to be Primary, and Case_Level to be On. In most locales, this setting is Off by default.
  There is a small string comparison performance and sort key impact if this attribute is set to be
  On.
  
  Possible values are: <info>Collator::OFF</info>(default)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>
  
  CASE_LEVEL rulesS=1, E=X role = Role = rôleS=1, E=O role = rôle \< Role
  
  S=1, E=X role = Role = rôleS=1, E=O role = rôle \< Role


id: Collator::FRENCH_COLLATION
type: constant
doc:
<comment>Description:</comment>
  Sort strings with different accents from the back of the string. This attribute is automatically
  set to On for the French locales and a few others. Users normally would not need to explicitly set
  this attribute. There is a string comparison performance cost when it is set On, but sort key
  length is unaffected. Possible values are:
  <info>Collator::ON</info><info>Collator::OFF</info>(default)<info>Collator::DEFAULT_VALUE</info>
  
  FRENCH_COLLATION rulesF=OFF cote \< coté \< côte \< côté F=ON cote \< côte \< coté \< côté
  
  F=OFF cote \< coté \< côte \< côté F=ON cote \< côte \< coté \< côté


id: Collator::HIRAGANA_QUATERNARY_MODE
type: constant
doc:
<comment>Description:</comment>
  Compatibility with JIS x 4061 requires the introduction of an additional level to distinguish
  Hiragana and Katakana characters. If compatibility with that standard is required, then this
  attribute should be set On, and the strength set to Quaternary. This will affect sort key length
  and string comparison string comparison performance.
  
  Possible values are: <info>Collator::OFF</info>(default)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::NORMALIZATION_MODE
type: constant
doc:
<comment>Description:</comment>
  The Normalization setting determines whether text is thoroughly normalized or not in comparison.
  Even if the setting is off (which is the default for many locales), text as represented in common
  usage will compare correctly (for details, see UTN #5). Only if the accent marks are in
  noncanonical order will there be a problem. If the setting is On, then the best results are
  guaranteed for all possible text input. There is a medium string comparison performance cost if
  this attribute is On, depending on the frequency of sequences that require normalization. There is
  no significant effect on sort key length. If the input text is known to be in NFD or NFKD
  normalization forms, there is no need to enable this Normalization option.
  
  Possible values are: <info>Collator::OFF</info>(default)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::NUMERIC_COLLATION
type: constant
doc:
<comment>Description:</comment>
  When turned on, this attribute generates a collation key for the numeric value of substrings of
  digits. This is a way to get '100' to sort AFTER '2'.
  
  Possible values are: <info>Collator::OFF</info>(default)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::STRENGTH
type: constant
doc:
<comment>Description:</comment>
  The ICU Collation Service supports many levels of comparison (named "Levels", but also known as
  "Strengths"). Having these categories enables ICU to sort strings precisely according to local
  conventions. However, by allowing the levels to be selectively employed, searching for a string in
  text can be performed with various matching conditions. For more detailed information, see
  <strong>collator_set_strength()</strong> chapter.
  
  Possible values are:
  <info>Collator::PRIMARY</info><info>Collator::SECONDARY</info><info>Collator::TERTIARY</info>(default)<info>Collator::QUATERNARY</info><info>Collator::IDENTICAL</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::__construct
type: function
doc:
<comment>Description:</comment>
  Create a collator
  
  Creates a new instance of <class>Collator</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  The locale whose collation rules should be used. Special values for locales can
                   be passed in - if an empty <info>string</info> is passed for the locale, the default locale's
                   collation rules will be used. If <return>"root"</return> is passed, UCA rules will be used.
                   
                   The <strong>$locale</strong> attribute is typically the most important attribute for correct
                   sorting and matching, according to the user expectations in different countries
                   and regions. The default UCA ordering will only sort a few languages such as
                   Dutch and Portuguese correctly ("correctly" meaning according to the normal
                   expectations for users of the languages). Otherwise, you need to supply the
                   locale to UCA in order to properly collate text for a given language. Thus a
                   locale needs to be supplied so as to choose a collator that is correctly tailored
                   for that locale. The choice of a locale will automatically preset the values for
                   all of the attributes to something that is reasonable for that locale. Thus most
                   of the time the other attributes do not need to be explicitly set. In some cases,
                   the choice of locale will make a difference in string comparison performance
                   and/or sort key length.

<comment>See Also:</comment>
   * <strong>Collator::create()</strong>
   * <strong>collator_create()</strong>


id: Collator::asort
type: function
doc:
<comment>Description:</comment>
  Sort array maintaining index association
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  This function sorts an array such that array indices maintain their correlation with the array
  elements they are associated with. This is used mainly when sorting associative arrays where the
  actual element order is significant. Array elements will have sort order according to current
  locale rules.
  
  Equivalent to standard PHP <strong>asort()</strong>.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  <class>Collator</class> object.
  <info>array</info>     <strong>$array</strong>   Array of strings to sort.
  <info>int</info>       <strong>$flags</strong>   Optional sorting type, one of the following: <info>Collator::SORT_REGULAR</info> - compare
                     items normally (don't change types) <info>Collator::SORT_NUMERIC</info> - compare items
                     numerically <info>Collator::SORT_STRING</info> - compare items as strings
                     
                     <info>Collator::SORT_REGULAR</info> - compare items normally (don't change types)
                     
                     <info>Collator::SORT_NUMERIC</info> - compare items numerically
                     
                     <info>Collator::SORT_STRING</info> - compare items as strings
                     
                     Default <strong>$flags</strong> value is <info>Collator::SORT_REGULAR</info>. It is also used if an invalid
                     <strong>$flags</strong> value has been specified.

<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>
   * <class>Collator</class> constants
   * <strong>collator_sort()</strong>
   * <strong>collator_sort_with_sort_keys()</strong>


id: Collator::compare
type: function
doc:
<comment>Description:</comment>
  Compare two Unicode strings
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Compare two Unicode strings according to collation rules.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>   <class>Collator</class> object.
  <info>string</info>    <strong>$string1</strong>  The first string to compare.
  <info>string</info>    <strong>$string2</strong>  The second string to compare.

<comment>Return:</comment>
  <info>int|false</info>  Return comparison result:
             
              1 if <strong>$string1</strong> is greater than  <strong>$string2</strong> ;  0 if <strong>$string1</strong> is equal to  <strong>$string2</strong>;  -1 if
             <strong>$string1</strong> is less than  <strong>$string2</strong> .  Returns <info>false</info> on failure.
             
             1 if <strong>$string1</strong> is greater than  <strong>$string2</strong> ;
             
             0 if <strong>$string1</strong> is equal to  <strong>$string2</strong>;
             
             -1 if <strong>$string1</strong> is less than  <strong>$string2</strong> .
             
             Esta função pode
             retornar o valor booleano <info>false</info>, mas também pode retornar um valor não booleano que
             pode ser
             avaliado como <info>false</info>. Leia a seção sobre Booleanos para mais
             informações. Use o operador
             === para testar o valor retornado por esta
             função.

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


id: Collator::create
type: function
doc:
<comment>Description:</comment>
  Create a collator
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  The strings will be compared using the options already specified.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  The locale containing the required collation rules. Special values for locales
                   can be passed in - if an empty <info>string</info> is passed for the locale, the default
                   locale collation rules will be used. If <return>"root"</return> is passed, UCA rules will be used.

<comment>Return:</comment>
  <info>Collator|null</info>  Return new instance of <class>Collator</class> object, or <info>null</info> on error.

<comment>See Also:</comment>
   * <strong>Collator::__construct()</strong>


id: Collator::getAttribute
type: function
doc:
<comment>Description:</comment>
  Get collation attribute value
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Get a value of an integer collator attribute.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>     <class>Collator</class> object.
  <info>int</info>       <strong>$attribute</strong>  Attribute to get value for.

<comment>Return:</comment>
  <info>int|false</info>  Attribute value, ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <class>Collator</class> constants
   * <strong>collator_set_attribute()</strong>
   * <strong>collator_get_strength()</strong>


id: Collator::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Get collator's last error code
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  <class>Collator</class> object.

<comment>Return:</comment>
  <info>int|false</info>  Error code returned by the last Collator API function call, ou <info>false</info> em caso de falha.

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


id: Collator::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Get text for collator's last error code
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retrieves the message for the last error.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  <class>Collator</class> object.

<comment>Return:</comment>
  <info>string|false</info>  Description of an error occurred in the last Collator API function call, ou <info>false</info> em
                caso de falha.

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


id: Collator::getLocale
type: function
doc:
<comment>Description:</comment>
  Get the locale name of the collator
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Get collector locale name.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  <class>Collator</class> object.
  <info>int</info>       <strong>$type</strong>    You can choose between valid and actual locale ( <info>Locale::VALID_LOCALE</info> and
                     <info>Locale::ACTUAL_LOCALE</info>, respectively).

<comment>Return:</comment>
  <info>string|false</info>  Real locale name from which the collation data comes. If the collator was
                instantiated from rules or an error occurred, returns <info>false</info>.

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


id: Collator::getSortKey
type: function
doc:
<comment>Description:</comment>
  Get sorting key for a string
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Return collation key for a string. Collation keys can be compared directly instead of strings,
  though are implementation specific and may change between ICU library versions. Sort keys are
  generally only useful in databases or other circumstances where function calls are extremely
  expensive.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  <class>Collator</class> object.
  <info>string</info>    <strong>$string</strong>  The string to produce the key from.

<comment>Return:</comment>
  <info>string|false</info>  Returns the collation key for the string,  ou <info>false</info> em caso de falha.
                
                Esta função pode
                retornar o valor booleano <info>false</info>, mas também pode retornar um valor não booleano que
                pode ser
                avaliado como <info>false</info>. Leia a seção sobre Booleanos para mais
                informações. Use o operador
                === para testar o valor retornado por esta
                função.

<comment>See Also:</comment>
   * <strong>collator_sort()</strong>
   * <strong>collator_sort_with_sort_keys()</strong>


id: Collator::getStrength
type: function
doc:
<comment>Description:</comment>
  Get current collation strength
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  <class>Collator</class> object.

<comment>Return:</comment>
  <info>int</info>  Returns current collation strength, ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <class>Collator</class> constants
   * <strong>collator_set_strength()</strong>
   * <strong>collator_get_attribute()</strong>


id: Collator::setAttribute
type: function
doc:
<comment>Description:</comment>
  Set collation attribute
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>     <class>Collator</class> object.
  <info>int</info>       <strong>$attribute</strong>  Attribute.
  <info>int</info>       <strong>$value</strong>      Attribute value.

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

<comment>See Also:</comment>
   * <class>Collator</class> constants
   * <strong>collator_get_attribute()</strong>
   * <strong>collator_set_strength()</strong>


id: Collator::setStrength
type: function
doc:
<comment>Description:</comment>
  Set collation strength
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  The ICU Collation Service supports many levels of comparison (named "Levels", but also known as
  "Strengths"). Having these categories enables ICU to sort strings precisely according to local
  conventions. However, by allowing the levels to be selectively employed, searching for a string in
  text can be performed with various matching conditions.
  
  Primary Level: Typically, this is used to denote differences between base characters (for example,
  "a"
  \< "b"). It is the strongest difference. For example, dictionaries are divided into different sections by base character. This is also called the <return>level
  1</return> strength. Secondary Level: Accents in the characters are considered secondary differences (for
  example, "as"
  \< "às" \< "at"). Other differences between letters can also be considered secondary differences, depending on the language. A secondary difference is ignored when there is a primary difference anywhere in the strings. This is also called the <return>level
  2</return> strength.  Note: In some languages (such as Danish), certain accented letters are considered to
  be separate base characters. In most languages, however, an accented letter only has a secondary
  difference from the unaccented version of that letter.  Tertiary Level: Upper and lower case
  differences in characters are distinguished at the tertiary level (for example, "ao"
  \< "Ao" \< "aò"). In addition, a variant of a letter differs from the base form on the tertiary level (such as "A" and " "). Another example is the difference between large and small Kana. A tertiary difference is ignored when there is a primary or secondary difference anywhere in the strings. This is also called the <return>level
  3</return> strength. Quaternary Level: When punctuation is ignored (see Ignoring Punctuations ) at levels
  1-3, an additional level can be used to distinguish words with and without punctuation (for
  example, "ab"
  \< "a-b" \< "aB"). This difference is ignored when there is a primary, secondary or tertiary difference. This is also known as the <return>level
  4</return> strength. The quaternary level should only be used if ignoring punctuation is required or when
  processing Japanese text (see Hiragana processing). Identical Level: When all other levels are
  equal, the identical level is used as a tiebreaker. The Unicode code point values of the NFD form
  of each string are compared at this level, just in case there is no difference at levels 1-4. For
  example, Hebrew cantillation marks are only distinguished at this level. This level should be used
  sparingly, as only code point values differences between two strings is an extremely rare
  occurrence. Using this level substantially decreases the performance for both incremental
  comparison and sort key generation (as well as increasing the sort key length). It is also known
  as <return>level 5</return> strength.
  
  Primary Level: Typically, this is used to denote differences between base characters (for example,
  "a"
  \< "b"). It is the strongest difference. For example, dictionaries are divided into different sections by base character. This is also called the <return>level
  1</return> strength.
  
  Secondary Level: Accents in the characters are considered secondary differences (for example, "as"
  \< "às" \< "at"). Other differences between letters can also be considered secondary differences, depending on the language. A secondary difference is ignored when there is a primary difference anywhere in the strings. This is also called the <return>level
  2</return> strength.  Note: In some languages (such as Danish), certain accented letters are considered to
  be separate base characters. In most languages, however, an accented letter only has a secondary
  difference from the unaccented version of that letter.
  
  Note: In some languages (such as Danish), certain accented letters are considered to be separate
  base characters. In most languages, however, an accented letter only has a secondary difference
  from the unaccented version of that letter.
  
  Tertiary Level: Upper and lower case differences in characters are distinguished at the tertiary
  level (for example, "ao"
  \< "Ao" \< "aò"). In addition, a variant of a letter differs from the base form on the tertiary level (such as "A" and " "). Another example is the difference between large and small Kana. A tertiary difference is ignored when there is a primary or secondary difference anywhere in the strings. This is also called the <return>level
  3</return> strength.
  
  Quaternary Level: When punctuation is ignored (see Ignoring Punctuations ) at levels 1-3, an
  additional level can be used to distinguish words with and without punctuation (for example, "ab"
  \< "a-b" \< "aB"). This difference is ignored when there is a primary, secondary or tertiary difference. This is also known as the <return>level
  4</return> strength. The quaternary level should only be used if ignoring punctuation is required or when
  processing Japanese text (see Hiragana processing).
  
  Identical Level: When all other levels are equal, the identical level is used as a tiebreaker. The
  Unicode code point values of the NFD form of each string are compared at this level, just in case
  there is no difference at levels 1-4. For example, Hebrew cantillation marks are only
  distinguished at this level. This level should be used sparingly, as only code point values
  differences between two strings is an extremely rare occurrence. Using this level substantially
  decreases the performance for both incremental comparison and sort key generation (as well as
  increasing the sort key length). It is also known as <return>level 5</return> strength.
  
  For example, people may choose to ignore accents or ignore accents and case when searching for
  text. Almost all characters are distinguished by the first three levels, and in most locales the
  default value is thus Tertiary. However, if Alternate is set to be Shifted, then the Quaternary
  strength can be used to break ties among whitespace, punctuation, and symbols that would otherwise
  be ignored. If very fine distinctions among characters are required, then the Identical strength
  can be used (for example, Identical Strength distinguishes between the Mathematical Bold Small A
  and the Mathematical Italic Small A.). However, using levels higher than Tertiary the Identical
  strength result in significantly longer sort keys, and slower string comparison performance for
  equal strings.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>    <class>Collator</class> object.
  <info>int</info>       <strong>$strength</strong>  Strength to set.
                       
                       Possible values are:
                       <info>Collator::PRIMARY</info><info>Collator::SECONDARY</info><info>Collator::TERTIARY</info><info>Collator::QUATERNARY</info><info>Collator::IDENTICAL</info><info>Collator::DEFAULT_STRENGTH</info>
                       
                       <info>Collator::PRIMARY</info>
                       
                       <info>Collator::SECONDARY</info>
                       
                       <info>Collator::TERTIARY</info>
                       
                       <info>Collator::QUATERNARY</info>
                       
                       <info>Collator::IDENTICAL</info>
                       
                       <info>Collator::DEFAULT_STRENGTH</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>
   * <class>Collator</class> constants
   * <strong>collator_get_strength()</strong>


id: Collator::sort
type: function
doc:
<comment>Description:</comment>
  Sort array using specified collator
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  This function sorts an array according to current locale rules.
  
  Equivalent to standard PHP <strong>sort()</strong> .

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  <class>Collator</class> object.
  <info>array</info>     <strong>$array</strong>   Array of strings to sort.
  <info>int</info>       <strong>$flags</strong>   Optional sorting type, one of the following:
                     
                     <info>Collator::SORT_REGULAR</info> - compare items normally (don't change types)
                     <info>Collator::SORT_NUMERIC</info> - compare items numerically <info>Collator::SORT_STRING</info> -
                     compare items as strings  Default sorting type is <info>Collator::SORT_REGULAR</info>. It is
                     also used if an invalid <strong>$flags</strong> value has been specified.
                     
                     <info>Collator::SORT_REGULAR</info> - compare items normally (don't change types)
                     
                     <info>Collator::SORT_NUMERIC</info> - compare items numerically
                     
                     <info>Collator::SORT_STRING</info> - compare items as strings

<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>
   * <class>Collator</class> constants
   * <strong>collator_asort()</strong>
   * <strong>collator_sort_with_sort_keys()</strong>


id: Collator::sortWithSortKeys
type: function
doc:
<comment>Description:</comment>
  Sort array using specified collator and sort keys
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Similar to <strong>collator_sort()</strong> but uses ICU sorting keys produced by ucol_getSortKey() to gain more
  speed on large arrays.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  <class>Collator</class> object.
  <info>array</info>     <strong>$array</strong>   Array of strings to sort

<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>
   * <class>Collator</class> constants
   * <strong>collator_sort()</strong>
   * <strong>collator_asort()</strong>


id: Collectable::isGarbage
type: function
doc:
<comment>Description:</comment>
  Determine whether an object has been marked as garbage
  
  Can be called in Pool::collect to determine if this object is garbage.

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

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


id: Collection::add
type: function
doc:
<comment>Description:</comment>
  Add collection document
  
  Triggers the insertion of the given document(s) into the collection, and  multiple variants of
  this method are supported. Options include:
  
  Add a single document as a JSON string.
  
  Add a single document as an array as:  <return>[ 'field' =&gt; 'value', 'field2' =&gt; 'value2' ... ]</return>
  
  A mix of both, and multiple documents can be added in the same operation.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$document</strong>  One or multiple documents, and this can be either JSON or an array of fields
                    with  their associated values. This cannot be an empty array.
                    
                    The MySQL server automatically generates unique <return>_id</return> values for each document
                    (recommended), although this can be manually added as well. This value must be
                    unique as otherwise the add operation will fail.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionAdd</info>  A CollectionAdd object. Use execute() to return a Result that can be
                               used to query the number  of affected items, the number warnings
                               generated by the operation, or to fetch a list of  generated IDs for
                               the inserted documents.


id: Collection::addOrReplaceOne
type: function
doc:
<comment>Description:</comment>
  Add or replace collection document
  
  Add a new document, or replace a document if it already exists.
  
  Here are several scenarios for this method:
  
  If neither the id or any unique key values conflict with any document in the collection,  then the
  document is added.
  
  If the id does not match any document but one or more unique key values conflict with a  document
  in the collection, then an error is raised.
  
  If id matches an existing document and no unique keys are defined for the collection,  then the
  document is replaced.
  
  If id matches an existing document, and either all unique keys in the replacement document  match
  that same document or they don't conflict with any other documents in the collection,  then the
  document is replaced.
  
  If id matches an existing document and one or more unique keys match a different document  from
  the collection, then an error is raised.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>   This is the filter id. If this id or any other field that has a unique index already
                exists in the collection, then it will update the matching document instead.
                
                By default, this id is automatically generated by MySQL Server when the record was
                added, and is referenced as a field named '_id'.
  <info>string</info>  <strong>$doc</strong>  This is the document to add or replace, which is a JSON string.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  A Result object.


id: Collection::count
type: function
doc:
<comment>Description:</comment>
  Get document count
  
  This functionality is similar to a <return>SELECT COUNT(*)</return> SQL  operation against the MySQL server for the
  current schema and collection. In other words, it counts the number of documents in the
  collection.

<comment>Return:</comment>
  <info>int</info>  The number of documents in the collection.


id: Collection::createIndex
type: function
doc:
<comment>Description:</comment>
  Create collection index
  
  Creates an index on the collection.
  
  An exception is thrown if an index with the same name already exists, or if index definition is
  not correctly formed.

<comment>Param:</comment>
  <info>string</info>  <strong>$index_name</strong>       The name of the index that to create. This name must be a valid index
                            name as  accepted by the <return>CREATE INDEX</return> SQL query.
  <info>string</info>  <strong>$index_desc_json</strong>  Definition of the index to create. It contains an array of IndexField
                            objects, and each object describes a single document member to include
                            in the index,  and an optional string for the type of index that might
                            be INDEX (default) or SPATIAL.
                            
                            A single IndexField description consists of the following fields:
                            
                            field: string, the full document path to the document member or field to
                            be indexed.
                            
                            type: string, one of the supported SQL column types to map the field
                            into. For numeric types, the optional UNSIGNED keyword may follow. For
                            the TEXT type, the length to consider for indexing may be added.
                            
                            required: bool, (optional) true if the field is required to exist in the
                            document.  Defaults to <info>false</info>, except for <return>GEOJSON</return> where it defaults to
                            <info>true</info>.
                            
                            options: integer, (optional) special option flags for use  when decoding
                            <return>GEOJSON</return> data.
                            
                            srid: integer, (optional) srid value for use when  decoding <return>GEOJSON</return>
                            data.
                            
                            It is an error to include other fields not described above in
                            IndexDefinition or IndexField documents.

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


id: Collection::dropIndex
type: function
doc:
<comment>Description:</comment>
  Drop collection index
  
  Drop a collection index.
  
  This operation does not yield an error if the index does not exist, but <info>false</info> is returned in that
  case.

<comment>Param:</comment>
  <info>string</info>  <strong>$index_name</strong>  Name of collection index to drop.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the DROP INDEX operation succeeded, otherwise <info>false</info>.


id: Collection::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  Check if collection exists in database
  
  Checks if the Collection object refers to a collection in the database (schema).

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if collection exists in the database, else <info>false</info> if it does not.
        
        A table defined with two columns (doc and _id) is considered a collection,  and a third
        _json_schema column as of MySQL 8.0.21.  Adding an additional column means
        existsInDatabase() will no longer see it as a collection.


id: Collection::find
type: function
doc:
<comment>Description:</comment>
  Search for document
  
  Search a database collection for a document or set of documents. The found documents are returned
  as a CollectionFind object is to further modify or fetch results from.

<comment>Param:</comment>
  <info>string</info>  <strong>$search_condition</strong>  Although optional, normally a condition is defined to limit the results
                             to a subset of documents.
                             
                             Multiple elements might build the condition and the syntax supports
                             parameter binding.  The expression used as search condition must be a
                             valid SQL expression. If no search condition is provided (field empty)
                             then find('true') is assumed.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object to verify the operation, or fetch the found
                                documents.


id: Collection::getName
type: function
doc:
<comment>Description:</comment>
  Get collection name
  
  Retrieve the collection's name.

<comment>Return:</comment>
  <info>string</info>  The collection name, as a string.


id: Collection::getOne
type: function
doc:
<comment>Description:</comment>
  Get one document
  
  Fetches one document from the collection.
  
  This is a shortcut for: Collection.find("_id = :id").bind("id", id).execute().fetchOne();

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The document _id in the collection.

<comment>Return:</comment>
  <info>Document</info>  The collection object, or <info>null</info> if the _id does not match a document.


id: Collection::getSchema
type: function
doc:
<comment>Description:</comment>
  Get schema object
  
  Retrieve the schema object that contains the collection.

<comment>Return:</comment>
  <info>Schema Object</info>  The schema object on success, or <info>null</info> if the object cannot be retrieved for the
                 given collection.


id: Collection::getSession
type: function
doc:
<comment>Description:</comment>
  Get session object
  
  Get a new Session object from the Collection object.

<comment>Return:</comment>
  <info>Session</info>  A Session object.


id: Collection::modify
type: function
doc:
<comment>Description:</comment>
  Modify collection documents
  
  Modify the documents of a collection that meet specific search conditions. Multiple operations are
  allowed, and parameter binding is supported.

<comment>Param:</comment>
  <info>string</info>  <strong>$search_condition</strong>  Must be a valid SQL expression used to match the documents to modify.
                             This expression might be as simple as <info>true</info>, which matches all
                             documents, or it might use functions and operators such as  'CAST(_id
                             AS SIGNED) &gt;= 10',  'age MOD 2 = 0 OR age MOD 3 = 0', or '_id IN
                             ["2","5","7","10"]'.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  If the operation is not executed, then the function will return  a
                                  Modify object that can be used to add additional modify
                                  operations.
                                  
                                  If the modify operation is executed, then the returned object will
                                  contain the result of the operation.


id: Collection::remove
type: function
doc:
<comment>Description:</comment>
  Remove collection documents
  
  Removes documents of a collection that meet specific search conditions. Multiple operations are
  allowed, and parameter binding is supported.

<comment>Param:</comment>
  <info>string</info>  <strong>$search_condition</strong>  Must be a valid SQL expression used to match the documents to remove.
                             This expression might be as simple as <info>true</info>, which matches all
                             documents, or it might use functions and operators such as  'CAST(_id
                             AS SIGNED) &gt;= 10',  'age MOD 2 = 0 OR age MOD 3 = 0', or '_id IN
                             ["2","5","7","10"]'.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  If the operation is not executed, then the function will return  a
                                  Remove object that can be used to add additional remove
                                  operations.
                                  
                                  If the remove operation is executed, then the returned object will
                                  contain the result of the operation.


id: Collection::removeOne
type: function
doc:
<comment>Description:</comment>
  Remove one collection document
  
  Remove one document from the collection with the correspending ID.  This is a shortcut for
  Collection.remove("_id = :id").bind("id", id).execute().

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The ID of the collection document to remove. Typically this is the _id that was
               generated by MySQL Server when the record was added.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  A Result object that can be used to query the number of affected items or
                        the number warnings generated by the operation.


id: Collection::replaceOne
type: function
doc:
<comment>Description:</comment>
  Replace one collection document
  
  Updates (or replaces) the document identified by ID, if it exists.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>   ID of the document to replace or update. Typically this is the _id that was
                generated by MySQL Server when the record was added.
  <info>string</info>  <strong>$doc</strong>  Collection document to update or replace the document matching the id parameter.
                
                This document can be either a document object or a valid JSON string  describing the
                new document.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  A Result object that can be used to query the number of affected items and
                        the number warnings generated by the operation.


id: CollectionAdd::__construct
type: function
doc:
<comment>Description:</comment>
  CollectionAdd constructor
  
  Use to add a document to a collection; called from a Collection object.


id: CollectionAdd::execute
type: function
doc:
<comment>Description:</comment>
  Execute the statement
  
  The execute method is required to send the CRUD operation request to the MySQL server.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  A Result object that can be used to verify the status of the operation, such
                        as the number of affected rows.


id: CollectionFind::__construct
type: function
doc:
<comment>Description:</comment>
  CollectionFind constructor
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.


id: CollectionFind::bind
type: function
doc:
<comment>Description:</comment>
  Bind value to query placeholder
  
  It allows the user to bind a parameter to the placeholder in the search condition of the find
  operation. The placeholder has the form of :NAME where ':' is a common prefix that must always
  exists before any NAME, NAME is the actual name of the placeholder. The bind function accepts a
  list of placeholders if multiple entities have to be substituted in the search condition.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  Values to substitute in the search condition; multiple values are
                              allowed and are passed as an array where "PLACEHOLDER_NAME =&gt;
                              PLACEHOLDER_VALUE".

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object,  or chain with execute() to return a Result
                                object.


id: CollectionFind::execute
type: function
doc:
<comment>Description:</comment>
  Execute the statement
  
  Execute the find operation; this functionality allows for method chaining.

<comment>Return:</comment>
  <info>mysql_xdevapi\DocResult</info>  A <class>mysql_xdevapi\DocResult</class> object that can be used to either fetch results
                           from, or to query the status of the operation.


id: CollectionFind::fields
type: function
doc:
<comment>Description:</comment>
  Set document field filter
  
  Defines the columns for the query to return. If not defined, all columns are used.

<comment>Param:</comment>
  <info>string</info>  <strong>$projection</strong>  Can either be a single string or an array of strings identifying the columns
                       to be returned for each document that match the search condition.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object that can be used for further processing.


id: CollectionFind::groupBy
type: function
doc:
<comment>Description:</comment>
  Set grouping criteria
  
  This function can be used to group the result set by one or more columns. It is often used with
  aggregate functions such as <return>COUNT</return>, <return>MAX</return>, <return>MIN</return>, <return>SUM</return> etc.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  The column or columns that have to be used for the group operation, this can
                      either be a single string or an array of string arguments, one for each
                      column.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object that can be used for further processing.


id: CollectionFind::having
type: function
doc:
<comment>Description:</comment>
  Set condition for aggregate functions
  
  This function can be used after the 'field' operation in order to make a selection on the
  documents to extract.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  This must be a valid SQL expression, the use of aggreate functions is allowed

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  CollectionFind object that can be used for further processing


id: CollectionFind::limit
type: function
doc:
<comment>Description:</comment>
  Limit number of returned documents
  
  Set the maximum number of documents to return.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  Maximum number of documents.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object that can be used for additional processing;
                                chain with the execute() method to return a DocResult object.


id: CollectionFind::lockExclusive
type: function
doc:
<comment>Description:</comment>
  Execute operation with EXCLUSIVE LOCK
  
  Locks the document exclusively. As long as the document is locked, other transactions can't update
  the document, use SELECT ... LOCK IN SHARE MODE, or read the data in certain transaction isolation
  levels. Consistent reads ignore any locks set on the records that exist in the read view.
  
  To avoid concurrency problems, it makes sense to use this function with the
  mysql_xdevapi\Collection::modify method. Essentially, this function uses row locks to serialise
  access to rows.

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  Optional waiting option. By default it is <info>MYSQLX_LOCK_DEFAULT</info>. Valid
                             values are these constants:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  Returns a CollectionFind object that can be used for further
                                processing.


id: CollectionFind::lockShared
type: function
doc:
<comment>Description:</comment>
  Execute operation with SHARED LOCK
  
  Allows to share the documents between multiple transactions which are locking in shared mode.
  
  Other sessions can read the rows, but cannot modify them until your transaction commits.
  
  If any of these rows were changed by another transaction that hasn't been committed, the query
  will wait until that transaction has ended to be able to use the latest values.

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  Optional waiting option. By default it is <info>MYSQLX_LOCK_DEFAULT</info>. Valid
                             values are these constants:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object that can be used for further processing


id: CollectionFind::offset
type: function
doc:
<comment>Description:</comment>
  Skip given number of elements to be returned
  
  Skip (offset) these number of elements that otherwise would be returned by the find operation. Use
  with the limit() method.
  
  Defining an offset larger than the result set size results in an empty set.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  Number of elements to skip for the limit() operation.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object that can be used for additional processing.


id: CollectionFind::sort
type: function
doc:
<comment>Description:</comment>
  Set the sorting criteria
  
  Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC
  (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and
  it follows the same set of rules.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  One or more sorting expressions can be provided. The evaluation is from left
                      to right, and each expression is separated by a comma.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object that can be used to execute the command, or
                                to add additional operations.


id: CollectionModify::__construct
type: function
doc:
<comment>Description:</comment>
  CollectionModify constructor
  
  Modifies (updates) a collection and is instantiated by the mysql_xdevapi\Collection::modify
  method.


id: CollectionModify::arrayAppend
type: function
doc:
<comment>Description:</comment>
  Append element to an array field
  
  Add an element to a document's field, as multiple elements of a field are represented as an array.
  Unlike arrayInsert(), arrayAppend() always appends the new element at the end of the array,
  whereas arrayInsert() can define the location.

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       The identifier of the field where the new element is inserted.
  <info>string</info>  <strong>$expression_or_literal</strong>  The new element to insert at the end of the document field array.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object that can be used to execute the command,
                                  or to add additional operations.


id: CollectionModify::arrayInsert
type: function
doc:
<comment>Description:</comment>
  Insert element into an array field
  
  Adds an element to a document's field, as multiple elements of a field are represented as an
  array. Unlike mysql_xdevapi\CollectionModify::arrayAppend this method allows to specify where the
  new element is inserted by defining which item it is after, whereas
  mysql_xdevapi\CollectionModify::arrayAppend always appends the new element at the end of the
  array.

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       Identifies the item in the array after which the new element will
                                  be inserted. The format of this parameter is <return>FIELD_NAME[ INDEX ]</return>
                                  where FIELD_NAME is the name of the document field to add the
                                  element to, and INDEX is the INDEX of the element within the
                                  field.
                                  
                                  The INDEX field is zero based, so the first item of the array has
                                  an index of 0.
  <info>string</info>  <strong>$expression_or_literal</strong>  The new element to insert after FIELD_NAME[ INDEX ]

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object that can be used to execute the command,
                                  or to add additional operations


id: CollectionModify::bind
type: function
doc:
<comment>Description:</comment>
  Bind value to query placeholder
  
  Bind a parameter to the placeholder in the search condition of the modify operation.
  
  The placeholder has the form of :NAME where ':' is a common prefix that must always exists before
  any NAME where NAME is the name of the placeholder. The bind method accepts a list of placeholders
  if multiple entities have to be substituted in the search condition of the modify operation.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  Placeholder values to substitute in the search condition. Multiple
                              values are allowed and have to be passed as an array of mappings
                              PLACEHOLDER_NAME-&gt;PLACEHOLDER_VALUE.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object that can be used to execute the command,
                                  or to add additional operations.


id: CollectionModify::execute
type: function
doc:
<comment>Description:</comment>
  Execute modify operation
  
  The execute method is required to send the CRUD operation request to the MySQL server.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  A Result object that can be used to verify the status of the operation, such
                        as the number of affected rows.


id: CollectionModify::limit
type: function
doc:
<comment>Description:</comment>
  Limit number of modified documents
  
  Limit the number of documents modified by this operation. Optionally combine with skip() to define
  an offset value.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of documents to modify.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object.


id: CollectionModify::patch
type: function
doc:
<comment>Description:</comment>
  Patch document
  
  Takes a patch object and applies it on one or more documents, and can update multiple document
  properties.

<comment>Param:</comment>
  <info>string</info>  <strong>$document</strong>  A document with the properties to apply to the matching documents.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object.


id: CollectionModify::replace
type: function
doc:
<comment>Description:</comment>
  Replace document field
  
  Replace (update) a given field value with a new one.

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       The document path of the item to set.
  <info>string</info>  <strong>$expression_or_literal</strong>  The value to set on the specified attribute.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object.


id: CollectionModify::set
type: function
doc:
<comment>Description:</comment>
  Set document attribute
  
  Sets or updates attributes on documents in a collection.

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       The document path (name) of the item to set.
  <info>string</info>  <strong>$expression_or_literal</strong>  The value to set it to.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object.


id: CollectionModify::skip
type: function
doc:
<comment>Description:</comment>
  Skip elements
  
  Skips the first N elements that would otherwise be returned by a find operation. If the number of
  elements skipped is larger than the size of the result set, then the find operation returns an
  empty set.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  Number of elements to skip.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object to use for further processing.


id: CollectionModify::sort
type: function
doc:
<comment>Description:</comment>
  Set the sorting criteria
  
  Sorts the result set by the field selected in the sort_expr argument. The allowed orders are ASC
  (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and
  it follows the same set of rules.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  One or more sort expressions can be provided. The evaluation is from left to
                      right and each expression must be separated by a comma.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  CollectionModify object that can be used for further processing.


id: CollectionModify::unset
type: function
doc:
<comment>Description:</comment>
  Unset the value of document fields
  
  Removes attributes from documents in a collection.

<comment>Param:</comment>
  <info>array</info>  <strong>$fields</strong>  The attributes to remove from documents in a collection.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  CollectionModify object that can be used for further processing.


id: CollectionRemove::__construct
type: function
doc:
<comment>Description:</comment>
  CollectionRemove constructor
  
  Removes collection documents and is instantiated by the mysql_xdevapi\Collection::remove method.


id: CollectionRemove::bind
type: function
doc:
<comment>Description:</comment>
  Bind value to placeholder
  
  Bind a parameter to the placeholder in the search condition of the remove operation.
  
  The placeholder has the form of :NAME where ':' is a common prefix that must always exists before
  any NAME where NAME is the name of the placeholder. The bind method accepts a list of placeholders
  if multiple entities have to be substituted in the search condition of the remove operation.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  Placeholder values to substitute in the search condition. Multiple
                              values are allowed and have to be passed as an array of mappings
                              PLACEHOLDER_NAME-&gt;PLACEHOLDER_VALUE.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  A CollectionRemove object that can be used to execute the command,
                                  or to add additional operations.


id: CollectionRemove::execute
type: function
doc:
<comment>Description:</comment>
  Execute remove operation
  
  The execute function needs to be invoked in order to trigger the client to send the CRUD operation
  request to the server.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  Result object.


id: CollectionRemove::limit
type: function
doc:
<comment>Description:</comment>
  Limit number of documents to remove
  
  Sets the maximum number of documents to remove.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of documents to remove.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  Returns a CollectionRemove object that can be used to execute the
                                  command, or to add additional operations.


id: CollectionRemove::sort
type: function
doc:
<comment>Description:</comment>
  Set the sorting criteria
  
  Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC
  (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and
  it follows the same set of rules.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  One or more sorting expressions can be provided. The evaluation is from left
                      to right, and each expression is separated by a comma.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  A CollectionRemove object that can be used to execute the command,
                                  or to add additional operations.


id: ColumnResult::__construct
type: function
doc:
<comment>Description:</comment>
  ColumnResult constructor
  
  Retrieves column metadata, such as its character set; this is instantiated by the
  mysql_xdevapi\RowResult::getColumns method.


id: ColumnResult::getCharacterSetName
type: function
doc:
<comment>Description:</comment>
  Get character set
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: ColumnResult::getCollationName
type: function
doc:
<comment>Description:</comment>
  Get collation name
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: ColumnResult::getColumnLabel
type: function
doc:
<comment>Description:</comment>
  Get column label
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: ColumnResult::getColumnName
type: function
doc:
<comment>Description:</comment>
  Get column name
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: ColumnResult::getFractionalDigits
type: function
doc:
<comment>Description:</comment>
  Get fractional digit length
  
  Fetch the number of fractional digits for column.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: ColumnResult::getLength
type: function
doc:
<comment>Description:</comment>
  Get column field length
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: ColumnResult::getSchemaName
type: function
doc:
<comment>Description:</comment>
  Get schema name
  
  Fetch the schema name where the column is stored.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: ColumnResult::getTableLabel
type: function
doc:
<comment>Description:</comment>
  Get table label
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: ColumnResult::getTableName
type: function
doc:
<comment>Description:</comment>
  Get table name
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>string</info>  Name of the table for the column.


id: ColumnResult::getType
type: function
doc:
<comment>Description:</comment>
  Get column type
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: ColumnResult::isNumberSigned
type: function
doc:
<comment>Description:</comment>
  Check if signed type
  
  Retrieves a table's column information and is instantiated by the
  mysql_xdevapi\RowResult::getColumns method.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  <info>true</info> if a given column as a signed type.


id: ColumnResult::isPadded
type: function
doc:
<comment>Description:</comment>
  Check if padded
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  <info>true</info> if a given column is padded.


id: CommonMark\CQL
type: class
doc:
<comment>Description:</comment>
  CommonMark Query Language is a DSL for describing how to travel through a CommonMark Node tree
  implemented as a parser and compiler for a small set of instructions, and a virtual machine for
  executing those instructions.
  
  In it's most simplistic form, a CQL query combines the following paths and <return>/</return> to describe how to
  travel through a tree: firstChildlastChildpreviousnextparent For example, <return>/firstChild/lastChild</return>
  would travel to the last child node of the first child node.
  
  CQL can be instructed to loop, for example through the children of, or siblings to a particular
  node, by using the path <return>children</return>, or <return>siblings</return>. For example, <return>/firstChild/children</return> will travel to
  all the children of the first child node.
  
  CQL can be instructed how to travel by using a subquery like <return>[/firstChild]</return>. For example,
  <return>/firstChild/children[/firstChild]</return> will travel to the first child node of all the children of the
  first child node.
  
  While looping, CQL can be instructed to constrict the travelled path to nodes of particular type.
  For example <return>/children(BlockQuote)</return> will travel to the children of a node where the type is
  <return>BlockQuote</return>. The following types are recognized (case insensitively):
  BlockQuoteListItemCodeBlockHtmlBlockCustomBlockParagraphHeadingThematicBreakTextSoftBreakLineBreakCodeHtmlInlineCustomInlineEmphasisStrongLinkImage
  Types may be used as a union, for example <return>/children(BlockQuote|List)</return> will travel to the children
  of a node where the type is <return>BlockQuote</return> or <return>List</return>. Types, or unions of types, may be also negated.
  For example <return>/children(~BlockQuote)</return> will travel to the children of a node where the type is not
  <return>BlockQuote</return>, and <return>/children(~BlockQuote|Paragraph)</return> will travel to the children of a node where the
  type is not <return>BlockQuote</return> or <return>Paragraph</return>
  
  CQL can be instructed to create a loop to travel to a node of a particular type, at a particular
  path. For example, <return>/firstChild(BlockQuote)</return> will travel to the first child node where the type is
  <return>BlockQuote</return>. Note that like other loops for <return>children</return> and <return>siblings</return>, this kind of path can only be
  followed by a subquery.
  
  While CQL has been implemented as part of the PHP CommonMark extension, it stands separately from
  PHP and does not use PHP's virtual machine or internal representation of values.


id: CommonMark\CQL::__construct
type: function
doc:
<comment>Description:</comment>
  CQL Construction

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  a CQL string


id: CommonMark\CQL::__invoke
type: function
doc:
<comment>Description:</comment>
  CQL Execution
  
  Shall invoke the current CQL function on the given <strong>$root</strong>, executing the given <strong>$handler</strong> on entry to
  a <info>CommonMark\Node</info>

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$root</strong>     the root node of a tree
  <info>callable</info>         <strong>$handler</strong>  should have the prototype:
                             <info>bool</info><info>null</info></info>handler<info>CommonMark\Node</info><strong>$root</strong><info>CommonMark\Node</info><strong>$entering</strong> Should
                             <strong>$handler</strong> fail to return (void), or return <info>null</info>, CQL will continue
                             executingShould the handler return a truthy value, CQL will continue
                             executing.Should the handler return a falsy value, CQL will stop
                             executing


id: CommonMark\Interfaces\IVisitable::accept
type: function
doc:
<comment>Description:</comment>
  Visitation

<comment>Param:</comment>
  <info>CommonMark\Interfaces\IVisitor</info>  <strong>$visitor</strong>  An object implementing <class>CommonMark\Interfaces\IVisitor</class>

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

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


id: CommonMark\Interfaces\IVisitor::enter
type: function
doc:
<comment>Description:</comment>
  Visitation

<comment>Param:</comment>
  <info>IVisitable</info>  <strong>$visitable</strong>  The current <class>CommonMark\Interfaces\IVisitable</class> being entered

<comment>Return:</comment>
  <info>int|IVisitable|null</info>  Returning CommonMark\Interfaces\IVisitor::Done will cause the backing
                       iterator to exit.
                       
                       Returning CommonMark\Interfaces\IVisitor::Enter will reset the backing
                       iterator at entering the current <class>IVisitable</class>
                       
                       Returning CommonMark\Interfaces\IVisitor::Leave will reset the backing
                       iterator at exiting the current <class>IVisitable</class>
                       
                       Returning an <class>IVisitable</class> will reset the backing iterator at entering the given
                       <class>IVisitable</class>
                       
                       Returning nothing will allow the backing iterator to continue

<comment>See Also:</comment>
   * 


id: CommonMark\Interfaces\IVisitor::leave
type: function
doc:
<comment>Description:</comment>
  Visitation

<comment>Param:</comment>
  <info>IVisitable</info>  <strong>$visitable</strong>  The current <class>CommonMark\Interfaces\IVisitable</class> being exited

<comment>Return:</comment>
  <info>int|IVisitable|null</info>  Returning CommonMark\Interfaces\IVisitor::Done will cause the backing
                       iterator to exit.
                       
                       Returning CommonMark\Interfaces\IVisitor::Enter will reset the backing
                       iterator at entering the current <class>IVisitable</class>
                       
                       Returning CommonMark\Interfaces\IVisitor::Leave will reset the backing
                       iterator at exiting the current <class>IVisitable</class>
                       
                       Returning an <class>IVisitable</class> will reset the backing iterator at exiting the given
                       <class>IVisitable</class>
                       
                       Returning nothing will allow the backing iterator to continue

<comment>See Also:</comment>
   * 


id: CommonMark\Node
type: class
doc:
<comment>Description:</comment>
  Represents an Abstract Node, this final abstract is not for direct use by the programmer.


id: CommonMark\Node::appendChild
type: function
doc:
<comment>Description:</comment>
  AST Manipulation
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$child</strong>  

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


id: CommonMark\Node::insertAfter
type: function
doc:
<comment>Description:</comment>
  AST Manipulation
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$sibling</strong>  

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


id: CommonMark\Node::replace
type: function
doc:
<comment>Description:</comment>
  AST Manipulation
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$target</strong>  

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


id: CommonMark\Node::unlink
type: function
doc:
<comment>Description:</comment>
  AST Manipulation
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: CommonMark\Node\BulletList::__construct
type: function
doc:
<comment>Description:</comment>
  BulletList Construction
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.


id: CommonMark\Node\CodeBlock::__construct
type: function
doc:
<comment>Description:</comment>
  CodeBlock Construction
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$fence</strong>    
  <info>string</info>  <strong>$literal</strong>  


id: CommonMark\Node\Heading::__construct
type: function
doc:
<comment>Description:</comment>
  Heading Construction
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.


id: CommonMark\Node\Image::__construct
type: function
doc:
<comment>Description:</comment>
  Image Construction
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>    
  <info>string</info>  <strong>$title</strong>  


id: CommonMark\Node\Link::__construct
type: function
doc:
<comment>Description:</comment>
  Link Construction
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>    
  <info>string</info>  <strong>$title</strong>  


id: CommonMark\Node\OrderedList::__construct
type: function
doc:
<comment>Description:</comment>
  OrderedList Construction
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>  <strong>$tight</strong>      
  <info>int</info>  <strong>$delimiter</strong>  
  <info>int</info>  <strong>$start</strong>      


id: CommonMark\Node\Text::__construct
type: function
doc:
<comment>Description:</comment>
  Text Construction
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: CommonMark\Parse
type: function
doc:
<comment>Description:</comment>
  Parsing
  
  Shall parse <strong>$content</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$content</strong>  markdown string
  <info>int</info>     <strong>$options</strong>  A mask of:

<comment>Return:</comment>
  <info>CommonMark\Node</info>  Shall return root CommonMark\Node


id: CommonMark\Parser
type: class
doc:
<comment>Description:</comment>
  Provides an incremental parser as an alternative to the simple Parsing API function


id: CommonMark\Parser::__construct
type: function
doc:
<comment>Description:</comment>
  Parsing
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  A mask of:


id: CommonMark\Parser::finish
type: function
doc:
<comment>Description:</comment>
  Parsing
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


id: CommonMark\Parser::parse
type: function
doc:
<comment>Description:</comment>
  Parsing
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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

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


id: CommonMark\Render
type: function
doc:
<comment>Description:</comment>
  Rendering
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$node</strong>     
  <info>int</info>              <strong>$options</strong>  A mask of:
  <info>int</info>              <strong>$width</strong>    

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


id: CommonMark\Render\HTML
type: function
doc:
<comment>Description:</comment>
  Rendering
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$node</strong>     
  <info>int</info>              <strong>$options</strong>  A mask of:

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


id: Componere\Abstract\Definition
type: class
doc:
<comment>Description:</comment>
  This final abstract represents a class entry, and should not be used by the programmer.


id: Componere\Abstract\Definition::addInterface
type: function
doc:
<comment>Description:</comment>
  Add Interface
  
  Shall implement the given interface on the current definition

<comment>Param:</comment>
  <info>string</info>  <strong>$interface</strong>  The case insensitive name of an interface

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Abstract\Definition::addMethod
type: function
doc:
<comment>Description:</comment>
  Add Method
  
  Shall create or override a method on the current definition.

<comment>Param:</comment>
  <info>string</info>            <strong>$name</strong>    The case insensitive name for method
  <info>Componere\Method</info>  <strong>$method</strong>  <info>Componere\Method</info> not previously added to another <info>Definition</info>

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Abstract\Definition::addTrait
type: function
doc:
<comment>Description:</comment>
  Add Trait
  
  Shall use the given trait for the current definition

<comment>Param:</comment>
  <info>string</info>  <strong>$trait</strong>  The case insensitive name of a trait

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Abstract\Definition::getReflector
type: function
doc:
<comment>Description:</comment>
  Reflection
  
  Shall create or return a ReflectionClass

<comment>Return:</comment>
  <info>ReflectionClass</info>  A ReflectionClass for the current definition (cached)


id: Componere\Definition
type: class
doc:
<comment>Description:</comment>
  The Definition class allows the programmer to build and register a type at runtime.
  
  Should a Definition replace an existing class, the existing class will be restored when the
  Definition is destroyed.


id: Componere\Definition::__construct
type: function
doc:
<comment>Description:</comment>
  Definition Construction

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>        A case insensitive class name
  <info>string</info>  <strong>$parent</strong>      A case insensitive class name
  <info>array</info>   <strong>$interfaces</strong>  An array of case insensitive class names


id: Componere\Definition::addConstant
type: function
doc:
<comment>Description:</comment>
  Add Constant
  
  Shall declare a class constant on the current Definition

<comment>Param:</comment>
  <info>string</info>           <strong>$name</strong>   The case sensitive name for the constant
  <info>Componere\Value</info>  <strong>$value</strong>  The Value for the constant, must not be undefined or static

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Definition::addProperty
type: function
doc:
<comment>Description:</comment>
  Add Property
  
  Shall declare a class property on the current Definition

<comment>Param:</comment>
  <info>string</info>           <strong>$name</strong>   The case sensitive name for the property
  <info>Componere\Value</info>  <strong>$value</strong>  The default Value for the property

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Definition::getClosure
type: function
doc:
<comment>Description:</comment>
  Get Closure
  
  Shall return a Closure for the method specified by name

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The case insensitive name of the method

<comment>Return:</comment>
  <info>Closure</info>  A Closure bound to the correct scope


id: Componere\Definition::getClosures
type: function
doc:
<comment>Description:</comment>
  Get Closures
  
  Shall return an array of Closures

<comment>Return:</comment>
  <info>array</info>  Shall return all methods as an array of Closure objects bound to the correct scope


id: Componere\Definition::isRegistered
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Shall detect the registration state of this Definition

<comment>Return:</comment>
  <info>bool</info>  Shall return true if this Definition is registered


id: Componere\Definition::register
type: function
doc:
<comment>Description:</comment>
  Registration
  
  Shall register the current Definition

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


id: Componere\Method
type: class
doc:
<comment>Description:</comment>
  A Method represents a function with modifiable accessibility flags


id: Componere\Method::__construct
type: function
doc:
<comment>Description:</comment>
  Method Construction

<comment>Param:</comment>
  <info>Closure</info>  <strong>$closure</strong>  


id: Componere\Method::getReflector
type: function
doc:
<comment>Description:</comment>
  Reflection
  
  Shall create or return a ReflectionMethod

<comment>Return:</comment>
  <info>ReflectionMethod</info>  A ReflectionMethod for the current method (cached)


id: Componere\Method::setPrivate
type: function
doc:
<comment>Description:</comment>
  Accessibility Modification

<comment>Return:</comment>
  <info>Method</info>  The current Method


id: Componere\Patch
type: class
doc:
<comment>Description:</comment>
  The Patch class allows the programmer to change the type of an instance at runtime without
  registering a new Definition
  
  When a Patch is destroyed it is reverted, so that instances that were patched during the lifetime
  of the Patch are restored to their formal type.


id: Componere\Patch::__construct
type: function
doc:
<comment>Description:</comment>
  Patch Construction

<comment>Param:</comment>
  <info>object</info>  <strong>$instance</strong>    The target for this Patch
  <info>array</info>   <strong>$interfaces</strong>  A case insensitive array of class names


id: Componere\Patch::apply
type: function
doc:
<comment>Description:</comment>
  Application
  
  Shall apply the current patch

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


id: Componere\Patch::derive
type: function
doc:
<comment>Description:</comment>
  Patch Derivation
  
  Shall derive a <info>Patch</info> for the given <strong>$instance</strong>

<comment>Param:</comment>
  <info>object</info>  <strong>$instance</strong>  The target for the derived Patch

<comment>Return:</comment>
  <info>Patch</info>  <info>Patch</info> for <strong>$instance</strong> derived from the current <info>Patch</info>


id: Componere\Patch::getClosure
type: function
doc:
<comment>Description:</comment>
  Get Closure
  
  Shall return a Closure for the method specified by name

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The case insensitive name of the method

<comment>Return:</comment>
  <info>Closure</info>  A Closure bound to the correct scope and object


id: Componere\Patch::getClosures
type: function
doc:
<comment>Description:</comment>
  Get Closures
  
  Shall return an array of Closures

<comment>Return:</comment>
  <info>array</info>  Shall return all methods as an array of Closure objects bound to the correct scope and
         object


id: Componere\Patch::isApplied
type: function
doc:
<comment>Description:</comment>
  State Detection

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


id: Componere\Patch::revert
type: function
doc:
<comment>Description:</comment>
  Reversal
  
  Shall revert the current patch

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


id: Componere\Value
type: class
doc:
<comment>Description:</comment>
  A Value represents a PHP variable of all types, including undefined


id: Componere\Value::__construct
type: function
doc:
<comment>Description:</comment>
  Value Construction

<comment>Param:</comment>
  <info></info>  <strong>$default</strong>  


id: Componere\Value::hasDefault
type: function
doc:
<comment>Description:</comment>
  Value Interaction

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


id: Componere\Value::isPrivate
type: function
doc:
<comment>Description:</comment>
  Accessibility Detection

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


id: Componere\Value::setPrivate
type: function
doc:
<comment>Description:</comment>
  Accessibility Modification

<comment>Return:</comment>
  <info>Value</info>  The current Value


id: Componere\cast
type: function
doc:
<comment>Description:</comment>
  Casting

<comment>Param:</comment>
  <info>Type</info>  <strong>$type</strong>    A user defined type
  <info></info>      <strong>$object</strong>  An object with a user defined type compatible with Type

<comment>Return:</comment>
  <info>Type</info>  An <info>object</info> of type Type, cast from <strong>$object</strong>

<comment>See Also:</comment>
   * 


id: Componere\cast_by_ref
type: function
doc:
<comment>Description:</comment>
  Casting

<comment>Param:</comment>
  <info></info>  <strong>$object</strong>  An object with a user defined type compatible with Type

<comment>Return:</comment>
  <info>Type</info>  An <info>object</info> of type Type, cast from <strong>$object</strong>, where members are references to <strong>$object</strong> members

<comment>See Also:</comment>
   * 


id: Countable
type: class
doc:
<comment>Description:</comment>
  Classes que implementam <class>Countable</class> podem ser usadas com a função <strong>count()</strong>.


id: Countable::count
type: function
doc:
<comment>Description:</comment>
  Count elements of an object
  
  This method is executed when using the <strong>count()</strong> function on an object implementing <class>Countable</class>.

<comment>Return:</comment>
  <info>int</info>  The custom count as an <info>int</info>.
       
       The return value is cast to an <info>int</info>.


id: CrudOperationBindable::bind
type: function
doc:
<comment>Description:</comment>
  Bind value to placeholder
  
  Binds a value to a specific placeholder.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  The name of the placeholders and the values to bind.

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationBindable</info>  A CrudOperationBindable object.


id: CrudOperationLimitable::limit
type: function
doc:
<comment>Description:</comment>
  Set result limit
  
  Sets the maximum number of records or documents to return.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of records or documents.

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationLimitable</info>  A CrudOperationLimitable object.


id: CrudOperationSkippable::skip
type: function
doc:
<comment>Description:</comment>
  Number of operations to skip
  
  Skip this number of records in the returned operation.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>  <strong>$skip</strong>  Number of elements to skip.

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationSkippable</info>  A CrudOperationSkippable object.


id: CrudOperationSortable::sort
type: function
doc:
<comment>Description:</comment>
  Sort results
  
  Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC
  (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and
  it follows the same set of rules.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  One or more sorting expressions can be provided. The evaluation is from left
                      to right, and each expression is separated by a comma.

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationSortable</info>  A CrudOperationSortable object.


id: CurlHandle
type: class
doc:
<comment>Description:</comment>
  Uma classe totalmente opaca que substitui os recursos <return>curl</return> a partir do PHP 8.0.0.


id: CurlMultiHandle
type: class
doc:
<comment>Description:</comment>
  Uma classe totalmente opaca que substitui os recursos <return>curl_multi</return> a partir do PHP 8.0.0.


id: CurlShareHandle
type: class
doc:
<comment>Description:</comment>
  Uma classe totalmente opaca que substitui os recursos <return>curl_share</return> a partir do PHP 8.0.0.


id: DATE_ISO8601
type: constant
doc:
<comment>Description:</comment>
  ISO-8601 (exemplo: 2005-08-15T15:52:01+0000)
  
  Este formato não é compatível com a ISO-8601, mas foi deixado assim por motivo de compatibilidade
  com versões anteriores. Use <info>DateTimeInterface::ISO8601_EXPANDED</info>, <info>DateTimeInterface::ATOM</info> para
  compatibilidade com a ISO-8601, alternativamente. (ref ISO8601:2004 seção 4.3.3 cláusula d)


id: DATE_ISO8601_EXPANDED
type: constant
doc:
<comment>Description:</comment>
  ISO-8601 Expandida (exemplo: +10191-07-26T08:59:52+01:00)
  
  Este formato permite valores de ano fora do intervalo normal da ISO-8601 de <return>0000</return>-<return>9999</return> porque
  sempre inclui um caractere de sinal. Ele também faz com que que a parte do fuso horário (<return>+01:00</return>)
  seja compatível com a ISO-8601.


id: DATE_RFC3339_EXTENDED
type: constant
doc:
<comment>Description:</comment>
  RFC 3339 formato ESTENDIDO (exemplo: 2005-08-15T15:52:01.000+00:00)


id: DATE_RFC7231
type: constant
doc:
<comment>Description:</comment>
  RFC 7231 (desde PHP 7.0.19 e 7.1.5) (exemplo: Sat, 30 Apr 2016 17:52:13 GMT)


id: DB2_BINARY
type: constant
doc:
<comment>Description:</comment>
  Specifies that binary data shall be returned as is. This is the default mode.


id: DB2_CASE_NATURAL
type: constant
doc:
<comment>Description:</comment>
  Specifies that column names will be returned in their natural case.


id: DB2_CHAR
type: constant
doc:
<comment>Description:</comment>
  Specifies that the variable should be bound as a CHAR or VARCHAR data type.


id: DB2_CONVERT
type: constant
doc:
<comment>Description:</comment>
  Specifies that binary data shall be converted to a hexadecimal encoding and returned as an ASCII
  string.


id: DB2_DEFERRED_PREPARE_OFF
type: constant
doc:
<comment>Description:</comment>
  Specifies that deferred prepare should be turned off for the specified statement resource.


id: DB2_DEFERRED_PREPARE_ON
type: constant
doc:
<comment>Description:</comment>
  Specifies that deferred prepare should be turned on for the specified statement resource.


id: DB2_DOUBLE
type: constant
doc:
<comment>Description:</comment>
  Specifies that the variable should be bound as a DOUBLE, FLOAT, or REAL data type.


id: DB2_FORWARD_ONLY
type: constant
doc:
<comment>Description:</comment>
  Specifies a forward-only cursor for a statement resource. This is the default cursor type and is
  supported on all database servers.


id: DB2_LONG
type: constant
doc:
<comment>Description:</comment>
  Specifies that the variable should be bound as a SMALLINT, INTEGER, or BIGINT data type.


id: DB2_PARAM_FILE
type: constant
doc:
<comment>Description:</comment>
  Specifies that the column should be bound directly to a file for input.


id: DB2_PARAM_IN
type: constant
doc:
<comment>Description:</comment>
  Specifies the PHP variable should be bound as an IN parameter for a stored procedure.


id: DB2_PARAM_INOUT
type: constant
doc:
<comment>Description:</comment>
  Specifies the PHP variable should be bound as an INOUT parameter for a stored procedure.


id: DB2_PARAM_OUT
type: constant
doc:
<comment>Description:</comment>
  Specifies the PHP variable should be bound as an OUT parameter for a stored procedure.


id: DB2_PASSTHRU
type: constant
doc:
<comment>Description:</comment>
  Specifies that binary data shall be converted to a <info>null</info> value.


id: DB2_SCROLLABLE
type: constant
doc:
<comment>Description:</comment>
  Specifies a scrollable cursor for a statement resource. This mode enables random access to rows in
  a result set, but currently is supported only by IBM DB2 Universal Database.


id: DBASE_RDONLY
type: constant
doc:
<comment>Description:</comment>
  Abre o banco de dados somente para leitura. Usada com <strong>dbase_open()</strong>. (Disponível a partir do dbase
  7.0.0)


id: DBASE_RDWR
type: constant
doc:
<comment>Description:</comment>
  Abre o banco de dados para leitura e escrita. Usada com <strong>dbase_open()</strong>. (Disponível a partir do
  dbase 7.0.0)


id: DBASE_TYPE_DBASE
type: constant
doc:
<comment>Description:</comment>
  Cria o banco de dados no estilo dBASE. Usada com <strong>dbase_create()</strong>. (Disponível a partir do dbase
  7.0.0)


id: DBASE_TYPE_FOXPRO
type: constant
doc:
<comment>Description:</comment>
  Cria o banco de dados no estilo FoxPro. Usada com <strong>dbase_create()</strong>. (Disponível a partir do dbase
  7.0.0)


id: DBA_LMDB_NO_SUB_DIR
type: constant
doc:
<comment>Description:</comment>
  LMDB Driver flag to disallow the creation of a subdirectory for the database files. Available as
  of PHP 8.2.0.


id: DBA_LMDB_USE_SUB_DIR
type: constant
doc:
<comment>Description:</comment>
  LMDB Driver flag to allow the creation of a subdirectory for the database files. Available as of
  PHP 8.2.0.


id: DISP_E_BADINDEX
type: constant
doc:
<comment>Description:</comment>
  -2147352565
  
  An error that indicates that an array index does not exist.
  
  As of PHP 7.0.0, the value is <return>2147614731</return> on x64.


id: DISP_E_DIVBYZERO
type: constant
doc:
<comment>Description:</comment>
  -2147352558
  
  A return error that indicates a divide by zero error.
  
  As of PHP 7.0.0, the value is <return>2147614738</return> on x64.


id: DISP_E_OVERFLOW
type: constant
doc:
<comment>Description:</comment>
  -2147352566
  
  An error that indicates that a value could not be coerced to  its expected representation.
  
  As of PHP 7.0.0, the value is <return>2147614730</return> on x64.


id: DNS_ALL
type: constant
doc:
<comment>Description:</comment>
  Iteratively query the name server for each available record type.


id: DNS_ANY
type: constant
doc:
<comment>Description:</comment>
  Any Resource Record.  On most systems this returns all resource records, however it should not be
  counted upon for critical uses. Try <info>DNS_ALL</info> instead.


id: DNS_CAA
type: constant
doc:
<comment>Description:</comment>
  Certification Authority Authorization Resource (available as of PHP 7.0.16 and 7.1.2)


id: DNS_HINFO
type: constant
doc:
<comment>Description:</comment>
  Host Info Resource (See IANA's <return>Operating System Names</return> for the meaning of these values)


id: DOMAttr
type: class
doc:
<comment>Description:</comment>
  <class>DOMAttr</class> representa um atributo no objeto <class>DOMElement</class>.


id: DOMAttr::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new DOMAttr object
  
  Creates a new DOMAttr object. This object is read only.  It may be appended to a document, but
  additional nodes may not be appended to this node until the node is associated with a document. To
  create a writable node, use  .

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

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


id: DOMAttr::isId
type: function
doc:
<comment>Description:</comment>
  Checks if attribute is a defined ID
    
  
  This function checks if the attribute is a defined ID.
  
  According to the DOM standard this requires a DTD which defines the  attribute ID to be of type
  ID. You need to validate your document with  or <return>DOMDocument::validateOnParse</return> before using this
  function.

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


id: DOMCdataSection
type: class
doc:
<comment>Description:</comment>
  A classe <class>DOMCdataSection</class> herda de <class>DOMText</class> para a representação textual de construções CData.


id: DOMCdataSection::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new DOMCdataSection object
  
  Constructs a new CDATA node. This works like the <class>DOMText</class> class.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The value of the CDATA node. If not supplied, an empty CDATA node is created.

<comment>See Also:</comment>
   * DOMText::__construct
   * DOMDocument::createTextNode


id: DOMCharacterData
type: class
doc:
<comment>Description:</comment>
  Representa nós com dados de caracteres. Não há nós que correspondam diretamente a esta classe, mas
  outros nós herdam dela.


id: DOMCharacterData::after
type: function
doc:
<comment>Description:</comment>
  Adds nodes after the character data
  
  Adds the passed <strong>$nodes</strong> after the element.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Nodes to be added after the node. Strings are automatically converted to
                          text nodes.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMCharacterData::before


id: DOMCharacterData::appendData
type: function
doc:
<comment>Description:</comment>
  Append the string to the end of the character data of the node
    
  
  Append the string <strong>$data</strong> to the end of the character data of the node.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The string to append.

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

<comment>See Also:</comment>
   * DOMCharacterData::deleteData
   * DOMCharacterData::insertData
   * DOMCharacterData::replaceData
   * DOMCharacterData::substringData


id: DOMCharacterData::before
type: function
doc:
<comment>Description:</comment>
  Adds nodes before the node
  
  Adds the passed <strong>$nodes</strong> before the node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Nodes to be added before the node. Strings are automatically converted to
                          text nodes.

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

<comment>See Also:</comment>
   * DOMChildNode::before
   * DOMCharacterData::after


id: DOMCharacterData::deleteData
type: function
doc:
<comment>Description:</comment>
  Remove a range of characters from the node
    
  
  Deletes <strong>$count</strong> characters starting from position <strong>$offset</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The offset from which to start removing.
  <info>int</info>  <strong>$count</strong>   The number of characters to delete. If the sum of <strong>$offset</strong> and <strong>$count</strong> exceeds the
                length, then all characters to the end of the data are deleted.

<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>
   * DOMCharacterData::appendData
   * DOMCharacterData::insertData
   * DOMCharacterData::replaceData
   * DOMCharacterData::substringData


id: DOMCharacterData::insertData
type: function
doc:
<comment>Description:</comment>
  Insert a string at the specified 16-bit unit offset
    
  
  Inserts string <strong>$data</strong> at position <strong>$offset</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>  The character offset at which to insert.
  <info>string</info>  <strong>$data</strong>    The string to insert.

<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>
   * DOMCharacterData::appendData
   * DOMCharacterData::deleteData
   * DOMCharacterData::replaceData
   * DOMCharacterData::substringData


id: DOMCharacterData::remove
type: function
doc:
<comment>Description:</comment>
  Removes the character data
  
  Removes the character data.

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

<comment>See Also:</comment>
   * DOMChildNode::remove
   * DOMCharacterData::after
   * DOMCharacterData::before
   * DOMCharacterData::replaceWith
   * DOMNode::removeChild


id: DOMCharacterData::replaceData
type: function
doc:
<comment>Description:</comment>
  Replace a substring within the DOMCharacterData node
    
  
  Replace <strong>$count</strong> characters starting from position <strong>$offset</strong> with <strong>$data</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>  The offset from which to start replacing.
  <info>int</info>     <strong>$count</strong>   The number of characters to replace. If the sum of <strong>$offset</strong> and <strong>$count</strong> exceeds the
                   length, then all characters to the end of the data are replaced.
  <info>string</info>  <strong>$data</strong>    The string with which the range must be replaced.

<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>
   * DOMCharacterData::appendData
   * DOMCharacterData::deleteData
   * DOMCharacterData::insertData
   * DOMCharacterData::substringData


id: DOMCharacterData::replaceWith
type: function
doc:
<comment>Description:</comment>
  Replaces the character data with new nodes
  
  Replaces the character data with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The replacement nodes. Strings are automatically converted to text nodes.

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

<comment>See Also:</comment>
   * DOMChildNode::replaceWith
   * DOMCharacterData::after
   * DOMCharacterData::before
   * DOMCharacterData::remove


id: DOMCharacterData::substringData
type: function
doc:
<comment>Description:</comment>
  Extracts a range of data from the node
    
  
  Returns the specified substring.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  Start offset of substring to extract.
  <info>int</info>  <strong>$count</strong>   The number of characters to extract.

<comment>Return:</comment>
  <info>string|false</info>  The specified substring. If the sum of <strong>$offset</strong>  and <strong>$count</strong> exceeds the length, then
                all 16-bit units  to the end of the data are returned.

<comment>See Also:</comment>
   * DOMCharacterData::appendData
   * DOMCharacterData::deleteData
   * DOMCharacterData::insertData
   * DOMCharacterData::replaceData


id: DOMChildNode::after
type: function
doc:
<comment>Description:</comment>
  Adds nodes after the node
  
  Adds the passed <strong>$nodes</strong> after the node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Nodes to be added after the node. Strings are automatically converted to
                          text nodes.

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

<comment>See Also:</comment>
   * DOMChildNode::before
   * DOMChildNode::remove
   * DOMChildNode::replaceWith
   * DOMNode::appendChild


id: DOMChildNode::before
type: function
doc:
<comment>Description:</comment>
  Adds nodes before the node
  
  Adds the passed <strong>$nodes</strong> before the node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Nodes to be added before the node. Strings are automatically converted to
                          text nodes.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMChildNode::remove
   * DOMChildNode::replaceWith


id: DOMChildNode::remove
type: function
doc:
<comment>Description:</comment>
  Removes the node
  
  Removes the node.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMChildNode::before
   * DOMChildNode::replaceWith
   * DOMNode::removeChild


id: DOMChildNode::replaceWith
type: function
doc:
<comment>Description:</comment>
  Replaces the node with new nodes
  
  Replaces the node with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The replacement nodes. Strings are automatically converted to text nodes.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMChildNode::before
   * DOMChildNode::remove
   * DOMNode::replaceChild


id: DOMComment
type: class
doc:
<comment>Description:</comment>
  Representa nós de comentário, caracteres delimitados por \<!-- e --&gt;.


id: DOMComment::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new DOMComment object
    
  
  Creates a new <class>DOMComment</class> object. This object is read only.  It may be appended to a document, but
  additional nodes may not be appended to this node until  the node is associated with a document.
  To create a writeable node, use  .

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

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


id: DOMDocument
type: class
doc:
<comment>Description:</comment>
  Representa um documento HTML ou XML inteiro; serve como a raiz da árvore do documento.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$version</strong>   The version number of the document as part of the XML declaration.
  <info>string</info>  <strong>$encoding</strong>  The encoding of the document as part of the XML declaration.

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


id: DOMDocument::adoptNode
type: function
doc:
<comment>Description:</comment>
  Transfer a node from another document
  
  Transfer a node from another document into the current document.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>  The node to transfer.

<comment>Return:</comment>
  <info>DOMNode|false</info>  The node that was transfered, or <info>false</info> on error.

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


id: DOMDocument::append
type: function
doc:
<comment>Description:</comment>
  Appends nodes after the last child node
  
  Appends one or many <strong>$nodes</strong> to the list of children after the last child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes to append. Strings are automatically converted to text nodes.

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

<comment>See Also:</comment>
   * DOMParentNode::append
   * DOMDocument::prepend


id: DOMDocument::createAttribute
type: function
doc:
<comment>Description:</comment>
  Create new attribute
  
  This function creates a new instance of class <class>DOMAttr</class>.  Este nó não aparecerá no documento a menos
  que
  seja inserido, por exemplo, com <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  The name of the attribute.

<comment>Return:</comment>
  <info>DOMAttr|false</info>  The new <class>DOMAttr</class> or <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createAttributeNS
type: function
doc:
<comment>Description:</comment>
  Create new attribute node with an associated namespace
    
  
  This function creates a new instance of class <class>DOMAttr</class>. Este nó não aparecerá no documento a menos
  que
  seja inserido, por exemplo, com <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>      The URI of the namespace.
  <info>string</info>       <strong>$qualifiedName</strong>  The tag name and prefix of the attribute, as <return>prefix:tagname</return>.

<comment>Return:</comment>
  <info>DOMAttr|false</info>  The new <class>DOMAttr</class> or <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createCDATASection
type: function
doc:
<comment>Description:</comment>
  Create new cdata node
  
  This function creates a new instance of class <class>DOMCDATASection</class>. Este nó não aparecerá no documento
  a menos que
  seja inserido, por exemplo, com <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The content of the cdata.

<comment>Return:</comment>
  <info>DOMCdataSection|false</info>  The new <class>DOMCDATASection</class> or <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createComment
type: function
doc:
<comment>Description:</comment>
  Create new comment node
  
  This function creates a new instance of class <class>DOMComment</class>. Este nó não aparecerá no documento a
  menos que
  seja inserido, por exemplo, com <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The content of the comment.

<comment>Return:</comment>
  <info>DOMComment</info>  The new <class>DOMComment</class>.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createDocumentFragment
type: function
doc:
<comment>Description:</comment>
  Create new document fragment
  
  This function creates a new instance of class  <class>DOMDocumentFragment</class>. Este nó não aparecerá no
  documento a menos que
  seja inserido, por exemplo, com <strong>DOMNode::appendChild()</strong>.

<comment>Return:</comment>
  <info>DOMDocumentFragment</info>  The new <class>DOMDocumentFragment</class>.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createElement
type: function
doc:
<comment>Description:</comment>
  Create new element node
  
  This function creates a new instance of class <class>DOMElement</class>. Este nó não aparecerá no documento a
  menos que
  seja inserido, por exemplo, com <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  The tag name of the element.
  <info>string</info>  <strong>$value</strong>      The value of the element. By default, an empty element will be created. The
                      value can also be set later with DOMElement::$nodeValue.
                      
                      The value is used verbatim except that the
                      \< and &gt; entity references will escaped. Note that & has to be manually escaped; otherwise it is regarded as starting an entity reference. Also " won't be escaped.

<comment>Return:</comment>
  <info>DOMElement|false</info>  Returns a new instance of class <class>DOMElement</class> or <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createElementNS
type: function
doc:
<comment>Description:</comment>
  Create new element node with an associated namespace
    
  
  This function creates a new element node with an associated namespace. Este nó não aparecerá no
  documento a menos que
  seja inserido, por exemplo, com <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>      The URI of the namespace.
  <info>string</info>       <strong>$qualifiedName</strong>  The qualified name of the element, as <return>prefix:tagname</return>.
  <info>string</info>       <strong>$value</strong>          The value of the element. By default, an empty element will be
                               created. You can also set the value later with
                               DOMElement::$nodeValue.

<comment>Return:</comment>
  <info>DOMElement|false</info>  The new <class>DOMElement</class> or <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createEntityReference
type: function
doc:
<comment>Description:</comment>
  Create new entity reference node
  
  This function creates a new instance of class <class>DOMEntityReference</class>. Este nó não aparecerá no
  documento a menos que
  seja inserido, por exemplo, com <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The content of the entity reference, e.g. the entity reference minus the leading <return>&</return>
                 and the trailing <return>;</return> characters.

<comment>Return:</comment>
  <info>DOMEntityReference|false</info>  The new <class>DOMEntityReference</class> or <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createProcessingInstruction
type: function
doc:
<comment>Description:</comment>
  Creates new PI node
  
  This function creates a new instance of class <class>DOMProcessingInstruction</class>. Este nó não aparecerá no
  documento a menos que
  seja inserido, por exemplo, com <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$target</strong>  The target of the processing instruction.
  <info>string</info>  <strong>$data</strong>    The content of the processing instruction.

<comment>Return:</comment>
  <info>DOMProcessingInstruction|false</info>  The new <class>DOMProcessingInstruction</class> or <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createTextNode


id: DOMDocument::createTextNode
type: function
doc:
<comment>Description:</comment>
  Create new text node
  
  This function creates a new instance of class <class>DOMText</class>. Este nó não aparecerá no documento a menos
  que
  seja inserido, por exemplo, com <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The content of the text.

<comment>Return:</comment>
  <info>DOMText</info>  The new <class>DOMText</class>.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction


id: DOMDocument::getElementById
type: function
doc:
<comment>Description:</comment>
  Searches for an element with a certain id
  
  This function is similar to  but  searches for an element with a given id.
  
  For this function to work, you will need either to set some ID attributes with  or a DTD which
  defines an attribute to be of type ID.  In the later case, you will need to validate your document
  with   or DOMDocument::$validateOnParse before using this function.

<comment>Param:</comment>
  <info>string</info>  <strong>$elementId</strong>  The unique id value for an element.

<comment>Return:</comment>
  <info>DOMElement|null</info>  Returns the <class>DOMElement</class> or <info>null</info> if the element is not found.

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


id: DOMDocument::getElementsByTagName
type: function
doc:
<comment>Description:</comment>
  Searches for all elements with given local tag name
  
  This function returns a new instance of class <class>DOMNodeList</class> containing all the elements with a given
  local tag name.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  The local name (without namespace) of the tag to match on. The special
                          value <return>*</return> matches all tags.

<comment>Return:</comment>
  <info>DOMNodeList</info>  A new <class>DOMNodeList</class> object containing all the matched  elements.

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


id: DOMDocument::getElementsByTagNameNS
type: function
doc:
<comment>Description:</comment>
  Searches for all elements with given tag name in specified namespace
    
  
  Returns a <class>DOMNodeList</class> of all elements with a given  local name and a namespace URI.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  The namespace URI of the elements to match on. The special value <return>"*"</return>
                           matches all namespaces. Passing <info>null</info> matches the empty namespace.
  <info>string</info>       <strong>$localName</strong>  The local name of the elements to match on. The special value <return>"*"</return> matches
                           all local names.

<comment>Return:</comment>
  <info>DOMNodeList</info>  A new <class>DOMNodeList</class> object containing all the matched  elements.

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


id: DOMDocument::importNode
type: function
doc:
<comment>Description:</comment>
  Import node into current document
  
  This function returns a copy of the node to import and associates it with  the current document.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>  The node to import.
  <info>bool</info>     <strong>$deep</strong>  If set to <info>true</info>, this method will recursively import the subtree under the <strong>$node</strong>.
                  
                  To copy the nodes attributes <strong>$deep</strong> needs to be set to <info>true</info>

<comment>Return:</comment>
  <info>DOMNode|false</info>  The copied node or <info>false</info>, if it cannot be copied.


id: DOMDocument::load
type: function
doc:
<comment>Description:</comment>
  Load XML from a file
    
  
  Loads an XML document from a file.
  
  Unix style paths with forward slashes can cause significant performance degradation on Windows
  systems; be sure to call <strong>realpath()</strong> in such a case.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The path to the XML document.
  <info>int</info>     <strong>$options</strong>   Bitwise <return>OR</return> of the libxml option constants.

<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>
   * DOMDocument::loadXML
   * DOMDocument::save
   * DOMDocument::saveXML


id: DOMDocument::loadHTML
type: function
doc:
<comment>Description:</comment>
  Load HTML from a string
    
  
  The function parses the HTML contained in the string <strong>$source</strong>. Unlike loading XML, HTML does not
  have to be well-formed to load.
  
  This function parses the input using an HTML 4 parser. The parsing rules of HTML 5, which is what
  modern web browsers use, are different. Depending on the input this might result in a different
  DOM structure. Therefore this function cannot be safely used for sanitizing HTML.
  
  As an example, some HTML elements will implicitly close a parent element when encountered. The
  rules for automatically closing parent elements differ between HTML 4 and HTML 5 and thus the
  resulting DOM structure that <class>DOMDocument</class> sees might be different from the DOM structure a web
  browser sees, possibly allowing an attacker to break the resulting HTML.

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>   The HTML string.
  <info>int</info>     <strong>$options</strong>  Bit a bit <return>OR</return> das constantes de opções da libxml.

<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>
   * DOMDocument::loadHTMLFile
   * DOMDocument::saveHTML
   * DOMDocument::saveHTMLFile


id: DOMDocument::loadHTMLFile
type: function
doc:
<comment>Description:</comment>
  Load HTML from a file
    
  
  The function parses the HTML document in the file named <strong>$filename</strong>. Unlike loading XML, HTML does
  not have to be well-formed to load.
  
  This function parses the input using an HTML 4 parser. The parsing rules of HTML 5, which is what
  modern web browsers use, are different. Depending on the input this might result in a different
  DOM structure. Therefore this function cannot be safely used for sanitizing HTML.
  
  As an example, some HTML elements will implicitly close a parent element when encountered. The
  rules for automatically closing parent elements differ between HTML 4 and HTML 5 and thus the
  resulting DOM structure that <class>DOMDocument</class> sees might be different from the DOM structure a web
  browser sees, possibly allowing an attacker to break the resulting HTML.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The path to the HTML file.
  <info>int</info>     <strong>$options</strong>   Bit a bit <return>OR</return> das constantes de opções da libxml.

<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>
   * DOMDocument::loadHTML
   * DOMDocument::saveHTML
   * DOMDocument::saveHTMLFile


id: DOMDocument::loadXML
type: function
doc:
<comment>Description:</comment>
  Load XML from a string
    
  
  Loads an XML document from a string.

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>   The string containing the XML.
  <info>int</info>     <strong>$options</strong>  Bitwise <return>OR</return> of the libxml option constants.

<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>
   * DOMDocument::load
   * DOMDocument::save
   * DOMDocument::saveXML


id: DOMDocument::normalizeDocument
type: function
doc:
<comment>Description:</comment>
  Normalizes the document
  
  This method acts as if you saved and then loaded the document, putting the document in a "normal"
  form.

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

<comment>See Also:</comment>
   * The DOM Specification
   * DOMNode::normalize


id: DOMDocument::prepend
type: function
doc:
<comment>Description:</comment>
  Prepends nodes before the first child node
  
  Prepends one or many <strong>$nodes</strong> to the list of children before the first child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes to prepend. Strings are automatically converted to text nodes.

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

<comment>See Also:</comment>
   * DOMParentNode::prepend
   * DOMDocument::append


id: DOMDocument::registerNodeClass
type: function
doc:
<comment>Description:</comment>
  Register extended class used to create base node type
  
  This method allows you to register your own extended DOM class to be used afterward by the PHP DOM
  extension.
  
  This method is not part of the DOM standard.
  
  The constructor of the objects of the registered node classes is not called.

<comment>Param:</comment>
  <info>string</info>       <strong>$baseClass</strong>      The DOM class that you want to extend. You can find a list of these
                               classes in the chapter introduction.
  <info>string|null</info>  <strong>$extendedClass</strong>  Your extended class name. If <info>null</info> is provided, any previously
                               registered class extending <strong>$baseClass</strong> will be removed.

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


id: DOMDocument::relaxNGValidate
type: function
doc:
<comment>Description:</comment>
  Performs relaxNG validation on the document
    
  
  Performs relaxNG validation on the document based on the given RNG schema.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The RNG 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>
   * DOMDocument::relaxNGValidateSource
   * DOMDocument::schemaValidate
   * DOMDocument::schemaValidateSource
   * DOMDocument::validate


id: DOMDocument::relaxNGValidateSource
type: function
doc:
<comment>Description:</comment>
  Performs relaxNG validation on the document
    
  
  Performs relaxNG validation on the document based on the given RNG source.

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>  A string containing the RNG schema.

<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>
   * DOMDocument::relaxNGValidate
   * DOMDocument::schemaValidate
   * DOMDocument::schemaValidateSource
   * DOMDocument::validate


id: DOMDocument::replaceChildren
type: function
doc:
<comment>Description:</comment>
  Replace children in document
  
  Replaces the children in the document with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes replacing the children. Strings are automatically converted to
                          text nodes.

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

<comment>See Also:</comment>
   * DOMParentNode::replaceChildren
   * DOMDocument::append
   * DOMDocument::prepend


id: DOMDocument::save
type: function
doc:
<comment>Description:</comment>
  Dumps the internal XML tree back into a file
    
  
  Creates an XML document from the DOM representation. This function is usually  called after
  building a new dom document from scratch as in the example below.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The path to the saved XML document.
  <info>int</info>     <strong>$options</strong>   Additional Options. Currently only LIBXML_NOEMPTYTAG is supported.

<comment>Return:</comment>
  <info>int|false</info>  Returns the number of bytes written or <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * DOMDocument::saveXML
   * DOMDocument::load
   * DOMDocument::loadXML


id: DOMDocument::saveHTML
type: function
doc:
<comment>Description:</comment>
  Dumps the internal document into a string using HTML formatting
    
  
  Creates an HTML document from the DOM representation. This function is usually  called after
  building a new dom document from scratch as in the example below.

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$node</strong>  Optional parameter to output a subset of the document.

<comment>Return:</comment>
  <info>string|false</info>  Returns the HTML, or <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * DOMDocument::saveHTMLFile
   * DOMDocument::loadHTML
   * DOMDocument::loadHTMLFile


id: DOMDocument::saveHTMLFile
type: function
doc:
<comment>Description:</comment>
  Dumps the internal document into a file using HTML formatting
    
  
  Creates an HTML document from the DOM representation. This function is usually  called after
  building a new dom document from scratch as in the example below.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The path to the saved HTML document.

<comment>Return:</comment>
  <info>int|false</info>  Returns the number of bytes written or <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * DOMDocument::saveHTML
   * DOMDocument::loadHTML
   * DOMDocument::loadHTMLFile


id: DOMDocument::saveXML
type: function
doc:
<comment>Description:</comment>
  Dumps the internal XML tree back into a string
    
  
  Creates an XML document from the DOM representation. This function is usually  called after
  building a new dom document from scratch as in the example below.

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$node</strong>     Use this parameter to output only a specific node without XML declaration
                          rather than the entire document.
  <info>int</info>           <strong>$options</strong>  Additional Options. The LIBXML_NOEMPTYTAG and LIBXML_NOXMLDECL options are
                          supported. Prior to PHP 8.3.0, only the LIBXML_NOEMPTYTAG option is
                          supported.

<comment>Return:</comment>
  <info>string|false</info>  Returns the XML, or <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * DOMDocument::save
   * DOMDocument::load
   * DOMDocument::loadXML


id: DOMDocument::schemaValidate
type: function
doc:
<comment>Description:</comment>
  Validates a document based on a schema. Only XML Schema 1.0 is supported.
    
  
  Validates a document based on the given schema file.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The path to the schema.
  <info>int</info>     <strong>$flags</strong>     A bitmask of Libxml schema validation flags. Currently the only supported value
                     is LIBXML_SCHEMA_CREATE. Available since Libxml 2.6.14.

<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>
   * DOMDocument::schemaValidateSource
   * DOMDocument::relaxNGValidate
   * DOMDocument::relaxNGValidateSource
   * DOMDocument::validate


id: DOMDocument::schemaValidateSource
type: function
doc:
<comment>Description:</comment>
  Validates a document based on a schema
    
  
  Validates a document based on a schema defined in the given string.

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>  A string containing the schema.
  <info>int</info>     <strong>$flags</strong>   A bitmask of Libxml schema validation flags. Currently the only supported value
                   is LIBXML_SCHEMA_CREATE. Available since Libxml 2.6.14.

<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>
   * DOMDocument::schemaValidate
   * DOMDocument::relaxNGValidate
   * DOMDocument::relaxNGValidateSource
   * DOMDocument::validate


id: DOMDocument::validate
type: function
doc:
<comment>Description:</comment>
  Validates the document based on its DTD
    
  
  Validates the document based on its DTD.
  
  You can also use the <return>validateOnParse</return> property of  <class>DOMDocument</class> to make a DTD validation.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. If the document has no DTD
        attached, this method will return <info>false</info>.

<comment>See Also:</comment>
   * DOMDocument::schemaValidate
   * DOMDocument::schemaValidateSource
   * DOMDocument::relaxNGValidate
   * DOMDocument::relaxNGValidateSource


id: DOMDocument::xinclude
type: function
doc:
<comment>Description:</comment>
  Substitutes XIncludes in a DOMDocument Object
    
  
  This method substitutes XIncludes in a DOMDocument object.
  
  Due to libxml2 automatically resolving entities, this method will produce unexpected results if
  the included XML file have an attached DTD.

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  Bit a bit <return>OR</return> das constantes de opções da libxml.

<comment>Return:</comment>
  <info>int|false</info>  Returns the number of XIncludes in the document, -1 if some processing failed, or <info>false</info>
             if there were no substitutions.


id: DOMDocumentFragment::append
type: function
doc:
<comment>Description:</comment>
  Appends nodes after the last child node
  
  Appends one or many <strong>$nodes</strong> to the list of children after the last child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes to append. Strings are automatically converted to text nodes.

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

<comment>See Also:</comment>
   * DOMParentNode::append
   * DOMDocumentFragment::prepend


id: DOMDocumentFragment::appendXML
type: function
doc:
<comment>Description:</comment>
  Append raw XML data
  
  Appends raw XML data to a DOMDocumentFragment.
  
  This method is not part of the DOM standard. It was created as a simpler approach for appending an
  XML DocumentFragment in a DOMDocument.
  
  If you want to stick to the standards, you will have to create a temporary DOMDocument with a
  dummy root and then loop through the child nodes of the root of your XML data to append them.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  XML to append.

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


id: DOMDocumentFragment::prepend
type: function
doc:
<comment>Description:</comment>
  Prepends nodes before the first child node
  
  Prepends one or many <strong>$nodes</strong> to the list of children before the first child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes to prepend. Strings are automatically converted to text nodes.

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

<comment>See Also:</comment>
   * DOMParentNode::prepend
   * DOMDocumentFragment::append


id: DOMDocumentFragment::replaceChildren
type: function
doc:
<comment>Description:</comment>
  Replace children in fragment
  
  Replaces the children in the document fragment with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes replacing the children. Strings are automatically converted to
                          text nodes.

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

<comment>See Also:</comment>
   * DOMParentNode::replaceChildren
   * DOMDocumentFragment::append
   * DOMDocumentFragment::prepend


id: DOMDocumentType
type: class
doc:
<comment>Description:</comment>
  Cada <class>DOMDocument</class> possui um atributo <return>doctype</return> cujo valor é ou <info>null</info> ou um objeto <class>DOMDocumentType</class>.


id: DOMElement::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new DOMElement object
    
  
  Creates a new <class>DOMElement</class> object. This object is read only.  It may be appended to a document, but
  additional nodes may not be appended to this node until  the node is associated with a document.
  To create a writeable node, use   or  .

<comment>Param:</comment>
  <info>string</info>       <strong>$qualifiedName</strong>  The tag name of the element. When also passing in namespaceURI, the
                               element name  may take a prefix to be associated with the URI.
  <info>string|null</info>  <strong>$value</strong>          The value of the element.
  <info>string</info>       <strong>$namespace</strong>      A namespace URI to create the element within a specific namespace.

<comment>See Also:</comment>
   * DOMDocument::createElement
   * DOMDocument::createElementNS


id: DOMElement::after
type: function
doc:
<comment>Description:</comment>
  Adds nodes after the element
  
  Adds the passed <strong>$nodes</strong> after the element.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Nodes to be added after the node. Strings are automatically converted to
                          text nodes.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMElement::before


id: DOMElement::append
type: function
doc:
<comment>Description:</comment>
  Appends nodes after the last child node
  
  Appends one or many <strong>$nodes</strong> to the list of children after the last child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes to append. Strings are automatically converted to text nodes.

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

<comment>See Also:</comment>
   * DOMParentNode::append
   * DOMElement::prepend


id: DOMElement::before
type: function
doc:
<comment>Description:</comment>
  Adds nodes before the element
  
  Adds the passed <strong>$nodes</strong> before the element.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Nodes to be added before the node. Strings are automatically converted to
                          text nodes.

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

<comment>See Also:</comment>
   * DOMChildNode::before
   * DOMElement::after


id: DOMElement::getAttribute
type: function
doc:
<comment>Description:</comment>
  Returns value of attribute
  
  Gets the value of the attribute with name <strong>$qualifiedName</strong>  for the current node.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  The name of the attribute.

<comment>Return:</comment>
  <info>string</info>  The value of the attribute, or an empty string if no attribute with the given
          <strong>$qualifiedName</strong> is found.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::setAttribute
   * DOMElement::removeAttribute


id: DOMElement::getAttributeNS
type: function
doc:
<comment>Description:</comment>
  Returns value of attribute
  
  Gets the value of the attribute in namespace <strong>$namespace</strong>  with local name <strong>$localName</strong> for the
  current node.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  The namespace URI.
  <info>string</info>       <strong>$localName</strong>  The local name.

<comment>Return:</comment>
  <info>string</info>  The value of the attribute, or an empty string if no attribute with the given <strong>$localName</strong>
          and <strong>$namespace</strong>  is found.

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::setAttributeNS
   * DOMElement::removeAttributeNS


id: DOMElement::getAttributeNames
type: function
doc:
<comment>Description:</comment>
  Get attribute names
  
  Get attribute names.

<comment>Return:</comment>
  <info>array</info>  Return attribute names.


id: DOMElement::getAttributeNode
type: function
doc:
<comment>Description:</comment>
  Returns attribute node
  
  Returns the attribute node with name <strong>$qualifiedName</strong> for the current element.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  The name of the attribute.

<comment>Return:</comment>
  <info>DOMAttr|DOMNameSpaceNode|false</info>  The attribute node. Note that for XML namespace declarations
                                  (<return>xmlns</return> and <return>xmlns:*</return> attributes) an  instance of <class>DOMNameSpaceNode</class> is
                                  returned instead of a <class>DOMAttr</class>.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::setAttributeNode
   * DOMElement::removeAttributeNode


id: DOMElement::getAttributeNodeNS
type: function
doc:
<comment>Description:</comment>
  Returns attribute node
    
  
  Returns the attribute node in namespace <strong>$namespace</strong>  with local name <strong>$localName</strong> for the current
  node.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  The namespace URI.
  <info>string</info>       <strong>$localName</strong>  The local name.

<comment>Return:</comment>
  <info>DOMAttr|DOMNameSpaceNode|null</info>  The attribute node. Note that for XML namespace declarations (<return>xmlns</return>
                                 and <return>xmlns:*</return> attributes) an  instance of <class>DOMNameSpaceNode</class> is
                                 returned instead of a <class>DOMAttr</class> object.

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::setAttributeNodeNS
   * DOMElement::removeAttributeNode


id: DOMElement::getElementsByTagName
type: function
doc:
<comment>Description:</comment>
  Gets elements by tagname
  
  This function returns a new instance of the class <class>DOMNodeList</class> of all descendant elements with a
  given tag <strong>$qualifiedName</strong>, in the order in which they are encountered in a preorder traversal of
  this element tree.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  The tag name. Use <return>*</return> to return all elements within  the element tree.

<comment>Return:</comment>
  <info>DOMNodeList</info>  This function returns a new instance of the class <class>DOMNodeList</class> of all matched
               elements.

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


id: DOMElement::getElementsByTagNameNS
type: function
doc:
<comment>Description:</comment>
  Get elements by namespaceURI and localName
  
  This function fetch all the descendant elements with a given  <strong>$localName</strong> and <strong>$namespace</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  The namespace URI of the elements to match on. The special value <return>"*"</return>
                           matches all namespaces. Passing <info>null</info> matches the empty namespace.
  <info>string</info>       <strong>$localName</strong>  The local name of the elements to match on. The special value <return>"*"</return> matches
                           all local names.

<comment>Return:</comment>
  <info>DOMNodeList</info>  This function returns a new instance of the class <class>DOMNodeList</class> of all matched elements
               in the order in which they are encountered in a preorder traversal of this element
               tree.

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


id: DOMElement::hasAttribute
type: function
doc:
<comment>Description:</comment>
  Checks to see if attribute exists
  
  Indicates whether attribute named <strong>$qualifiedName</strong>  exists as a member of the element.

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

<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>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttribute
   * DOMElement::setAttribute
   * DOMElement::removeAttribute


id: DOMElement::hasAttributeNS
type: function
doc:
<comment>Description:</comment>
  Checks to see if attribute exists
    
  
  Indicates whether attribute in namespace <strong>$namespace</strong>  named <strong>$localName</strong> exists as a member of the
  element.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  The namespace URI.
  <info>string</info>       <strong>$localName</strong>  The local name.

<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>
   * DOMElement::hasAttribute
   * DOMElement::getAttributeNS
   * DOMElement::setAttributeNS
   * DOMElement::removeAttributeNS


id: DOMElement::insertAdjacentElement
type: function
doc:
<comment>Description:</comment>
  Insert adjacent element
  
  Inserts an element at a relative position given by <strong>$where</strong>.

<comment>Param:</comment>
  <info>string</info>      <strong>$where</strong>    <return>beforebegin</return> - Insert before the target element.<return>afterbegin</return> - Insert as the
                        first child of the target element.<return>beforeend</return> - Insert as the last child of
                        the target element.<return>afterend</return> - Insert after the target element.
  <info>DOMElement</info>  <strong>$element</strong>  The element to insert.

<comment>Return:</comment>
  <info>DOMElement|null</info>  Return <class>DOMElement</class> or <info>null</info> on failure.

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


id: DOMElement::insertAdjacentText
type: function
doc:
<comment>Description:</comment>
  Insert adjacent text
  
  Inserts text at a relative position given by <strong>$where</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$where</strong>  <return>beforebegin</return> - Insert before the target element.<return>afterbegin</return> - Insert as the first
                  child of the target element.<return>beforeend</return> - Insert as the last child of the target
                  element.<return>afterend</return> - Insert after the target element.
  <info>string</info>  <strong>$data</strong>   The string to insert.

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

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


id: DOMElement::prepend
type: function
doc:
<comment>Description:</comment>
  Prepends nodes before the first child node
  
  Prepends one or many <strong>$nodes</strong> to the list of children before the first child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes to prepend. Strings are automatically converted to text nodes.

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

<comment>See Also:</comment>
   * DOMParentNode::prepend
   * DOMElement::append


id: DOMElement::remove
type: function
doc:
<comment>Description:</comment>
  Removes the element
  
  Removes the element.

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

<comment>See Also:</comment>
   * DOMElement::after
   * DOMElement::before
   * DOMElement::replaceWith
   * DOMNode::removeChild


id: DOMElement::removeAttribute
type: function
doc:
<comment>Description:</comment>
  Removes attribute
  
  Removes attribute named <strong>$qualifiedName</strong> from the element.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  The name of the attribute.

<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>
   * DOMElement::hasAttribute
   * DOMElement::getAttribute
   * DOMElement::setAttribute


id: DOMElement::removeAttributeNS
type: function
doc:
<comment>Description:</comment>
  Removes attribute
  
  Removes attribute <strong>$localName</strong> in namespace <strong>$namespace</strong> from the element.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  The namespace URI.
  <info>string</info>       <strong>$localName</strong>  The local name.

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

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttributeNS
   * DOMElement::setAttributeNS


id: DOMElement::removeAttributeNode
type: function
doc:
<comment>Description:</comment>
  Removes attribute
  
  Removes attribute <strong>$attr</strong> from the element.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  The attribute node.

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

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttributeNode
   * DOMElement::setAttributeNode


id: DOMElement::replaceChildren
type: function
doc:
<comment>Description:</comment>
  Replace children in element
  
  Replaces the children in the element with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes replacing the children. Strings are automatically converted to
                          text nodes.

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

<comment>See Also:</comment>
   * DOMParentNode::replaceChildren
   * DOMElement::replaceWith
   * DOMElement::after
   * DOMElement::before
   * DOMElement::remove


id: DOMElement::replaceWith
type: function
doc:
<comment>Description:</comment>
  Replaces the element with new nodes
  
  Replaces the element with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The replacement nodes. Strings are automatically converted to text nodes.

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

<comment>See Also:</comment>
   * DOMChildNode::replaceWith
   * DOMElement::replaceChildren
   * DOMElement::after
   * DOMElement::before
   * DOMElement::remove


id: DOMElement::setAttribute
type: function
doc:
<comment>Description:</comment>
  Adds new or modifies existing attribute
  
  Sets an attribute with name <strong>$qualifiedName</strong> to the given value. If the attribute does not exist, it
  will be created.

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

<comment>Return:</comment>
  <info>DOMAttr|bool</info>  The created or modified <class>DOMAttr</class> or <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttribute
   * DOMElement::removeAttribute


id: DOMElement::setAttributeNS
type: function
doc:
<comment>Description:</comment>
  Adds new attribute
  
  Sets an attribute with namespace <strong>$namespace</strong> and  name <strong>$name</strong> to the given value. If the attribute
  does not exist, it will be created.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>      The namespace URI.
  <info>string</info>       <strong>$qualifiedName</strong>  The qualified name of the attribute, as <return>prefix:tagname</return>.
  <info>string</info>       <strong>$value</strong>          The value of the attribute.

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

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttributeNS
   * DOMElement::removeAttributeNS


id: DOMElement::setAttributeNode
type: function
doc:
<comment>Description:</comment>
  Adds new attribute node to element
  
  Adds new attribute node <strong>$attr</strong> to element.  If an attribute with the same name already exists on
  the element, that attribute is replaced by <strong>$attr</strong>.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  The attribute node.

<comment>Return:</comment>
  <info>DOMAttr|null|false</info>  Returns the old attribute if it has been replaced or <info>null</info> if there was no old
                      attribute. If a <info>DOM_WRONG_DOCUMENT_ERR</info> error is raised, and
                      strictErrorChecking is <info>false</info>, <info>false</info> is returned.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttributeNode
   * DOMElement::removeAttributeNode


id: DOMElement::setAttributeNodeNS
type: function
doc:
<comment>Description:</comment>
  Adds new attribute node to element
  
  Adds new attribute node <strong>$attr</strong> to element, keeping the namespace into account. If an attribute with
  the same name already exists on the element, that attribute is replaced by <strong>$attr</strong>.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  The attribute node.

<comment>Return:</comment>
  <info>DOMAttr|null|false</info>  Returns the old attribute if it has been replaced or <info>null</info> if there was no old
                      attribute. If a <info>DOM_WRONG_DOCUMENT_ERR</info> error is raised, and
                      strictErrorChecking is <info>false</info>, <info>false</info> is returned.

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttributeNodeNS
   * DOMElement::removeAttributeNode


id: DOMElement::setIdAttribute
type: function
doc:
<comment>Description:</comment>
  Declares the attribute specified by name to be of type ID
  
  Declares the attribute <strong>$qualifiedName</strong> to be of type ID.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  The name of the attribute.
  <info>bool</info>    <strong>$isId</strong>           Set it to <info>true</info> if you want <strong>$qualifiedName</strong> to be of type ID, <info>false</info>
                          otherwise.

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

<comment>See Also:</comment>
   * DOMDocument::getElementById
   * DOMElement::setIdAttributeNode
   * DOMElement::setIdAttributeNS


id: DOMElement::setIdAttributeNS
type: function
doc:
<comment>Description:</comment>
  Declares the attribute specified by local name and namespace URI to be of type ID
  
  Declares the attribute specified by <strong>$qualifiedName</strong> and  <strong>$namespace</strong> to be of type ID.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>      The namespace URI of the attribute.
  <info>string</info>  <strong>$qualifiedName</strong>  The local name of the attribute, as <return>prefix:tagname</return>.
  <info>bool</info>    <strong>$isId</strong>           Set it to <info>true</info> if you want <strong>$name</strong> to be of type ID, <info>false</info> otherwise.

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

<comment>See Also:</comment>
   * DOMDocument::getElementById
   * DOMElement::setIdAttribute
   * DOMElement::setIdAttributeNode


id: DOMElement::setIdAttributeNode
type: function
doc:
<comment>Description:</comment>
  Declares the attribute specified by node to be of type ID
  
  Declares the attribute specified by <strong>$attr</strong> to be of type ID.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  The attribute node.
  <info>bool</info>     <strong>$isId</strong>  Set it to <info>true</info> if you want <strong>$name</strong> to be of type ID, <info>false</info> otherwise.

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

<comment>See Also:</comment>
   * DOMDocument::getElementById
   * DOMElement::setIdAttribute
   * DOMElement::setIdAttributeNS


id: DOMElement::toggleAttribute
type: function
doc:
<comment>Description:</comment>
  Toggle attribute
  
  Toggle the attribute.

<comment>Param:</comment>
  <info>string</info>     <strong>$qualifiedName</strong>  The qualified name of the attribute.
  <info>bool|null</info>  <strong>$force</strong>          if <info>null</info>, the function will toggle the attribute.if <info>true</info>, the function
                             adds the attribute.if <info>false</info>, the function removes the attribute.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the attribute is present after finishing the call, <info>false</info> otherwise.


id: DOMEntity
type: class
doc:
<comment>Description:</comment>
  Esta interface representa uma entidade conhecida, seja ela analisada ou não analisada, em um
  documento XML.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the entity reference.

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


id: DOMImplementation
type: class
doc:
<comment>Description:</comment>
  A classe <class>DOMImplementation</class> fornece vários métodos para realizar operações independentes de
  qualquer instância específica do modelo de objeto de documento.


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


id: DOMImplementation::createDocument
type: function
doc:
<comment>Description:</comment>
  Creates a DOMDocument object of the specified type with its document element
    
  
  Creates a <class>DOMDocument</class> object of the specified type with its document element.

<comment>Param:</comment>
  <info>string|null</info>           <strong>$namespace</strong>      The namespace URI of the document element to create.
  <info>string</info>                <strong>$qualifiedName</strong>  The qualified name of the document element to create.
  <info>DOMDocumentType|null</info>  <strong>$doctype</strong>        The type of document to create or <info>null</info>.

<comment>Return:</comment>
  <info>DOMDocument|false</info>  A new <class>DOMDocument</class> object or <info>false</info> on error. If <strong>$namespace</strong>, <strong>$qualifiedName</strong>, and
                     <strong>$doctype</strong> are null, the returned <class>DOMDocument</class> is empty with no document element

<comment>See Also:</comment>
   * DOMDocument::__construct
   * DOMImplementation::createDocumentType


id: DOMImplementation::createDocumentType
type: function
doc:
<comment>Description:</comment>
  Creates an empty DOMDocumentType object
    
  
  Creates an empty <class>DOMDocumentType</class> object. Entity  declarations and notations are not made
  available. Entity reference  expansions and default attribute additions do not occur.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  The qualified name of the document type to create.
  <info>string</info>  <strong>$publicId</strong>       The external subset public identifier.
  <info>string</info>  <strong>$systemId</strong>       The external subset system identifier.

<comment>Return:</comment>
  <info>DOMDocumentType|false</info>  A new <class>DOMDocumentType</class> node with its  <return>ownerDocument</return> set to <info>null</info> or <info>false</info> on
                         error.

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


id: DOMImplementation::hasFeature
type: function
doc:
<comment>Description:</comment>
  Test if the DOM implementation implements a specific feature
    
  
  Test if the DOM implementation implements a specific  <strong>$feature</strong>.
  
  You can find a list of all features in the Conformance section of the DOM specification.

<comment>Param:</comment>
  <info>string</info>  <strong>$feature</strong>  The feature to test.
  <info>string</info>  <strong>$version</strong>  The version number of the <strong>$feature</strong> to test. In  level 2, this can be either <return>2.0</return>
                    or <return>1.0</return>.

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

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


id: DOMNamedNodeMap::count
type: function
doc:
<comment>Description:</comment>
  Get number of nodes in the map
  
  Gets the number of nodes in the map.

<comment>Return:</comment>
  <info>int</info>  Returns the number of nodes in the map, which is identical to the length property.


id: DOMNamedNodeMap::getIterator
type: function
doc:
<comment>Description:</comment>
  Retrieve an external iterator
  
  Returns an external iterator for the named node map.

<comment>Return:</comment>
  <info>Iterator</info>  Uma instância de um objeto que implementa <class>Iterator</class> ou <class>Traversable</class>

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


id: DOMNamedNodeMap::getNamedItem
type: function
doc:
<comment>Description:</comment>
  Retrieves a node specified by name
    
  
  Retrieves a node specified by its <return>nodeName</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  The <return>nodeName</return> of the node to retrieve.

<comment>Return:</comment>
  <info>DOMNode|null</info>  A node (of any type) with the specified <return>nodeName</return>, or  <info>null</info> if no node is found.

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


id: DOMNamedNodeMap::getNamedItemNS
type: function
doc:
<comment>Description:</comment>
  Retrieves a node specified by local name and namespace URI
    
  
  Retrieves a node specified by <strong>$localName</strong> and  <strong>$namespace</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  The namespace URI of the node to retrieve.
  <info>string</info>       <strong>$localName</strong>  The local name of the node to retrieve.

<comment>Return:</comment>
  <info>DOMNode|null</info>  A node (of any type) with the specified local name and namespace URI, or  <info>null</info> if no
                node is found.

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


id: DOMNamedNodeMap::item
type: function
doc:
<comment>Description:</comment>
  Retrieves a node specified by index
  
  Retrieves a node specified by <strong>$index</strong> within the  <class>DOMNamedNodeMap</class> object.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index into this map.

<comment>Return:</comment>
  <info>DOMNode|null</info>  The node at the <strong>$index</strong>th position in the map, or <info>null</info> if that is not a valid index
                (greater than or equal to the number of nodes  in this map).


id: DOMNode::C14N
type: function
doc:
<comment>Description:</comment>
  Canonicalize nodes to a string
  
  Canonicalize nodes to a string

<comment>Param:</comment>
  <info>bool</info>        <strong>$exclusive</strong>     Enable exclusive parsing of only the nodes matched by the provided
                             xpath or namespace prefixes.
  <info>bool</info>        <strong>$withComments</strong>  Retain comments in output.
  <info>array|null</info>  <strong>$xpath</strong>         An array of <return>xpath</return>s to filter the nodes by.
  <info>array|null</info>  <strong>$nsPrefixes</strong>    An array of namespace prefixes to filter the nodes by.

<comment>Return:</comment>
  <info>string|false</info>  Returns canonicalized nodes as a string ou <info>false</info> em caso de falha

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


id: DOMNode::C14NFile
type: function
doc:
<comment>Description:</comment>
  Canonicalize nodes to a file
  
  Canonicalize nodes to a file.

<comment>Param:</comment>
  <info>string</info>      <strong>$uri</strong>           Path to write the output to.
  <info>bool</info>        <strong>$exclusive</strong>     Enable exclusive parsing of only the nodes matched by the provided
                             xpath or namespace prefixes.
  <info>bool</info>        <strong>$withComments</strong>  Retain comments in output.
  <info>array|null</info>  <strong>$xpath</strong>         An array of <return>xpath</return>s to filter the nodes by.
  <info>array|null</info>  <strong>$nsPrefixes</strong>    An array of namespace prefixes to filter the nodes by.

<comment>Return:</comment>
  <info>int|false</info>  Number of bytes written ou <info>false</info> em caso de falha

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


id: DOMNode::appendChild
type: function
doc:
<comment>Description:</comment>
  Adiciona um novo filho ao final dos filhos
    
  
  Esta função acrescenta um filho a uma lista existente de filhos, ou cria uma nova lista de filhos.
  O filho pode ser criado, por exemplo, com DOMDocument::createElement, DOMDocument::createTextNode
  etc. ou simplesmente pode usaando-se qualquer outro nó.
  
  Ao usar um nó existente ele será movido.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>  O nó filho anexado.

<comment>Return:</comment>
  <info>DOMNode|false</info>  O nó adicionado ou <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMNode::insertBefore
   * DOMNode::removeChild
   * DOMNode::replaceChild


id: DOMNode::cloneNode
type: function
doc:
<comment>Description:</comment>
  Clones a node
    
  
  Creates a copy of the node.

<comment>Param:</comment>
  <info>bool</info>  <strong>$deep</strong>  Indicates whether to copy all descendant nodes. This parameter is  defaulted to
               <info>false</info>.

<comment>Return:</comment>
  <info>DOMNode|false</info>  The cloned node.


id: DOMNode::contains
type: function
doc:
<comment>Description:</comment>
  Checks if node contains other node
  
  Checks if node contains <strong>$other</strong> node.

<comment>Param:</comment>
  <info>DOMNode|DOMNameSpaceNode|null</info>  <strong>$other</strong>  Node to be checked.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if node contains <strong>$other</strong> node, <info>false</info> otherwise.


id: DOMNode::getLineNo
type: function
doc:
<comment>Description:</comment>
  Get line number for a node
  
  Gets line number for where the node is defined.

<comment>Return:</comment>
  <info>int</info>  Always returns the line number where the node was defined in.


id: DOMNode::getNodePath
type: function
doc:
<comment>Description:</comment>
  Get an XPath for a node
  
  Gets an XPath location path for the node.

<comment>Return:</comment>
  <info>string|null</info>  Returns a <info>string</info> containing the XPath, or <info>null</info> in case of an error.

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


id: DOMNode::getRootNode
type: function
doc:
<comment>Description:</comment>
  Get root node
  
  Get root node.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  This parameter has no effect yet.

<comment>Return:</comment>
  <info>DOMNode</info>  Returns the root node.


id: DOMNode::hasAttributes
type: function
doc:
<comment>Description:</comment>
  Checks if node has attributes
    
  
  This method checks if the node has attributes. The tested node has to be an <info>XML_ELEMENT_NODE</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>
   * DOMNode::hasChildNodes


id: DOMNode::hasChildNodes
type: function
doc:
<comment>Description:</comment>
  Checks if node has children
    
  
  This function checks if the node has children.

<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>
   * DOMNode::hasAttributes


id: DOMNode::insertBefore
type: function
doc:
<comment>Description:</comment>
  Adds a new child before a reference node
    
  
  This function inserts a new node right before the reference node. If you plan to do further
  modifications on the appended child you must use the returned node.
  
  When using an existing node it will be moved.

<comment>Param:</comment>
  <info>DOMNode</info>       <strong>$node</strong>   The new node.
  <info>DOMNode|null</info>  <strong>$child</strong>  The reference node. If not supplied, <strong>$node</strong> is appended to the children.

<comment>Return:</comment>
  <info>DOMNode|false</info>  The inserted node or <info>false</info> on error.

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


id: DOMNode::isDefaultNamespace
type: function
doc:
<comment>Description:</comment>
  Checks if the specified namespaceURI is the default namespace or not
  
  Tells whether <strong>$namespace</strong> is the default namespace.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  The namespace URI to look for.

<comment>Return:</comment>
  <info>bool</info>  Return <info>true</info> if <strong>$namespace</strong> is the default namespace, <info>false</info> otherwise.


id: DOMNode::isEqualNode
type: function
doc:
<comment>Description:</comment>
  Checks that both nodes are equal
  
  Checks that both nodes are equal.

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$otherNode</strong>  The node.

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


id: DOMNode::isSameNode
type: function
doc:
<comment>Description:</comment>
  Indicates if two nodes are the same node
    
  
  This function indicates if two nodes are the same node. The comparison is not based on content

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$otherNode</strong>  The compared node.

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


id: DOMNode::isSupported
type: function
doc:
<comment>Description:</comment>
  Checks if feature is supported for specified version
    
  
  Checks if the asked <strong>$feature</strong> is supported for the  specified <strong>$version</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$feature</strong>  The feature to test. See the example of  DOMImplementation::hasFeature for a
                    list of features.
  <info>string</info>  <strong>$version</strong>  The version number of the <strong>$feature</strong> to test.

<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>
   * DOMImplementation::hasFeature


id: DOMNode::lookupNamespaceURI
type: function
doc:
<comment>Description:</comment>
  Gets the namespace URI of the node based on the prefix
    
  
  Gets the namespace URI of the node based on the  <strong>$prefix</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$prefix</strong>  The prefix to look for. If this parameter is <info>null</info>, the method will return
                        the default namespace URI, if any.

<comment>Return:</comment>
  <info>string|null</info>  Returns the associated namespace URI or <info>null</info> if none is found.

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


id: DOMNode::lookupPrefix
type: function
doc:
<comment>Description:</comment>
  Gets the namespace prefix of the node based on the namespace URI
    
  
  Gets the namespace prefix of the node based on the namespace URI.

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

<comment>Return:</comment>
  <info>string|null</info>  The prefix of the namespace or <info>null</info> on error.

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


id: DOMNode::normalize
type: function
doc:
<comment>Description:</comment>
  Normalizes the node
    
  
  Remove empty text nodes and merge adjacent text nodes in this node and all its children.

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

<comment>See Also:</comment>
   * The DOM Specification
   * DOMDocument::normalizeDocument


id: DOMNode::removeChild
type: function
doc:
<comment>Description:</comment>
  Removes child from list of children
    
  
  This functions removes a child from a list of children.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$child</strong>  The removed child.

<comment>Return:</comment>
  <info>DOMNode|false</info>  If the child could be removed the function returns the old child or <info>false</info> on error.

<comment>See Also:</comment>
   * DOMChildNode::remove
   * DOMNode::appendChild
   * DOMNode::replaceChild


id: DOMNode::replaceChild
type: function
doc:
<comment>Description:</comment>
  Replaces a child
    
  
  This function replaces the child <strong>$child</strong>  with the passed new node. If the <strong>$node</strong> is already a child
  it  will not be added a second time. If the replacement succeeds the  old node is returned.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>   The new node. It must be a member of the target document, i.e. created by one of
                   the DOMDocument-&gt;createXXX() methods or imported in the document by .
  <info>DOMNode</info>  <strong>$child</strong>  The old node.

<comment>Return:</comment>
  <info>DOMNode|false</info>  The old node or <info>false</info> if an error occur.

<comment>See Also:</comment>
   * DOMChildNode::replaceWith
   * DOMNode::appendChild
   * DOMNode::removeChild


id: DOMNodeList::count
type: function
doc:
<comment>Description:</comment>
  Get number of nodes in the list
  
  Gets the number of nodes in the list.

<comment>Return:</comment>
  <info>int</info>  Returns the number of nodes in the list, which is identical to the length property.


id: DOMNodeList::getIterator
type: function
doc:
<comment>Description:</comment>
  Retrieve an external iterator
  
  Returns an external iterator for the node list.

<comment>Return:</comment>
  <info>Iterator</info>  Uma instância de um objeto que implementa <class>Iterator</class> ou <class>Traversable</class>

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


id: DOMNodeList::item
type: function
doc:
<comment>Description:</comment>
  Retrieves a node specified by index
    
  
  Retrieves a node specified by <strong>$index</strong> within the  <class>DOMNodeList</class> object.
  
  If you need to know the number of nodes in the collection, use  the <return>length</return> property of the
  <class>DOMNodeList</class> object.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the node into the collection.

<comment>Return:</comment>
  <info>DOMElement|DOMNode|DOMNameSpaceNode|null</info>  The node at the <strong>$index</strong>th position in the  <class>DOMNodeList</class>,
                                            or <info>null</info> if that is not a valid index.


id: DOMParentNode::append
type: function
doc:
<comment>Description:</comment>
  Appends nodes after the last child node
  
  Appends one or many <strong>$nodes</strong> to the list of children after the last child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes to append. Strings are automatically converted to text nodes.

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

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


id: DOMParentNode::prepend
type: function
doc:
<comment>Description:</comment>
  Prepends nodes before the first child node
  
  Prepends one or many <strong>$nodes</strong> to the list of children before the first child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes to prepend. Strings are automatically converted to text nodes.

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

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


id: DOMParentNode::replaceChildren
type: function
doc:
<comment>Description:</comment>
  Replace children in node
  
  Replace children in node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes replacing the children. Strings are automatically converted to
                          text nodes.

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


id: DOMProcessingInstruction::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new DOMProcessingInstruction object
    
  
  Creates a new <class>DOMProcessingInstruction</class> object. This object is read only. It may be appended to a
  document, but  additional nodes may not be appended to this node until  the node is associated
  with a document. To create a writeable node, use  .

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

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


id: DOMSTRING_SIZE_ERR
type: constant
doc:
<comment>Description:</comment>
  Se o tamanho do texto especificado não couber em <class>DOMString</class>.


id: DOMText
type: class
doc:
<comment>Description:</comment>
  A classe <class>DOMText</class> herda de <class>DOMCharacterData</class> e representa o conteúdo textua de um elemento
  <class>DOMElement</class> ou <class>DOMAttr</class>.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The value of the text node. If not supplied an empty text node is created.

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


id: DOMText::isElementContentWhitespace
type: function
doc:
<comment>Description:</comment>
  Returns whether this text node contains whitespace in element content

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


id: DOMText::isWhitespaceInElementContent
type: function
doc:
<comment>Description:</comment>
  Indicates whether this text node contains whitespace
    
  
  Indicates whether this text node contains only whitespace or it is empty. The text node is
  determined to contain whitespace in element content during the load of the document.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if node contains zero or more whitespace characters and nothing else. Returns
        <info>false</info> otherwise.


id: DOMText::splitText
type: function
doc:
<comment>Description:</comment>
  Quebra este nó em dois nós no deslocamento especificado
    
  
  Quebra este nó em dois no <strong>$offset</strong> especificado, mantendo ambos na árvore como irmãos.
  
  Depois de dividido, esse nó conterá todo o conteúdo até o <strong>$offset</strong>. Se o nó original tinha um nó
  pai, o novo nó será inserido como o próximo irmão do nó original. Quando o <strong>$offset</strong> for igual ao
  tamanho desse nó, o novo nó não terá dados.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  O deslocamento para dividir, começando em 0.

<comment>Return:</comment>
  <info>DOMText|false</info>  O novo nó do mesmo tipo, que contém todo o conteúdo durante e após o <strong>$offset</strong>.


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

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$document</strong>  The <class>DOMDocument</class> associated with the  <class>DOMXPath</class>.


id: DOMXPath::evaluate
type: function
doc:
<comment>Description:</comment>
  Evaluates the given XPath expression and returns a typed result if possible
    
  
  Executes the given XPath <strong>$expression</strong> and returns a typed result if possible.

<comment>Param:</comment>
  <info>string</info>        <strong>$expression</strong>      The XPath expression to execute.
  <info>DOMNode|null</info>  <strong>$contextNode</strong>     The optional <strong>$contextNode</strong> can be specified for doing relative XPath
                                 queries. By default, the queries are relative to  the root element.
  <info>bool</info>          <strong>$registerNodeNS</strong>  The optional <strong>$registerNodeNS</strong> can be specified to  disable automatic
                                 registration of the context node.

<comment>Return:</comment>
  <info>mixed</info>  Returns a typed result if possible or a <class>DOMNodeList</class>  containing all nodes matching the
         given XPath <strong>$expression</strong>.
         
         If the <strong>$expression</strong> is malformed or the <strong>$contextNode</strong> is invalid, DOMXPath::evaluate returns
         <info>false</info>.

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


id: DOMXPath::query
type: function
doc:
<comment>Description:</comment>
  Evaluates the given XPath expression 
    
  
  Executes the given XPath <strong>$expression</strong>.

<comment>Param:</comment>
  <info>string</info>        <strong>$expression</strong>      The XPath expression to execute.
  <info>DOMNode|null</info>  <strong>$contextNode</strong>     The optional <strong>$contextNode</strong> can be specified for doing relative XPath
                                 queries. By default, the queries are relative to  the root element.
  <info>bool</info>          <strong>$registerNodeNS</strong>  The optional <strong>$registerNodeNS</strong> can be specified to  disable automatic
                                 registration of the context node.

<comment>Return:</comment>
  <info>mixed</info>  Returns a <class>DOMNodeList</class> containing all nodes matching the given XPath <strong>$expression</strong>. Any
         expression which does not return nodes will return an empty <class>DOMNodeList</class>.
         
         If the <strong>$expression</strong> is malformed or the <strong>$contextNode</strong> is invalid, DOMXPath::query returns
         <info>false</info>.

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


id: DOMXPath::registerNamespace
type: function
doc:
<comment>Description:</comment>
  Registers the namespace with the DOMXPath object
    
  
  Registers the <strong>$namespace</strong> and  <strong>$prefix</strong> with the DOMXPath object.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>     The prefix.
  <info>string</info>  <strong>$namespace</strong>  The URI of the namespace.

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


id: DOMXPath::registerPhpFunctions
type: function
doc:
<comment>Description:</comment>
  Register PHP functions as XPath functions
  
  This method enables the ability to use PHP functions within XPath expressions.

<comment>Param:</comment>
  <info>string|array|null</info>  <strong>$restrict</strong>  Use this parameter to only allow certain functions to be called from
                                XPath.
                                
                                This parameter can be either a <info>string</info> (a function name) or  an <info>array</info>
                                of function names.

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

<comment>See Also:</comment>
   * DOMXPath::registerNamespace
   * DOMXPath::query
   * DOMXPath::evaluate


id: DOM_INDEX_SIZE_ERR
type: constant
doc:
<comment>Description:</comment>
  Se o índice ou tamanho for negativo, ou maior do que o permitido.


id: DOM_INUSE_ATTRIBUTE_ERR
type: constant
doc:
<comment>Description:</comment>
  Se ocorrer a tentativa de adicionar um atributo que já está em uso em outro lugar.


id: DOM_INVALID_ACCESS_ERR
type: constant
doc:
<comment>Description:</comment>
  Se o parâmetro ou operação não é suportada pelo objeto subjacente.


id: DOM_INVALID_CHARACTER_ERR
type: constant
doc:
<comment>Description:</comment>
  Se um caracter inválido é utilizado, como por exemplo em um nome.


id: DOM_INVALID_MODIFICATION_ERR
type: constant
doc:
<comment>Description:</comment>
  If an attempt is made to modify the type of the underlying object.


id: DOM_NAMESPACE_ERR
type: constant
doc:
<comment>Description:</comment>
  Se uma tentativa de criar ou modificar um objeto incorretamente considerando namespaces.


id: DOM_NOT_FOUND_ERR
type: constant
doc:
<comment>Description:</comment>
  Se ocorrer uma tentativa de referênciar um nó em um contexto onde o mesmo não existe.


id: DOM_NOT_SUPPORTED_ERR
type: constant
doc:
<comment>Description:</comment>
  Se a implementação não suportar o tipo de objeto ou operação solicitados.


id: DOM_NO_MODIFICATION_ALLOWED_ERR
type: constant
doc:
<comment>Description:</comment>
  Se ocorrer uma tentativa de modificação é feita em um objeto que não permite modificações


id: DOM_PHP_ERR
type: constant
doc:
<comment>Description:</comment>
  Código não pertencente á especificação DOM. Significativa apenas para erros do PHP


id: DOM_VALIDATION_ERR
type: constant
doc:
<comment>Description:</comment>
  Se uma chamada á um método como insertBefore ou removeChild invalidar o nó respeitando a
  "validação parcial", essa exceção será lançada e a operação não será realizada.


id: DOM_WRONG_DOCUMENT_ERR
type: constant
doc:
<comment>Description:</comment>
  Se um nó é utilizado em um documento diferente ao qual foi criado


id: DatabaseObject::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  Check if object exists in database
  
  Verifies if the database object refers to an object that exists in the database.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if object exists in the database, else <info>false</info> if it does not.


id: DatabaseObject::getName
type: function
doc:
<comment>Description:</comment>
  Get object name
  
  Fetch name of this database object.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>string</info>  The name of this database object.


id: DatabaseObject::getSession
type: function
doc:
<comment>Description:</comment>
  Get session name
  
  Fetch session associated to the database object.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  The Session object.


id: DateInterval
type: class
doc:
<comment>Description:</comment>
  Representa um intervalo entre datas.
  
  Um intervalo de data armazena, tanto uma quantidade de tempo (em anos, meses, dias, horas, etc),
  quanto uma string de tempo relativo no formato que os construtores das classes <class>DateTimeImmutable</class> e
  <class>DateTime</class> suportam.
  
  Mais especificamente, a informação em um objeto da classe <class>DateInterval</class> é uma instrução para mover
  de uma data/hora para outra data/hora. Este processo nem sempre é reversível.
  
  Uma maneira comum de criar um objeto <class>DateInterval</class> é calculando a diferença entre dois objetos
  data/hora através do método DateTimeInterface::diff.
  
  Como não existe uma maneira bem definida de comparar intervalos de datas, as instâncias de
  <class>DateInterval</class> são incomparáveis.


id: DateInterval::__construct
type: function
doc:
<comment>Description:</comment>
  Cria um novo objeto DateInterval
  
  Cria um novo objeto DateInterval.

<comment>Param:</comment>
  <info>string</info>  <strong>$duration</strong>  Uma especificação de intervalo.
                     
                     O formato inicia-se com a letra <return>P</return>, de período. Cada período de duração é
                     representado por um valor inteiro seguido do designador de período. Se a
                     duração conter elementos de tempo, essa porção da especificação é precedida
                     pela letra <return>T</return>.
                     
                     <strong>$duration</strong> Designadores de Período Designador de
                     PeríodoDescrição<return>Y</return>anos<return>M</return>meses<return>D</return>dias<return>W</return> semanas. Convertidas em dias. Antes do PHP
                     8.0.0, não pode ser combinada com <return>D</return>. <return>H</return>horas<return>M</return>minutos<return>S</return>segundos
                     
                     Alguns exemplos simples. Dois dias é representado com <return>P2D</return>. Dois segundos é
                     representado com <return>PT2S</return>. Seis anos e cinco minutos é representado com <return>P6YT5M</return>.
                     
                     O tipo de unidade deve ser inserida da unidade de maior escala a esquerda da de
                     menor escala, essa a direta. Então, anos antes de meses, meses antes de dias,
                     dias antes de minutos, e etc. Assim, um ano e quatro dias deve ser representado
                     com <return>P1Y4D</return>, e não <return>P4D1Y</return>.
                     
                     A especificação também pode ser representada como data e hora. Um exemplo de um
                     ano e quatro dias seria <return>P0001-00-04T00:00:00</return>. Porém, valores neste formato não
                     podem exceder o tamanho máximo do período (por exemplo <return>25</return> horas é inválido).
                     
                     Estes formatos são baseados na ISO 8601 duration specification.

<comment>See Also:</comment>
   * <strong>DateInterval::format()</strong>
   * <strong>DateTime::add()</strong>
   * <strong>DateTime::sub()</strong>
   * <strong>DateTime::diff()</strong>


id: DateInterval::createFromDateString
type: function
doc:
<comment>Description:</comment>
  Cria um DateInterval de porções relativas da string
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Utiliza o interpretador de data/hora como no construtor da classe <class>DateTimeImmutable</class> para criar um
  <class>DateInterval</class> a partir das partes relacionadas de uma string analisada.

<comment>Param:</comment>
  <info>string</info>  <strong>$datetime</strong>  Uma data com porções relativas. Especificamente, os formatos relativos
                     suportados pelo analisador utilizados em <class>DateTimeImmutable</class>, <class>DateTime</class> e
                     <strong>strtotime()</strong> serão utilizados para construir o DateInterval.
                     
                     Para usar um string no formato ISO-8601 como <return>P7D</return>, você deve usar o construtor.

<comment>Return:</comment>
  <info>DateInterval|false</info>  Retorna uma nova instância de <class>DateInterval</class> em caso de sucesso,  ou <info>false</info> em
                      caso de falha.


id: DateInterval::format
type: function
doc:
<comment>Description:</comment>
  Formata um intervalo
  
  Formata um intervalo.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>   Os caracteres a seguir são reconhecidos como string no parâmetro <strong>$format</strong>. Cada
                   um dos caracteres de formato deve ser precedidos com o sinal de porcento (<return>%</return>).
                   Caracter de <strong>$format</strong>DescriçãoExemplo de valores<return>%</return><return>%</return> literal<return>%</return><return>Y</return>Anos, em representação
                   numérica, com dois dígitos e zero à esquerda<return>01</return>, <return>03</return><return>y</return>Anos, em representação
                   numérica<return>1</return>, <return>3</return><return>M</return>Meses, em representação numérica, com dois dígitos e zero à
                   esquerda<return>01</return>, <return>03</return>, <return>12</return><return>m</return>Meses, em representação numérica<return>1</return>, <return>3</return>, <return>12</return><return>D</return>Dias, em
                   representação numérica, com dois dígitos e zero à esquerda<return>01</return>, <return>03</return>, <return>31</return><return>d</return>Dias, em
                   representação numérica<return>1</return>, <return>3</return>, <return>31</return><return>a</return>Número total de dias resultante de DateTime::diff
                   ou <return>(unknown)</return>, caso contrário<return>4</return>, <return>18</return>, <return>8123</return><return>H</return>Horas, em representação numérica, com
                   dois dígitos e zero à esquerda<return>01</return>, <return>03</return>, <return>23</return><return>h</return>Horas, em representação numérica<return>1</return>, <return>3</return>,
                   <return>23</return><return>I</return>Minutos, em representação numérica, com dois dígitos e zero à esquerda<return>01</return>, <return>03</return>,
                   <return>59</return><return>i</return>Minutos, em representação numérica<return>1</return>, <return>3</return>, <return>59</return><return>S</return>Segundos, em representação
                   numérica, com dois dígitos e zero à esquerda<return>01</return>, <return>03</return>, <return>57</return><return>s</return>Segundos, em representação
                   numérica<return>1</return>, <return>3</return>, <return>57</return><return>F</return>Microssegundos, numérico, pelo menos 6 dígitos precedidos com
                   0<return>007701</return>, <return>052738</return>, <return>428291</return><return>f</return>Microssegundos, numérico<return>7701</return>, <return>52738</return>, <return>428291</return><return>R</return>Sinal "<return>-</return>"
                   quando negativo, "<return>+</return>" quando positivo<return>-</return>, <return>+</return><return>r</return>Sinal "<return>-</return>" quando negativo, sem sinal
                   quando positivo<return>-</return>,

<comment>Return:</comment>
  <info>string</info>  Retorna o intervalo formatado.

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


id: DatePeriod
type: class
doc:
<comment>Description:</comment>
  Representa um período entre datas.
  
  O período entre datas permite a interação entre um conjunto de datas e horários recorrentes a
  intervalos regulares, durante um determinado período.


id: DatePeriod::EXCLUDE_START_DATE
type: constant
doc:
<comment>Description:</comment>
  Exclui a data inicial, utilizada em <strong>DatePeriod::__construct()</strong>.


id: DatePeriod::INCLUDE_END_DATE
type: constant
doc:
<comment>Description:</comment>
  Inclui a data final, utilizado em <strong>DatePeriod::__construct()</strong>.


id: DatePeriod::__construct
type: function
doc:
<comment>Description:</comment>
  Cria um novo objeto DatePeriod
  
  Esta variante do construtor está obsoleta, use o método DatePeriod::createFromISO8601String.
  
  Cria um objeto DatePeriod.
  
  Objetos <class>DatePeriod</class> podem ser usados como um iterador para gerar um número de objetos
  <class>DateTimeImmutable</class> ou <class>DateTime</class> a partir de uma data inicial (<strong>$start</strong>), um intervalo (<strong>$interval</strong>), e
  uma data final (<strong>$end</strong>) ou o número de recorrências (<strong>$recurrences</strong>).
  
  A classe do objeto retornado é equivalente à classe ancestral <class>DateTimeImmutable</class> ou <class>DateTime</class> do
  objeto do parâmetro <strong>$start</strong>.

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$start</strong>        A data inicial do período. Incluído por padrão no conjunto de
                                   resultados.
  <info>DateInterval</info>       <strong>$interval</strong>     A recorrência de intervalos entre os períodos.
  <info>int</info>                <strong>$recurrences</strong>  O número de recorrências. O número do resultado retornado é uma
                                   unidade a mais que isto, já que a data de início é incluída no
                                   conjunto de resultados por padrão. Deve ser maior que <return>0</return>.
  <info>DateTimeInterface</info>  <strong>$end</strong>          A data final do período.
  <info>string</info>             <strong>$isostr</strong>       Um sobconjunto da ISO 8601 repeating interval specification.
                                   
                                   Exemplos de algumas características de especificação de
                                   intervalos ISO 8601 que o PHP não suporta são:
                                   
                                   zero ocorrências (<return>R0/</return>)
                                   
                                   fusos horários diferentes de UTC (<return>Z</return>), como <return>+02:00</return>.
  <info>int</info>                <strong>$options</strong>      Um campo de bits que pode ser usado para controlar certos
                                   comportamentos com datas de início e fim.
                                   
                                   Com <info>DatePeriod::EXCLUDE_START_DATE</info> você exclui a data inicial do
                                   conjunto de datas recorrentes dentro do período.
                                   
                                   Com <info>DatePeriod::INCLUDE_END_DATE</info> você inclui a data final do
                                   conjunto de datas recorrentes dentro do período.


id: DatePeriod::createFromISO8601String
type: function
doc:
<comment>Description:</comment>
  Cria um novo objeto DatePeriod a partir de uma string ISO8601
  
  Cria um novo objeto DatePeriod a partir de uma string ISO8601, como especificado no parâmetro
  <strong>$specification</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$specification</strong>  Um subconjunto da especificação ISO 8601 de intervalos repetitivos.
                          
                          Um exemplo de uma especificação de intervalo ISO 8601 aceitável é
                          <return>R5/2008-03-01T13:00:00Z/P1Y2M10DT2H30M</return>, que especifica:
                          
                          5 iterações (<return>R5/</return>)
                          
                          Inicia em <return>2008-03-01T13:00:00Z</return>.
                          
                          Cada iteração ocorrem em um intervalo de 1 ano, 2 meses, 10 dias, 2 horas
                          e 30 minutos (<return>/P1Y2M10DT2H30M</return>).
                          
                          Exemplo de recursos de especificação de intervalos ISO 8601 que o PHP não
                          suporta são:
                          
                          zero ocorrências (<return>R0/</return>)
                          
                          deslocamento de fuso horário que não seja UTC (<return>Z</return>), como em <return>+02:00</return>.
  <info>int</info>     <strong>$options</strong>        Um campo de bits que pode ser utilizado para controlar certos
                          comportamentos com datas iniciais e finais.
                          
                          Com <info>DatePeriod::EXCLUDE_START_DATE</info>, pode-se excluir a data inicial do
                          conjunto de datas recorrentes dentro do período.
                          
                          Com <info>DatePeriod::INCLUDE_END_DATE</info>, pode-se incluir a data final no conjunto
                          de datas recorrentes dentro do período.

<comment>Return:</comment>
  <info>static</info>  Retorna um novo objeto DatePeriod.
          
          Objetos <class>DatePeriod</class> criados com este método podem ser usador como um iterador para gerar um
          número de objetos <class>DateTimeImmutable</class>.


id: DatePeriod::getDateInterval
type: function
doc:
<comment>Description:</comment>
  Obtém o intervalo
    
  
  Estilo orientado a objetos
  
  Obtém um <info>object</info> da classe <class>DateInterval</class> representando o intervalo usado para o período.

<comment>Return:</comment>
  <info>DateInterval</info>  Retorna um <info>object</info> <class>DateInterval</class>.

<comment>See Also:</comment>
   * DatePeriod::getStartDate
   * DatePeriod::getEndDate


id: DatePeriod::getEndDate
type: function
doc:
<comment>Description:</comment>
  Obtém a data final
    
  
  Estilo orientado a objetos
  
  Obtém a data final do período.

<comment>Return:</comment>
  <info>DateTimeInterface|null</info>  Retorna <info>null</info> se o <class>DatePeriod</class> não tiver uma data final. Por exemplo, quando
                          inicializado com o parâmetro <strong>$recurrences</strong> ou <strong>$isostr</strong> sem uma data final.
                          
                          Retorna um <info>object</info> <class>DateTimeImmutable</class> quando o <class>DatePeriod</class> é inicializado com
                          um <info>object</info> <class>DateTimeImmutable</class> no parâmetro <strong>$end</strong>.
                          
                          Caso contrário, retorna um clone do <info>object</info> <class>DateTime</class> representando a data
                          final.

<comment>See Also:</comment>
   * DatePeriod::getStartDate
   * DatePeriod::getDateInterval


id: DatePeriod::getRecurrences
type: function
doc:
<comment>Description:</comment>
  Obtém o número de recorrências
  
  Estilo orientado a objetos
  
  Obtém Obtém o número de recorrências.

<comment>Return:</comment>
  <info>int|null</info>  O número de recorrências como definido explicitamente pelo parâmetro <return>$recurrences</return>
            passado ao contrutor da classe <class>DatePeriod</class>, ou <info>null</info> caso não tenha sido definido.

<comment>See Also:</comment>
   * DatePeriod::$recurrences


id: DatePeriod::getStartDate
type: function
doc:
<comment>Description:</comment>
  Obtém a data inicial
    
  
  Estilo orientado a objetos
  
  Obtém a data inicial do período.

<comment>Return:</comment>
  <info>DateTimeInterface</info>  Retorna um <info>object</info> <class>DateTimeImmutable</class> quando o <class>DatePeriod</class> é inicializado com um
                     <info>object</info> <class>DateTimeImmutable</class> no parâmetro <strong>$start</strong>.
                     
                     Caso contrário, retorna um <info>object</info> <class>DateTime</class>.

<comment>See Also:</comment>
   * DatePeriod::getEndDate
   * DatePeriod::getDateInterval


id: DateTime
type: class
doc:
<comment>Description:</comment>
  Representação de data e hora.
  
  Esta classe se comporta da mesma maneira que a classe <class>DateTimeImmutable</class>, exceto pelo fato de que
  os objetos se alteram quando métodos de modificação como <strong>DateTime::modify()</strong> são chamados.
  
  Chamar métodos em objetos da classe <class>DateTime</class> irá alterar a informação encapsulada nestes objetos.
  Se você quiser evitar isso, terá que usar o operador <return>clone</return> para criar um novo objeto. É
  recomendado usar <class>DateTimeImmutable</class> no lugar de <class>DateTime</class> para obter este comportamento por padrão.


id: DateTime::__construct
type: function
doc:
<comment>Description:</comment>
  Retorna um novo objeto DateTime
  
  Equivalente a DateTimeImmutable::__construct mas funciona com <class>DateTime</class>. Considere usar
  <class>DateTimeImmutable</class> e suas caracterísitcas.
  
  Retorna um novo objeto DateTime.

<comment>Param:</comment>
  <info>string</info>             <strong>$datetime</strong>  Uma string de data/hora. Os formatos válidos são explicados em
                                Formatos de Data e Hora.
                                
                                Coloque <return>"now"</return> neste parâmetro para obter o horário atual quando
                                utilizar o parâmetro <strong>$timezone</strong>.
  <info>DateTimeZone|null</info>  <strong>$timezone</strong>  Um objeto <class>DateTimeZone</class>, representando o fuso horário do parâmetro
                                <strong>$datetime</strong>.
                                
                                Se <strong>$timezone</strong> for <info>null</info> ou omitido, o fuso horário atual será
                                utilizado.
                                
                                O parâmetro <strong>$timezone</strong> e o fuso horário atual são ignorados quando o
                                parâmetro <strong>$datetime</strong> é um timestamp UNIX (exemplo, <return>@946684800</return>) ou
                                quando o fuso horário é informado (exemplo.
                                <return>2010-01-28T15:00:00+02:00</return>).

<comment>Return:</comment>
  <info>unknown</info>  Retorna uma nova instância de DateTime.

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


id: DateTime::__set_state
type: function
doc:
<comment>Description:</comment>
  O manipulador __set_state
  
  O manipulador __set_state().
  
  Equivalente a DateTimeImmutable::__set_state mas funciona com <class>DateTime</class>.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  Inicialização do array.

<comment>Return:</comment>
  <info>DateTime</info>  Retorna uma nova instância de um objeto DateTime.


id: DateTime::__wakeup
type: function
doc:
<comment>Description:</comment>
  O manipulador __wakeup
  
  O manipulador __wakeup().

<comment>Return:</comment>
  <info>void</info>  Inicializa o objeto DateTime.


id: DateTime::add
type: function
doc:
<comment>Description:</comment>
  Modifica um objeto DateTime, com adição de dias, meses, anos, horas, minutos e segundos.
    
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Adiciona o objeto <class>DateInterval</class> informado a um objeto <class>DateTime</class> especificado.
  
  Equivalente a DateTimeImmutable::add mas funciona com <class>DateTime</class>.
  
  A versão procedural usa o objeto <class>DateTime</class> como primeiro argumento.

<comment>Param:</comment>
  <info>DateTime</info>      <strong>$object</strong>    Somente no estilo procedural: Um objeto <class>DateTime</class>
                           retornado por <strong>date_create()</strong>.
                           A função modifica este objeto.
  <info>DateInterval</info>  <strong>$interval</strong>  Um objeto <class>DateInterval</class>

<comment>Return:</comment>
  <info>DateTime</info>  Retorna o objeto <class>DateTime</class> modificado para encadeamento de métodos.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::add()</strong>


id: DateTime::createFromFormat
type: function
doc:
<comment>Description:</comment>
  Interpreta um string de data/hora de acordo com um formato especificado.
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna um novo objeto DateTime representando a data e a hora especificadas pelo string <strong>$datetime</strong>,
  que foi formatado de acordo com o parâmetro <strong>$format</strong> fornecido.
  
  Equivalente a DateTimeImmutable::createFromFormat e <strong>date_create_immutable_from_format()</strong>,
  respectivamente, mas cria um objeto <class>DateTime</class>.
  
  Este método, incluindo parâmetros, exemplos e considerações estão documentados na página
  DateTimeImmutable::createFromFormat.

<comment>Return:</comment>
  <info>DateTime|false</info>  Retorna uma nova instância de DateTime ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::createFromFormat()</strong>


id: DateTime::createFromImmutable
type: function
doc:
<comment>Description:</comment>
  Retorna uma nova instância de DateTime encapsulando o objeto DateTimeImmutable informado

<comment>Param:</comment>
  <info>DateTimeImmutable</info>  <strong>$object</strong>  O objeto imutável <class>DateTimeImmutable</class> que necessita ser convertido para
                              uma versão mutável. Este objeto não é modificado, em vez disso uma
                              nova instância <class>DateTime</class> é criada contendo as mesmas informações de
                              data, horário e fuso.

<comment>Return:</comment>
  <info>static</info>  Retorna uma nova instância <class>DateTime</class>.


id: DateTime::createFromInterface
type: function
doc:
<comment>Description:</comment>
  Retorna um novo objeto DateTime encapsulando o objeto DateTimeInterface informado

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  O objeto <class>DateTimeInterface</class> que necessita ser convertido para uma
                              versão mutável. Este objeto não é modificado, em vez disso uma nova
                              instância <class>DateTime</class> é criada contendo as mesmas informações de data,
                              horário e fuso.

<comment>Return:</comment>
  <info>DateTime</info>  Retorna uma nova instância de <class>DateTime</class>.


id: DateTime::diff
type: function
doc:
<comment>Description:</comment>
  Retorna a diferença entre dois objetos DateTime
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna a diferença entre dois objetos que implementam a classe <class>DateTimeInterface</class>.

<comment>Param:</comment>
  <info></info>      <strong>$datetime</strong>  A data a ser comparada.
  <info>bool</info>  <strong>$absolute</strong>  O intervalo deve ser forçado como positivo?

<comment>Return:</comment>
  <info>DateInterval</info>  O objeto <class>DateInterval</class> representa a diferença entre as duas datas.
                
                O valor de retorno representa mais especificamente o intervalo de tempo a ser
                aplicado ao objeto original (<strong>$this</strong> or <strong>$originObject</strong>) para se chegar ao
                <strong>$targetObject</strong>. Este processo nem sempre é reversível.
                
                O método leva em conta mudanças de horário de verão, e por isso pode retornar um
                intervalo de <return>24 horas e 30 minutos</return>, por exemplo. Se você quiser fazer cálculos com
                horários absolutos, você precisa converter tanto <strong>$this</strong>/<strong>$baseObject</strong> quanto
                <strong>$targetObject</strong> para UTC primeiro.

<comment>See Also:</comment>
   * <strong>DateInterval::format()</strong>
   * <strong>DateTime::add()</strong>
   * <strong>DateTime::sub()</strong>


id: DateTime::format
type: function
doc:
<comment>Description:</comment>
  Retorna a data formatada de acordo com um formato informado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna a data formatada de acordo com um formato informado.

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  Somente no estilo procedural: Um objeto <class>DateTime</class>
                              retornado por <strong>date_create()</strong>
  <info>string</info>             <strong>$format</strong>  O formato da <info>string</info> de data resultante. Veja abaixo as opções de
                              formatação. Existem também várias constantes de data predefinidas que
                              podem ser usadas, por exemplo, <info>DATE_RSS</info> contém a string de formatação
                              <return>'D, d M Y H:i:s'</return>.
                              
                              Os seguintes caracteres são reconhecidos na string do parâmetro
                              <strong>$format</strong>Caractere <strong>$format</strong>DescriçãoExemplo de valores
                              retornadosDia------<return>d</return>Dia do mês, 2 digits com zeros à esquerda<return>01</return> a
                              <return>31</return><return>D</return>Uma representação textual de um dia, três letras<return>Mon</return> a <return>Sun</return><return>j</return>Dia do
                              mês sem zeros à esquerda<return>1</return> a <return>31</return><return>l</return> (lowercase 'L')Uma representação
                              textual completa do dia da semana<return>Sunday</return> a <return>Saturday</return><return>N</return>Representação
                              numérica ISO 8601 do dia da semana<return>1</return> (para segunda-feira) a <return>7</return> (para
                              domingo)<return>S</return>Sufixo ordinal inglês para o dia do mês, 2 caracteres<return>st</return>, <return>nd</return>,
                              <return>rd</return> ou <return>th</return>. Funciona bem com <return>j</return> <return>w</return>Representação numérica do dia da semana<return>0</return>
                              (para domingo) a <return>6</return> (para sábado)<return>z</return>O dia do ano (começando em 0)<return>0</return> a
                              <return>365</return>Semana------<return>W</return>Número da semana do mês ISO 8601, semanas começando na
                              segunda-feiraExemplo: <return>42</return> (a 42ª semana no ano)Mês------<return>F</return>Uma
                              representação textual completa do mês, como January ou March<return>January</return> a
                              <return>December</return><return>m</return>Representação numérica de um mês, com zeros à esquerda<return>01</return> a
                              <return>12</return><return>M</return>Uma representação textual curta de um mês, três letras<return>Jan</return> a
                              <return>Dec</return><return>n</return>Representação numérica de um mês, sem zeros à esquerda<return>1</return> a
                              <return>12</return><return>t</return>Número de dias em determinado mês<return>28</return> a <return>31</return>Ano------<return>L</return>Se é um ano
                              bissexto<return>1</return> se for um ano bissexto, <return>0</return> caso contrário.<return>o</return>Ano de numeração
                              da semana ISO 8601. Tem o mesmo valor que <return>Y</return>, exceto que se o número da
                              semana ISO (<return>W</return>) pertencer ao ano anterior ou seguinte, esse ano será
                              usado.Exemplos: <return>1999</return> ou <return>2003</return><return>X</return>Uma representação numérica completa
                              expandida de um ano, pelo menos 4 dígitos, com <return>-</return> para anos AEC, e <return>+</return>
                              para anos EC.Exemplos: <return>-0055</return>, <return>+0787</return>, <return>+1999</return>, <return>+10191</return><return>x</return>Uma representação
                              numérica completa expandida se necessário, ou uma representação
                              numérica completa padrão se possível (como <return>Y</return>). Pelo menos quatro
                              dígitos. Anos AEC são prefixados com um <return>-</return>. Anos além de (e incluindo)
                              <return>10000</return> são prefixados com um <return>+</return>.Exemplos: <return>-0055</return>, <return>0787</return>, <return>1999</return>, <return>+10191</return><return>Y</return>Uma
                              representação numérica completa de um ano, pelo menos 4 dígitos, com <return>-</return>
                              para anos AEC.Exemplos: <return>-0055</return>, <return>0787</return>, <return>1999</return>, <return>2003</return>, <return>10191</return><return>y</return>Uma
                              representação de dois digitos do anoExemplos: <return>99</return> ou <return>03</return>Hora------<return>a</return>Ante
                              meridiem e Post meridiem em letras minúsculas<return>am</return> ou <return>pm</return><return>A</return>Ante meridiem e
                              Post meridiem em letras maiúsculas<return>AM</return> ou <return>PM</return><return>B</return>Internet Time da Swatch<return>000</return>
                              a <return>999</return><return>g</return>Formato de 12 horas de uma hora sem zeros à esquerda<return>1</return> a
                              <return>12</return><return>G</return>Formato de 24 horas de uma hora sem zeros à esquerda<return>0</return> a <return>23</return><return>h</return>Formato
                              de 12 horas de uma hora com zeros à esquerda<return>01</return> a <return>12</return><return>H</return>Formato de 24
                              horas de uma hora com zeros à esquerda<return>00</return> a <return>23</return><return>i</return>Minutos com zeros à
                              esquerda<return>00</return> to <return>59</return><return>s</return>Segundos com zeros à esquerda<return>00</return> a <return>59</return><return>u</return> Microssegundos.
                              Note que <strong>date()</strong> sempre irá gerar <return>000000</return> uma vez que leva um parâmetro
                              <info>int</info>, enquanto DateTime::format suporta microssegundos se <class>DateTime</class> foi
                              criada com microssegundos. Exemplo: <return>654321</return><return>v</return> Millisegundos. A mesma
                              nota se aplica como no <return>u</return>. Exemplo: <return>654</return>Fuso horário------<return>e</return>Identificador
                              do fuso horárioExemplos: <return>UTC</return>, <return>GMT</return>, <return>Atlantic/Azores</return><return>I</return> (i maiúsculo)Se a
                              data está ou não no horário de verão<return>1</return> se está no horário de verão, <return>0</return>
                              caso contrário.<return>O</return>Diferença para o horário de Greenwich (GMT) sem dois
                              pontos entre horas e minutosExample: <return>+0200</return><return>P</return>Diferença para o horário de
                              Greenwich (GMT) com dois pontos entre horas e minutosExemplo: <return>+02:00</return><return>p</return>
                              O mesmo que <return>P</return>, mas retorna <return>Z</return> em vez de <return>+00:00</return> (disponível a partir do
                              PHP 8.0.0) Exemplo: <return>Z</return> or <return>+02:00</return><return>T</return>Abreviação do fuso horário, se
                              conhecido; ou o deslocamento GMT caso contrário.Exemplos: <return>EST</return>, <return>MDT</return>,
                              <return>+05</return><return>Z</return>Deslocamento do fuso horário em segundos. O deslocamento para
                              fusos a oeste de UTC é sempre negativo, e para aqueles a leste de UTC
                              é sempre positivo.<return>-43200</return> a <return>50400</return>Data/Hora completa------<return>c</return>Data ISO
                              86012004-02-12T15:19:21+00:00<return>r</return>Data formatada RFC 2822/RFC 5322Exemplo:
                              <return>Thu, 21 Dec 2000 16:01:07 +0200</return><return>U</return>Segundos desde a Era Unix (1 de
                              janeiro de 1970 00:00:00 GMT)Veja também <strong>time()</strong>
                              
                              Caracteres não reconhecidos na string de formatação serão impressos
                              como estão. O formato <return>Z</return> sempre retornará <return>0</return> ao usar <strong>gmdate()</strong>.
                              
                              Uma vez que esta função só aceita timestamps <info>int</info>, o caractere de
                              formato <return>u</return> só é útil ao usar a função <strong>date_format()</strong> com timestamps
                              baseados no usuário criados com <strong>date_create()</strong>.

<comment>Return:</comment>
  <info>string</info>  Retorna a data formatada em caso de sucesso.

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


id: DateTime::getLastErrors
type: function
doc:
<comment>Description:</comment>
  Sinônimo de DateTimeImmutable::getLastErrors
  
  Esta função é um apelido para:  DateTimeImmutable::getLastErrors


id: DateTime::getOffset
type: function
doc:
<comment>Description:</comment>
  Retorna o deslocamento do fuso horário
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o deslocamento do fuso horário.

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  Somente no estilo procedural: Um objeto <class>DateTime</class>
                              retornado por <strong>date_create()</strong>

<comment>Return:</comment>
  <info>int</info>  Retorna o deslocamento do fuso horário, em segundos, para UTC em caso de sucesso.


id: DateTime::getTimestamp
type: function
doc:
<comment>Description:</comment>
  Obtém o timestamp Unix
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Obtém o timestamp Unix.

<comment>Return:</comment>
  <info>int</info>  Retorna o timestamp Unix que representa a data.

<comment>See Also:</comment>
   * <strong>DateTime::setTimestamp()</strong>
   * <strong>DateTimeImmutable::setTimestamp()</strong>
   * <strong>DateTimeInterface::format()</strong>


id: DateTime::getTimezone
type: function
doc:
<comment>Description:</comment>
  Retorna o fuso horário correspondente a um DateTime informado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o fuso horário de um DateTime informado

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  Somente no estilo procedural: Um objeto <class>DateTime</class>
                              retornado por <strong>date_create()</strong>

<comment>Return:</comment>
  <info>DateTimeZone|false</info>  Retorna um objeto <class>DateTimeZone</class> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>DateTime::setTimezone()</strong>


id: DateTime::modify
type: function
doc:
<comment>Description:</comment>
  Altera o timestamp
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Altera o timestamp de um objeto DateTime, incrementando-o ou decrementando-o, em um formato aceito
  pela função <strong>DateTimeImmutable::__construct()</strong>.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>    Somente no estilo procedural: Um objeto <class>DateTime</class>
                       retornado por <strong>date_create()</strong>.
                       A função modifica este objeto.
  <info>string</info>    <strong>$modifier</strong>  Uma string de data/hora. Os formatos válidos são explicados em Formatos de
                       Data e Hora.

<comment>Return:</comment>
  <info>DateTime|false</info>  Retorna o objeto <class>DateTime</class> modificado para encadeamento de métodos ou <info>false</info> em caso
                  de falha.

<comment>See Also:</comment>
   * <strong>strtotime()</strong>
   * <strong>DateTimeImmutable::modify()</strong>
   * <strong>DateTime::add()</strong>
   * <strong>DateTime::sub()</strong>
   * <strong>DateTime::setDate()</strong>
   * <strong>DateTime::setISODate()</strong>
   * <strong>DateTime::setTime()</strong>
   * <strong>DateTime::setTimestamp()</strong>


id: DateTime::setDate
type: function
doc:
<comment>Description:</comment>
  Define a data
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Redefine a data atual do objeto Datetime para uma diferente.
  
  Equivalente a DateTimeImmutable::setDate mas funciona com <class>DateTime</class>, e modifica o objeto existente.
  
  A versão procedural usa o objeto <class>DateTime</class> como seu primeiro argumento.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>  Somente no estilo procedural: Um objeto <class>DateTime</class>
                     retornado por <strong>date_create()</strong>.
                     A função modifica este objeto.
  <info>int</info>       <strong>$year</strong>    Ano da data.
  <info>int</info>       <strong>$month</strong>   Mês da data.
  <info>int</info>       <strong>$day</strong>     Dia da data.

<comment>Return:</comment>
  <info>DateTime</info>  Retorna o objeto <class>DateTime</class> modificado para encadeamento de métodos.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setDate()</strong>


id: DateTime::setISODate
type: function
doc:
<comment>Description:</comment>
  Define uma data ISO
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Define uma data, de acordo com o padrão ISO 8601 - utilizando a diferença de semanas e dias em vez
  de datas específicas.
  
  Equivalente a DateTimeImmutable::setISODate mas funciona com <class>DateTime</class>.
  
  A versão procedural usa o objeto <class>DateTime</class> como seu primeiro argumento.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>     Somente no estilo procedural: Um objeto <class>DateTime</class>
                        retornado por <strong>date_create()</strong>.
                        A função modifica este objeto.
  <info>int</info>       <strong>$year</strong>       Ano da data.
  <info>int</info>       <strong>$week</strong>       Semana da data.
  <info>int</info>       <strong>$dayOfWeek</strong>  Diferença do primeiro dia da semana.

<comment>Return:</comment>
  <info>DateTime</info>  Retorna o objeto <class>DateTime</class> modificado para encadeamento de métodos.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setISODate()</strong>


id: DateTime::setTime
type: function
doc:
<comment>Description:</comment>
  Define o horário
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Redefine o horário atual do objeto DateTime para um diferente.
  
  Equivalente a DateTimeImmutable::setTime mas funciona com <class>DateTime</class>.
  
  A versão procedural usa o objeto <class>DateTime</class> como seu primeiro argumento.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>       Somente no estilo procedural: Um objeto <class>DateTime</class>
                          retornado por <strong>date_create()</strong>.
                          A função modifica este objeto.
  <info>int</info>       <strong>$hour</strong>         Horas do horário.
  <info>int</info>       <strong>$minute</strong>       Minutos do horário.
  <info>int</info>       <strong>$second</strong>       Segundos do horário.
  <info>int</info>       <strong>$microsecond</strong>  Microssegundos do horário.

<comment>Return:</comment>
  <info>DateTime</info>  Retorna o objeto <class>DateTime</class> modificado para encadeamento de métodos.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setTime()</strong>


id: DateTime::setTimestamp
type: function
doc:
<comment>Description:</comment>
  Define a data e hora baseada em um timestamp Unix
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Define a data e hora baseada em um timestamp Unix.
  
  Equivalente a DateTimeImmutable::setTimestamp mas funciona com <class>DateTime</class>.
  
  A versão procedural usa o objeto <class>DateTime</class> como seu primeiro argumento.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>     Somente no estilo procedural: Um objeto <class>DateTime</class>
                        retornado por <strong>date_create()</strong>.
                        A função modifica este objeto.
  <info>int</info>       <strong>$timestamp</strong>  Timestam Unix representando a data. Configurar o timestamp fora dos limites
                        de <info>int</info> é possível utilizando o método DateTimeImmutable::modify com o
                        formato <return>@</return>.

<comment>Return:</comment>
  <info>DateTime</info>  Retorna o objeto <class>DateTime</class> modificado para encadeamento de métodos.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setTimestamp()</strong>


id: DateTime::setTimezone
type: function
doc:
<comment>Description:</comment>
  Define o fuso horário de um objeto DateTime
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Define um novo fuso horário a um objeto (<info>object</info>) <class>DateTime</class>.
  
  Equivalente a DateTimeImmutable::setTimezone mas funciona com <class>DateTime</class>.
  
  A versão procedural usa o objeto <class>DateTime</class> como seu primeiro argumento.

<comment>Param:</comment>
  <info>DateTime</info>      <strong>$object</strong>    Somente no estilo procedural: Um objeto <class>DateTime</class>
                           retornado por <strong>date_create()</strong>.
                           A função modifica este objeto.
  <info>DateTimeZone</info>  <strong>$timezone</strong>  Um objeto <class>DateTimeZone</class> que representa o fuso horário desejado.

<comment>Return:</comment>
  <info>DateTime</info>  Retorna o objeto da classe <class>DateTime</class> para ligação de métodos. O ponto no tempo subjacente
            não é modificado quando este método é chamado.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setTimezone()</strong>
   * <strong>DateTime::getTimezone()</strong>
   * <strong>DateTimeZone::__construct()</strong>


id: DateTime::sub
type: function
doc:
<comment>Description:</comment>
  Subtrai uma quantidade de dias, meses, anos, horas, minutos e segundos de
     um objeto DateTime
    
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Modifica o objeto DateTime especificado, subtraindo o objeto <class>DateInterval</class> especificado.
  
  Equivalente a DateTimeImmutable::sub mas funciona com <class>DateTime</class>.
  
  A versão procedural usa o objeto <class>DateTime</class> como seu primeiro argumento.

<comment>Param:</comment>
  <info>DateTime</info>      <strong>$object</strong>    Somente no estilo procedural: Um objeto <class>DateTime</class>
                           retornado por <strong>date_create()</strong>.
                           A função modifica este objeto.
  <info>DateInterval</info>  <strong>$interval</strong>  Um objeto <class>DateInterval</class>

<comment>Return:</comment>
  <info>DateTime</info>  Retorna o objeto <class>DateTime</class> modificado para encadeamento de métodos.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::sub()</strong>


id: DateTimeImmutable
type: class
doc:
<comment>Description:</comment>
  Representação de data e hora.
  
  Esta classe se comporta como a classe <class>DateTime</class> exceto pelo fato de que novos objetos são
  retornados quando métodos de modificação como <strong>DateTime::modify()</strong> são chamados.


id: DateTimeImmutable::__construct
type: function
doc:
<comment>Description:</comment>
  Retorna um novo objeto DateTimeImmutable
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna um novo objeto DateTimeImmutable.

<comment>Param:</comment>
  <info>string</info>             <strong>$datetime</strong>  Uma string de data/hora. Os formatos válidos são explicados em
                                Formatos de Data e Hora.
                                
                                Utilize <return>"now"</return> para obter o horário atual quando usar o
                                parâmetro<strong>$timezone</strong>.
  <info>DateTimeZone|null</info>  <strong>$timezone</strong>  Um objeto <class>DateTimeZone</class> representando o fuso horário do parâmetro
                                <strong>$datetime</strong>.
                                
                                Se <strong>$timezone</strong> for <info>null</info> ou omitido, o fuso horário atual será
                                utilizado.
                                
                                O parâmetro <strong>$timezone</strong> e o fuso horário atual são ignorados quando o
                                parâmetro <strong>$datetime</strong> for um timestamp UNIX (ex.: <return>@946684800</return>) ou
                                especificar um fuso horário (ex.: <return>2010-01-28T15:00:00+02:00</return> ou
                                <return>2010-07-05T06:00:00Z</return>).

<comment>Return:</comment>
  <info>DateTimeImmutable|false</info>  Retorna uma nova instância de DateTimeImmutable.


id: DateTimeImmutable::__set_state
type: function
doc:
<comment>Description:</comment>
  O manipulador __set_state
  
  O manipulador __set_state().

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  Array de inicialização.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retorna uma nova instância de um objeto DateTimeImmutable.


id: DateTimeImmutable::add
type: function
doc:
<comment>Description:</comment>
  Retorna um novo objeto, com adição de dias, meses, anos, horas, minutos e segundos
    
  
  Cria um novo objeto <class>DateTimeImmutable</class>, e adiciona o objeto <class>DateInterval</class> a ele, para representar o
  novo valor.

<comment>Param:</comment>
  <info>DateInterval</info>  <strong>$interval</strong>  Um objeto <class>DateInterval</class>

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retorna um novo objeto <class>DateTimeImmutable</class> com os dados modificados.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::sub()</strong>
   * <strong>DateTimeImmutable::diff()</strong>
   * <strong>DateTimeImmutable::modify()</strong>


id: DateTimeImmutable::createFromFormat
type: function
doc:
<comment>Description:</comment>
  Interpreta um string de data/hora de acordo com o formato especificado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna um novo objeto DateTimeImmutable representando a data e o horário especificados pelo
  string <strong>$datetime</strong>, formatado pelo parâmetro <strong>$format</strong>.

<comment>Param:</comment>
  <info>string</info>             <strong>$format</strong>    O formato no qual a <info>string</info> passada deve estar. Veja as opções de
                                formatação abaixo. Na maioria dos casos, as mesmas letras da função
                                <strong>date()</strong> podem ser usadas.
                                
                                Todos os campos são inicializados com a data/hora atual. Na maioria
                                das vezes, você pode querer "zerá-los" (época Unix, <return>1970-01-01
                                00:00:00 UTC</return>). Isto pode ser feito incluindo o caractere <return>!</return> como o
                                primeiro no parâmetro <strong>$format</strong>, ou <return>|</return> como o último. Favor verificar a
                                documentação para cada caractere abaixo para mais informação.
                                
                                O formato é analisado da esquerda para a direita, o que significa
                                que em algumas situações a ordem na qual os caracteres de formato
                                estão presents afeta o resultado. No caso de <return>z</return> (o dia do ano), é
                                necessário que um ano já tenha sido analisado, por exemplo através
                                dos caracteres <return>Y</return> ou <return>y</return>.
                                
                                Letras que são usadas para representar números permitem uma ampla
                                gama de valores, fora do que seria a faixa lógica. Por exemplo, a
                                letra <return>d</return> (dia do mês) aceita valores na faixa de <return>00</return> a <return>99</return>. A única
                                restrição é o número de dígitos. O mecanismo de overflow do
                                analisador é usado quando valores fora da faixa são especificados.
                                Os exemplos abaixo mostram alguns destes comportamentos.
                                
                                Isto também significa que os dados analisados para um caractere de
                                formatação são ambiciosos, e irão ler até a quantidade de dígitos
                                que o formato permite. Isto pode também então significar que não há
                                mais caracteres suficientes na string do parâmetro <strong>$datetime</strong> para os
                                caracteres de formato seguintes. Um exemplo nesta página também
                                ilustra este problema.
                                
                                Os seguintes caracteres são reconhecidos na string do parâmetros
                                <strong>$format</strong>Caractere de <strong>$format</strong>DescriçãoExemplo de valores
                                analisáveisDia------<return>d</return> e <return>j</return>Dia do mês, 2 dígitos com ou sem zeros na
                                frente<return>01</return> a <return>31</return> ou <return>1</return> a <return>31</return>. (números de 2 dígitos maiores queo número
                                de dias no mês são aceitos, e neste caso irão causar uma
                                transferência no mês. Por exemplo, usar 33 com janeiro, significa 2
                                de fevereiro) <return>D</return> e <return>l</return>Uma representação textual de um dia<return>Mon</return> a <return>Sun</return> ou
                                <return>Sunday</return> a <return>Saturday</return>. Se o nome do dia informado for diferente do nome
                                do dia pertencente a uma data analisada (ou data padrão), então uma
                                transferência ocorre para a próxima data com o nome do dia
                                informado. Veja os exemplos abaixo para uma explicação. <return>S</return>Sufixo em
                                inglês para o ordinal do dia do mês, 2 caracteres. É ignorado
                                durante o processamento.<return>st</return>, <return>nd</return>, <return>rd</return> ou <return>th</return>. <return>z</return> O dia do ano (iniciando
                                em 0); deve ser precedido de <return>Y</return> ou <return>y</return>. <return>0</return> a <return>365</return>. (números de 3 dígitos
                                maiores que o número de dias em um ano são aceitos, e neste caso
                                case irão causar uma transferência de ano. Por exemplo, usar 366 com
                                2022, siginifica 2 de janeiro de 2023) Mês------<return>F</return> e <return>M</return>Uma
                                representação textual do mês, como January ou Sept<return>January</return> a <return>December</return>
                                ou <return>Jan</return> a <return>Dec</return> <return>m</return> e <return>n</return>Representação numérica de um mês, com ou sem zeros
                                na frente<return>01</return> a <return>12</return> ou <return>1</return> a <return>12</return>. (números de 2 dígitos maiores que 12 são
                                aceitos, e neste caso eles irão causar uma transferência de ano. Por
                                exemplo, usar 13 significa janeiro do ano seguinte) Ano------<return>X</return> e
                                <return>x</return>Uma representação numérica completa de um ano, com até 19 dígitos,
                                opcionalmente prefixada por <return>+</return> ou <return>-</return>Exemplos: <return>0055</return>, <return>787</return>, <return>1999</return>, <return>-2003</return>,
                                <return>+10191</return><return>Y</return>Uma representação numérica completa de um ano, com até 4
                                dígitosExemplos: <return>0055</return>, <return>787</return>, <return>1999</return>, <return>2003</return><return>y</return> Uma representação de dois
                                dígitos de um ano (que assume-se estar na faixa 1970-2069,
                                inclusive)  Exemplos: <return>99</return> ou <return>03</return> (que será interpretado como <return>1999</return> e
                                <return>2003</return>, respectivamente) Horário------<return>a</return> e <return>A</return>Ante meridiem e Post
                                meridiem<return>am</return> ou <return>pm</return><return>g</return> e <return>h</return>Formato de 12 horas para uma hora com ou sem
                                zeros na frente<return>1</return> a <return>12</return> ou <return>01</return> a <return>12</return> (números de 2 dígitos maiores que
                                12 são aceitos, e neste caso eles irão causar uma transferência de
                                período AM/PM. Por exemplo, usar <return>14</return> significa <return>02</return> no próximo período
                                AM/PM) <return>G</return> e <return>H</return>Formato de 24 horas para uma hora com ou sem zeros na
                                frente<return>0</return> a <return>23</return> ou <return>00</return> a <return>23</return> (números de 2 dígitos maiores que 24 são
                                aceitos, e neste caso eles irão causar uma transferência de dia. Por
                                exemplo, usar <return>26</return> significa <return>02:00</return> do dia seguinte) <return>i</return>Minutos com zero
                                na frente<return>00</return> a <return>59</return>. (números de 2 dígitos maiores que 59 são aceitos,
                                e neste caso irão causar uma transferência de hora. Por exemplo,
                                usar <return>66</return> significa <return>:06</return> da hora seguinte) <return>s</return>Segundos, com zero na
                                frente<return>00</return> a <return>59</return> (números de 2 dígitos maiores que 59 são aceitos, e
                                neste caso irão causar uma transferência de minuto. Por exemplo,
                                usar <return>90</return> significa <return>:30</return> do próximo minuto) <return>v</return>Fração em milissegundos
                                (até três dígitos)Exemplo: <return>12</return> (<return>0.12</return> segundo), <return>345</return> (<return>0.345</return>
                                segundo)<return>u</return>Fração em microssegundos (até seis dígitos)Exemplo: <return>45</return>
                                (<return>0.45</return> segundo) <return>654321</return> (<return>0.654321</return> segundo)Fuso horário------<return>e</return>, <return>O</return>, <return>P</return> e
                                <return>T</return> Identificador do fuso horário, ou a diferença para UTC em horas,
                                ou a diferença para UTC com dois pontos entre horas e minutos, ou
                                abreviação do fuso horárioExemplos: <return>UTC</return>, <return>GMT</return>, <return>Atlantic/Azores</return> ou
                                <return>+0200</return> ou <return>+02:00</return> ou <return>EST</return>, <return>MDT</return> Data/Hora completa------<return>U</return>Segundos desde
                                a Época Unix (1 janeiro 1970 00:00:00 GMT)Exemplo: <return>1292177455</return>Espaços
                                em branco e separadores------<return> </return> (espaço)Zero ou mais espaços,
                                tabulações, caracteres NBSP (U+A0), ou NNBSP (U+202F)Exemplo: <return>"\t"</return>,
                                <return>"  "</return><return>#</return> Um dos símbolos de separação: <return>;</return>, <return>:</return>, <return>/</return>, <return>.</return>, <return>,</return>, <return>-</return>, <return>(</return> ou <return>)</return>
                                Exemplo: <return>/</return><return>;</return>, <return>:</return>, <return>/</return>, <return>.</return>, <return>,</return>, <return>-</return>, <return>(</return> or <return>)</return> O caractere especificado.Exemplo:
                                <return>-</return><return>?</return>Um byte aleatórioExemplo: <return>^</return> (Esteja ciente que para caracteres
                                UTF-8 você poderá precisar de mais de um <return>?</return>. Neste caso, usar <return>*</return> pode
                                ser o que você precisa na verdade)<return>*</return>Bytes aleatórios até o próximo
                                separador ou dígitoExemplo: <return>*</return> em <return>Y-*-d</return> com o string <return>2009-aWord-08</return>
                                será equivalente a <return>aWord</return><return>!</return>Reconfigura todos os campos (ano, mês, dia,
                                hora, minuto, segundo, fração e informação de fuso horário) com
                                valores tipo zero ( <return>0</return> para hora, munuto, segundo e fração, <return>1</return> para
                                mês e dia, <return>1970</return> para ano e <return>UTC</return> para informação de fuso horário)Sem
                                <return>!,</return> todos os campos serão configurados com a data/hora
                                atual.<return>|</return>Reconfigura todos os campos (ano, mês, dia, hora, minuto,
                                segundo, fração e informação de fuso horário) com valores tipo zero
                                se eles ainda não foram analisados<return>Y-m-d|</return> irá configurar o ano, mês e
                                dia para as informações encontradas na string a ser analisada, e
                                configura a hora, minuto e segundo para 0.<return>+</return>Se esta especificação de
                                formato estiver presente, dados no final da string não irão causar
                                um erro, mas sim um avisoUse DateTimeImmutable::getLastErrors para
                                descobrir se dados no final da string estavam presentes.
                                
                                Caracteres não reconhecidos na string de formatação irão causar
                                falha na análise e uma mensagem de erro será anexada na estrutura
                                retornada. É possível recuperar a mensagem de erro com
                                DateTimeImmutable::getLastErrors.
                                
                                Para incluir caracteres literais no parâmetro <strong>$format</strong>, deve-se usar
                                a barra invertida (<return>\</return>) antes deles.
                                
                                Se <strong>$format</strong> não contiver o caractere <return>!</return> então partes da data/hora
                                gerada que não foram especificadas em <strong>$format</strong> serão configuradas
                                para a data/hora atual do sistema.
                                
                                Se <strong>$format</strong> contiver o caractere <return>!</return>, então partes da data/hora gerada
                                não especificada em <strong>$format</strong>, assim como valores à esquerda de <return>!</return>,
                                serão configuradas aos valores correspondentes da época Unix.
                                
                                Se algum caractere de horário for analisado, então todos os outros
                                campos relacionados a horário são configurados para "0", a menos que
                                também tenham sido analisados.
                                
                                A Época Unix é 1970-01-01 00:00:00 UTC.
  <info>string</info>             <strong>$datetime</strong>  String representando a data/hora.
  <info>DateTimeZone|null</info>  <strong>$timezone</strong>  Um objeto <class>DateTimeZone</class> representando o fuso horário desejado.
                                
                                Se <strong>$timezone</strong> for <info>null</info> ou omitido e <strong>$datetime</strong> não contém o fuso
                                horário, o fuso atual será usado.
                                
                                O parâmetro <strong>$timezone</strong> e o fuso horário atual são ignorados quando o
                                parâmetro <strong>$datetime</strong> contém um timestamp UNIX (ex.: <return>946684800</return>) ou
                                especifica um fuso horário (ex.: <return>2010-01-28T15:00:00+02:00</return>).

<comment>Return:</comment>
  <info>DateTimeImmutable|false</info>  Retorna uma nova instância de DateTimeImmutable ou <info>false</info> em caso de
                           falha.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::__construct()</strong>
   * <strong>DateTimeImmutable::getLastErrors()</strong>
   * <strong>checkdate()</strong>
   * <strong>strptime()</strong>


id: DateTimeImmutable::createFromInterface
type: function
doc:
<comment>Description:</comment>
  Retorna um novo objeto DateTimeImmutable encapsulando o objeto DateTimeInterface informado

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  O objeto <class>DateTimeInterface</class> que necessita ser convertido para uma
                              versão mutável. Este objeto não é modificado, em vez disso uma nova
                              instância <class>DateTimeImmutable</class> é criada contendo as mesmas informações de
                              data, horário e fuso.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retorna uma nova instância de <class>DateTimeImmutable</class>.


id: DateTimeImmutable::createFromMutable
type: function
doc:
<comment>Description:</comment>
  Retorna uma nova instância DateTimeImmutable que encapsula um objeto DateTime informado

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>  O objeto mutável <class>DateTime</class> que se deseja converter para uma versão imutável.
                     Este objeto não é modificado, mas em vez disso uma nova instância de
                     <class>DateTimeImmutable</class> é criado contendo a mesma data/hora e informação de fuso
                     horário.

<comment>Return:</comment>
  <info>static</info>  Retorna uma nova instância de <class>DateTimeImmutable</class>.


id: DateTimeImmutable::getLastErrors
type: function
doc:
<comment>Description:</comment>
  Retorna os avisos e erros
  
  Retorna um array de avisos e erros encontrados durante a análise de uma string de data/hora.

<comment>Return:</comment>
  <info>array|false</info>  Retorna um array contendo informação sobre avisos e erros, ou <info>false</info> se não houver nem
               avisos nem erros.


id: DateTimeImmutable::modify
type: function
doc:
<comment>Description:</comment>
  Cria um novo objeto com seu timestamp modificado
  
  Cria um novo objeto <info>DateTimeImmutable</info> com seu timestamp modificado. O objeto original não é
  modificado.

<comment>Param:</comment>
  <info>string</info>  <strong>$modifier</strong>  Uma string de data/hora. Os formatos válidos são explicados em Formatos de Data
                     e Hora.

<comment>Return:</comment>
  <info>DateTimeImmutable|false</info>  Retorna um novo objeto DateTimeImmutable modificado ou <info>false</info> em caso de
                           falha.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::add()</strong>
   * <strong>DateTimeImmutable::sub()</strong>
   * <strong>DateTimeImmutable::setDate()</strong>
   * <strong>DateTimeImmutable::setISODate()</strong>
   * <strong>DateTimeImmutable::setTime()</strong>
   * <strong>DateTimeImmutable::setTimestamp()</strong>


id: DateTimeImmutable::setDate
type: function
doc:
<comment>Description:</comment>
  Define a data
  
  Retorna um novo objeto DateTimeImmutable com a data atual do objeto DateTimeImmutable configurado
  com a data fornecida.

<comment>Param:</comment>
  <info></info>     <strong>$object</strong>  Somente no estilo procedural: Um objeto <class>DateTime</class>
                retornado por <strong>date_create()</strong>.
                A função modifica este objeto.
  <info>int</info>  <strong>$year</strong>    Ano da data.
  <info>int</info>  <strong>$month</strong>   Mês da data.
  <info>int</info>  <strong>$day</strong>     Dia da data.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retorna um novo objeto <class>DateTimeImmutable</class> com os dados modificados.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setISODate()</strong>
   * <strong>DateTimeImmutable::setTime()</strong>


id: DateTimeImmutable::setISODate
type: function
doc:
<comment>Description:</comment>
  Define a data ISO
  
  Retorna um novo objeto DateTimeImmutable com a data configurada de acordo com o padrão ISO 8601 -
  usa semanas e deslocamentos de dias no lugar de datas específicas.

<comment>Param:</comment>
  <info>int</info>  <strong>$year</strong>       Year of the date.
  <info>int</info>  <strong>$week</strong>       Week of the date.
  <info>int</info>  <strong>$dayOfWeek</strong>  Offset from the first day of the week.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retorna um novo objeto <class>DateTimeImmutable</class> com os dados modificados.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setDate()</strong>
   * <strong>DateTimeImmutable::setTime()</strong>


id: DateTimeImmutable::setTime
type: function
doc:
<comment>Description:</comment>
  Define um horário
  
  Retorna um novo objeto DateTimeImmutable configurado com o horário fornecido.

<comment>Param:</comment>
  <info>int</info>  <strong>$hour</strong>         Hora do horário.
  <info>int</info>  <strong>$minute</strong>       Minuto do horário.
  <info>int</info>  <strong>$second</strong>       Segundo do horário.
  <info>int</info>  <strong>$microsecond</strong>  Microssegundo do horário.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retorna um novo objeto <class>DateTimeImmutable</class> com os dados modificados.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setDate()</strong>
   * <strong>DateTimeImmutable::setISODate()</strong>


id: DateTimeImmutable::setTimestamp
type: function
doc:
<comment>Description:</comment>
  Define a data e o horário com base em um timestamp Unix
  
  Retorna um novo objeto <info>DateTimeImmutable</info> construído a partir do antigo, com a data e o horário
  configurados com base em um timestamp Unix.

<comment>Param:</comment>
  <info>int</info>  <strong>$timestamp</strong>  Timestamp Unix representando a data e horário. Configurar timestamps fora dos
                   limites de <info>int</info> é possível usando DateTimeImmutable::modify com o formato <return>@</return>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retorna um novo objeto <class>DateTimeImmutable</class> com os dados modificados.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::getTimestamp()</strong>


id: DateTimeImmutable::setTimezone
type: function
doc:
<comment>Description:</comment>
  Define o fuso horário
  
  Retorna um novo objeto DateTimeImmutable com um novo fuso horário configurado.

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$timezone</strong>  Um objeto <class>DateTimeZone</class> representando o fuso horário desejado.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retorna um novo objeto <class>DateTimeImmutable</class> modificado para ligação de método. O
                     ponto no tempo subjacente não é modificado quando este médoto é chamado.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::getTimezone()</strong>
   * <strong>DateTimeZone::__construct()</strong>


id: DateTimeImmutable::sub
type: function
doc:
<comment>Description:</comment>
  Subtrai uma quantidade de dias, meses, anos, horas, minutos e segundos
    
  
  Retorna um novo objeto <class>DateTimeImmutable</class>, com o objeto <class>DateInterval</class> especificado substraído do
  objeto DateTimeImmutable original.

<comment>Param:</comment>
  <info>DateInterval</info>  <strong>$interval</strong>  Um objeto <class>DateInterval</class>

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retorna um novo objeto <class>DateTimeImmutable</class> com os dados modificados.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::add()</strong>
   * <strong>DateTimeImmutable::diff()</strong>
   * <strong>DateTimeImmutable::modify()</strong>


id: DateTimeInterface
type: class
doc:
<comment>Description:</comment>
  DateTimeInterface foi criada para que os parâmetros, variáveis de retorno ou declarações de tipo
  de propriedades aceitem tanto <class>DateTimeImmutable</class> ou <class>DateTime</class> como um valor. Não é possível
  implementar esta interface em classes no espaço de usuário.
  
  Constantes comuns que permitem formatar objetos <class>DateTimeImmutable</class> ou <class>DateTime</class> através de
  DateTimeImmutable::format e DateTime::format também são definidas nesta interface.


id: DateTimeZone::__construct
type: function
doc:
<comment>Description:</comment>
  Cria um novo objeto DateTimeZone
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Cria um novo objeto DateTimeZone.
  
  Um objeto DateTimeZone dá acesso a três diferentes tipos de regras de fuso horário: deslocamento
  UTC (tipo <return>1</return>), abreviação de fuso (tipo <return>2</return>), e identificadores de fuso horário como publicado no
  banco de dados de fusos horários da IANA (tipo <return>3</return>).
  
  O objeto DateTimeZone pode ser anexado aos objetos <class>DateTime</class> e <class>DateTimeImmutable</class> para que sejam
  capazes de mostrar o fuso horário encapsulado por estes objetos em um fuso horário local.

<comment>Param:</comment>
  <info>string</info>  <strong>$timezone</strong>  Um dos nomes de fuso horário suportados, um valor de deslocamento (+0200), ou
                     um identificador de fuso (BST).

<comment>Return:</comment>
  <info>DateTimeZone|false</info>  Retorna um objeto <class>DateTimeZone</class> em caso de sucesso. Estilo procedural retorna
                      <info>false</info> em caso de falha.


id: DateTimeZone::getLocation
type: function
doc:
<comment>Description:</comment>
  Retorna informações da localização de um fuso horário
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna informações da localização de um fuso horário, incluindo o código do país,
  latitude/longitude e comentários.

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$object</strong>  Somente no estilo procedural: Um objeto <class>DateTimeZone</class>
                         retornado por <strong>timezone_open()</strong>

<comment>Return:</comment>
  <info>array|false</info>  Array contendo informações da localização de um fuso horário ou <info>false</info> em caso de
               falha.

<comment>See Also:</comment>
   * <strong>DateTimeZone::listIdentifiers()</strong> para obter uma lista completa
   ou parcial de todos os identificadores de fuso horário suportados


id: DateTimeZone::getName
type: function
doc:
<comment>Description:</comment>
  Retorna o nome do fuso horário
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o nome do fuso horário.

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$object</strong>  O objeto <class>DateTimeZone</class> do qual se deseja obter o nome.

<comment>Return:</comment>
  <info>string</info>  Dependendo do tipo do fuso horário, deslocamento UTC (tipo 1), abreviação do fuso (tipo
          2), e identificadores de fuso como publicado no banco de dados da IANA (tipo 3), o valor
          retornado será um descritor string para criar um novo objeto <class>DateTimeZone</class> com o mesmo
          deslocamento e/ou regras. Por exemplo <return>02:00</return>, <return>CEST</return>, ou um dos nomes na lista de fusos
          horários.


id: DateTimeZone::getOffset
type: function
doc:
<comment>Description:</comment>
  Retorna o deslocamento do fuso horário ao Horário de Greenwish (GMT)
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Esta função retorna o deslocamento em relação ao GMT para a data/hora especificada no parâmetro
  <strong>$datetime</strong>. O deslocamento GMT é calculado com informação do fuso horário contido no objeto
  DateTimeZone utilizado.

<comment>Param:</comment>
  <info>DateTimeZone</info>       <strong>$object</strong>    Somente no estilo procedural: Um objeto <class>DateTimeZone</class>
                                retornado por <strong>timezone_open()</strong>
  <info>DateTimeInterface</info>  <strong>$datetime</strong>  DateTime que contém a data/hora a partir da qual será computado o
                                deslocamento.

<comment>Return:</comment>
  <info>int</info>  Retorna o deslocamento do fuso horário em segundos.


id: DateTimeZone::getTransitions
type: function
doc:
<comment>Description:</comment>
  Retorna todas as transições para o fuso horário
  
  Estilo orientado a objetos
  
  Estilo procedural

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$object</strong>          Somente no estilo procedural: Um objeto <class>DateTimeZone</class>
                                 retornado por <strong>timezone_open()</strong>
  <info>int</info>           <strong>$timestampBegin</strong>  Timestamp inicial.
  <info>int</info>           <strong>$timestampEnd</strong>    Timestamp final.

<comment>Return:</comment>
  <info>array|false</info>  Retorna um array numericamente indexado de arrays de transições em caso de sucesso,
               ou <info>false</info> em caso de falha. Objetos DataTimeZone do tipo 1 (deslocamento UTC) e tipo 2
               (abreviações) não contêm transições, e se tiverem este método chamado irão retornar
               <info>false</info>.
               
               Se o parâmetro <strong>$timestampBegin</strong> for informado, a primeira entrada no array de retorno
               irá contrer um elemento de transição no horário de <strong>$timestampBegin</strong>.
               
               Estrutura do Array de TransiçãoKeyTypeDescription<return>ts</return><info>int</info>Timestamp Unix<return>time</return><info>string</info>string
               de horário <info>DateTimeInterface::ISO8601_EXPANDED</info> (PHP 8.2 e seguintes), ou
               <info>DateTimeInterface::ISO8601</info> (PHP 8.1 e anteriores)<return>offset</return><info>int</info>Deslocamento UTC em
               segundos<return>isdst</return><info>bool</info>Se o horário de verão está ativo<return>abbr</return><info>string</info>Abreviação do fuso horário


id: DateTimeZone::listAbbreviations
type: function
doc:
<comment>Description:</comment>
  Retorna um array associativo contendo indicativo de horário de verãorão(dst), deslocamento e nome
  do
  fuso horário
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  A lista de abreviações retornada inclui todo o uso histórico de abreviações, o que pode levar a
  entradas corretas, porém confusas. Também existem conflitos, já que <return>PST</return> é usado tanto nos EUA como
  nas Filipinas.
  
  A lista que esta função retora não é portanto adequada para construir um array com opções para
  apresentar ao usuário para escolha de fusos horários.
  
  Os dados desta função são pré compilados por razões de desempenho, e não são atualizadas quado é
  usado um novo timezonedb.

<comment>Return:</comment>
  <info>array</info>  Retorna o array de abreviações de fuso horário.

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


id: DateTimeZone::listIdentifiers
type: function
doc:
<comment>Description:</comment>
  Retorna um array numericamente indexado contendo todos os indenticadores de fuso horário
  
  Estilo orientado a objetos
  
  Estilo procedural

<comment>Param:</comment>
  <info>int</info>          <strong>$timezoneGroup</strong>  Uma das constantes da classe <class>DateTimeZone</class> (ou uma combinação).
  <info>string|null</info>  <strong>$countryCode</strong>    Um código de país, com duas letras (maiúsculas), compatível com a ISO
                               3166-1.
                               
                               Esta opção é utilizada somente quando o parâmetro <strong>$timezoneGroup</strong> é
                               configurado como <info>DateTimeZone::PER_COUNTRY</info>.

<comment>Return:</comment>
  <info>array</info>  Retorna o array de identificadores de fuso horário. Apenas itens não obsoletos são
         retornados. Para obter todos, incluindo identificadores obsoletos, use
         <return>DateTimeZone::ALL_WITH_BC</return> no valor de <strong>$timezoneGroup</strong>.

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


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


id: Directory
type: class
doc:
<comment>Description:</comment>
  Instâncias de <class>Directory</class> são criadas chamando-se a função <strong>dir()</strong>, e não através do operador new.


id: Directory::close
type: function
doc:
<comment>Description:</comment>
  Fecha o manipulador de diretório

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


id: Directory::read
type: function
doc:
<comment>Description:</comment>
  Lê entrada de um manipulador de diretório

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


id: Directory::rewind
type: function
doc:
<comment>Description:</comment>
  Retrocede um manipulador de diretório

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


id: DirectoryIterator
type: class
doc:
<comment>Description:</comment>
  A classe DirectoryIterator fornece uma interface simples para visualização de conteúdo de sistemas
  de arquivos.


id: DirectoryIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new directory iterator from a path
  
  Constructs a new directory iterator from a path.

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  The path of the directory to traverse.

<comment>See Also:</comment>
   * <class>SplFileInfo</class>
   * <class>Iterator</class>


id: DirectoryIterator::__toString
type: function
doc:
<comment>Description:</comment>
  Retorna o nome do arquivo como texto
  
  Retorna o nome do item corrente do <class>DirectoryIterator</class> como texto.

<comment>Return:</comment>
  <info>string</info>  Retorna o nome do item corrente do <class>DirectoryIterator</class> como texto.

<comment>See Also:</comment>
   * DirectoryIterator::getFilename
   * O método mágico __toString()


id: DirectoryIterator::current
type: function
doc:
<comment>Description:</comment>
  Return the current DirectoryIterator item
  
  Get the current <class>DirectoryIterator</class> item.

<comment>Return:</comment>
  <info>mixed</info>  The current <class>DirectoryIterator</class> item.

<comment>See Also:</comment>
   * DirectoryIterator::key
   * DirectoryIterator::next
   * DirectoryIterator::rewind
   * DirectoryIterator::valid
   * Iterator::current


id: DirectoryIterator::getBasename
type: function
doc:
<comment>Description:</comment>
  Retorna o nome do item corrente do DirectoryIterator
  
  Retorna o nome do item corrente do <class>DirectoryIterator</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$suffix</strong>  Se o nome base terminar no <strong>$suffix</strong>, ele é retirado.

<comment>Return:</comment>
  <info>string</info>  O nome do item corrente do <class>DirectoryIterator</class>.

<comment>See Also:</comment>
   * DirectoryIterator::getFilename
   * DirectoryIterator::getPath
   * DirectoryIterator::getPathname
   * <strong>basename()</strong>
   * <strong>pathinfo()</strong>


id: DirectoryIterator::getExtension
type: function
doc:
<comment>Description:</comment>
  Obtém a extensão do arquivo
  
  Recupera a extensão do arquivo.

<comment>Return:</comment>
  <info>string</info>  Retorna uma <info>string</info> contendo a extensão do arquivo,  ou uma <info>string</info> vazia se o arquivo não
          tiver extensão.

<comment>See Also:</comment>
   * DirectoryIterator::getFilename
   * DirectoryIterator::getBasename
   * <strong>pathinfo()</strong>


id: DirectoryIterator::getFilename
type: function
doc:
<comment>Description:</comment>
  Return file name of current DirectoryIterator item
  
  Get the file name of the current <class>DirectoryIterator</class> item.

<comment>Return:</comment>
  <info>string</info>  Returns the file name of the current <class>DirectoryIterator</class> item.

<comment>See Also:</comment>
   * DirectoryIterator::getBasename
   * DirectoryIterator::getPath
   * DirectoryIterator::getPathname
   * <strong>pathinfo()</strong>


id: DirectoryIterator::isDot
type: function
doc:
<comment>Description:</comment>
  Determine if current DirectoryIterator item is '.' or '..'
  
  Determines if the current <class>DirectoryIterator</class> item is a directory and either <return>.</return> or <return>..</return>

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the entry is <return>.</return> or <return>..</return>, otherwise <info>false</info>

<comment>See Also:</comment>
   * DirectoryIterator::getType
   * DirectoryIterator::isDir
   * DirectoryIterator::isFile
   * DirectoryIterator::isLink


id: DirectoryIterator::key
type: function
doc:
<comment>Description:</comment>
  Return the key for the current DirectoryIterator item
  
  Get the key for the current <class>DirectoryIterator</class> item.

<comment>Return:</comment>
  <info>mixed</info>  The key for the current <class>DirectoryIterator</class> item as an <info>int</info>.

<comment>See Also:</comment>
   * DirectoryIterator::current
   * DirectoryIterator::next
   * DirectoryIterator::rewind
   * DirectoryIterator::valid
   * Iterator::key


id: DirectoryIterator::next
type: function
doc:
<comment>Description:</comment>
  Move forward to next DirectoryIterator item
  
  Move forward to the next <class>DirectoryIterator</class> item.

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

<comment>See Also:</comment>
   * DirectoryIterator::current
   * DirectoryIterator::key
   * DirectoryIterator::rewind
   * DirectoryIterator::valid
   * Iterator::next


id: DirectoryIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the DirectoryIterator back to the start
  
  Rewind the <class>DirectoryIterator</class> back to the start.

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

<comment>See Also:</comment>
   * DirectoryIterator::current
   * DirectoryIterator::key
   * DirectoryIterator::next
   * DirectoryIterator::valid
   * Iterator::rewind


id: DirectoryIterator::seek
type: function
doc:
<comment>Description:</comment>
  Procura uma determinada posição no item do DirectoryIterator
  
  Procura uma determinada posição no item do <class>DirectoryIterator</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  Posição de base zero para procurar.

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

<comment>See Also:</comment>
   * DirectoryIterator::rewind
   * DirectoryIterator::next
   * SeekableIterator::seek


id: DirectoryIterator::valid
type: function
doc:
<comment>Description:</comment>
  Check whether current DirectoryIterator position is a valid file
  
  Check whether current <class>DirectoryIterator</class> position is a valid file.

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

<comment>See Also:</comment>
   * DirectoryIterator::current
   * DirectoryIterator::key
   * DirectoryIterator::next
   * DirectoryIterator::rewind
   * Iterator::valid


id: DocResult::__construct
type: function
doc:
<comment>Description:</comment>
  DocResult constructor
  
  Fetch document results and warnings,  and is instantiated by CollectionFind.


id: DocResult::fetchAll
type: function
doc:
<comment>Description:</comment>
  Get all rows
  
  Fetch all results from a result set.

<comment>Return:</comment>
  <info>array</info>  A numerical array with all results from the query; each result is an associative array. An
         empty array is returned if no rows are present.


id: DocResult::fetchOne
type: function
doc:
<comment>Description:</comment>
  Get one row
  
  Fetch one result from a result set.

<comment>Return:</comment>
  <info>array</info>  The result, as an associative array  or <info>null</info> if no results are present.


id: DocResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  Get warnings from last operation
  
  Fetches warnings generated by MySQL server's last operation.

<comment>Return:</comment>
  <info>Array</info>  An array of Warning objects from the last operation. Each object defines an error
         'message', error 'level', and error 'code'. An empty array is returned if no errors are
         present.


id: DocResult::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  Get warning count from last operation
  
  Returns the number of warnings raised by the last operation. Specifically,  these warnings are
  raised by the MySQL server.

<comment>Return:</comment>
  <info>int</info>  The number of warnings from the last operation.


id: Ds\Collection
type: class
doc:
<comment>Description:</comment>
  <class>Collection</class> is the base interface which covers functionality common to all the data structures in
  this library. It guarantees that all structures are traversable, countable, and can be converted
  to json using <strong>json_encode()</strong>.


id: Ds\Collection::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values
  
  Removes all values from the collection.

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


id: Ds\Collection::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the collection
  
  Returns a shallow copy of the collection.

<comment>Return:</comment>
  <info>Ds\Collection</info>  Returns a shallow copy of the collection.


id: Ds\Collection::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the collection is empty
  
  Returns whether the collection is empty.

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


id: Ds\Collection::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the collection to an array
    
  
  Converts the collection to an <info>array</info>.
  
  Casting to an <info>array</info> is not supported yet.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing all the values in the same order as the collection.


id: Ds\Deque
type: class
doc:
<comment>Description:</comment>
  A Deque (pronounced “deck”) is a sequence of values in a contiguous buffer that grows and shrinks
  automatically. The name is a common abbreviation of “double-ended queue” and is used internally by
  <class>Ds\Queue</class>.
  
  Two pointers are used to keep track of a head and a tail. The pointers can “wrap around” the end
  of the buffer, which avoids the need to move other values around to make room. This makes shift
  and unshift very fast —  something a <class>Ds\Vector</class> can’t compete with.
  
  Accessing a value by index requires a translation between the index and its corresponding position
  in the buffer: ((head + position) % capacity).


id: Ds\Deque::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new instance
  
  Creates a new instance, using either a <class>traversable</class> object or an <info>array</info> for the initial <strong>$values</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  A traversable object or an <info>array</info> to use for the initial values.


id: Ds\Deque::allocate
type: function
doc:
<comment>Description:</comment>
  Allocates enough memory for a required capacity
  
  Ensures that enough memory is allocated for a required capacity. This removes the need to
  reallocate the internal as values are added.

<comment>Param:</comment>
  <info>int</info>  <strong>$capacity</strong>  The number of values for which capacity should be allocated.
                  
                  Capacity will stay the same if this value is less than or equal to the current
                  capacity.
                  
                  Capacity will always be rounded up to the nearest power of 2.

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


id: Ds\Deque::apply
type: function
doc:
<comment>Description:</comment>
  Updates all values by applying a callback function to each value
  
  Updates all values by applying a <strong>$callback</strong> function to each value in the deque.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>mixed</info>callback<info>mixed</info><strong>$value</strong>
                       
                       A <info>callable</info> to apply to each value in the deque.
                       
                       The callback should return what the value should be replaced by.

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


id: Ds\Deque::capacity
type: function
doc:
<comment>Description:</comment>
  Returns the current capacity
  
  Returns the current capacity.

<comment>Return:</comment>
  <info>int</info>  The current capacity.


id: Ds\Deque::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values from the deque
  
  Removes all values from the deque.

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


id: Ds\Deque::contains
type: function
doc:
<comment>Description:</comment>
  Determines if the deque contains given values
  
  Determines if the deque contains all values.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  Values to check.

<comment>Return:</comment>
  <info>bool</info>  <info>false</info> if any of the provided <strong>$values</strong> are not in the deque, <info>true</info> otherwise.


id: Ds\Deque::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the deque
  
  Returns a shallow copy of the deque.

<comment>Return:</comment>
  <info>Ds\Deque</info>  A shallow copy of the deque.


id: Ds\Deque::count
type: function
doc:
<comment>Description:</comment>
  Returns the number of values in the collection
  
  See <strong>Countable::count()</strong>


id: Ds\Deque::filter
type: function
doc:
<comment>Description:</comment>
  Creates a new deque using a callable to
      determine which values to include
   
  
  Creates a new deque using a <info>callable</info> to determine which values to include.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>bool</info>callback<info>mixed</info><strong>$value</strong>
                       
                       Optional <info>callable</info> which returns <info>true</info> if the value should be included, <info>false</info>
                       otherwise.
                       
                       If a callback is not provided, only values which are <info>true</info> (see converting to
                       boolean) will be included.

<comment>Return:</comment>
  <info>Ds\Deque</info>  A new deque containing all the values for which either the <strong>$callback</strong> returned <info>true</info>, or
            all values that convert to <info>true</info> if a <strong>$callback</strong> was not provided.


id: Ds\Deque::find
type: function
doc:
<comment>Description:</comment>
  Attempts to find a value's index
    
  
  Returns the index of the <strong>$value</strong>, or <info>false</info> if not found.

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

<comment>Return:</comment>
  <info>mixed</info>  The index of the value, or <info>false</info> if not found.
         
         Values will be compared by value and by type.


id: Ds\Deque::first
type: function
doc:
<comment>Description:</comment>
  Returns the first value in the deque
  
  Returns the first value in the deque.

<comment>Return:</comment>
  <info>mixed</info>  The first value in the deque.


id: Ds\Deque::get
type: function
doc:
<comment>Description:</comment>
  Returns the value at a given index
  
  Returns the value at a given index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index to access, starting at 0.

<comment>Return:</comment>
  <info>mixed</info>  The value at the requested index.


id: Ds\Deque::insert
type: function
doc:
<comment>Description:</comment>
  Inserts values at a given index
  
  Inserts values into the deque at a given index.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>   The index at which to insert. 0 \<= index \<= count
                  
                  You can insert at the index equal to the number of values.
  <info>mixed</info>  <strong>$values</strong>  The value or values to insert.

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


id: Ds\Deque::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the deque is empty
  
  Returns whether the deque is empty.

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


id: Ds\Deque::join
type: function
doc:
<comment>Description:</comment>
  Joins all values together as a string
  
  Joins all values together as a string using an optional separator between each value.

<comment>Param:</comment>
  <info>string</info>  <strong>$glue</strong>  An optional string to separate each value.

<comment>Return:</comment>
  <info>string</info>  All values of the deque joined together as a string.


id: Ds\Deque::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON
  
  See <strong>JsonSerializable::jsonSerialize()</strong>
  
  You should never need to call this directly.


id: Ds\Deque::last
type: function
doc:
<comment>Description:</comment>
  Returns the last value
  
  Returns the last value in the deque.

<comment>Return:</comment>
  <info>mixed</info>  The last value in the deque.


id: Ds\Deque::map
type: function
doc:
<comment>Description:</comment>
  Returns the result of applying a callback to each value
  
  Returns the result of applying a <strong>$callback</strong> function to each value in the deque.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>mixed</info>callback<info>mixed</info><strong>$value</strong>
                       
                       A <info>callable</info> to apply to each value in the deque.
                       
                       The callable should return what the new value will be in the new deque.

<comment>Return:</comment>
  <info>Ds\Deque</info>  The result of applying a <strong>$callback</strong> to each value in the deque.
            
            The values of the current instance won't be affected.


id: Ds\Deque::merge
type: function
doc:
<comment>Description:</comment>
  Returns the result of adding all given values to the deque
  
  Returns the result of adding all given values to the deque.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  A <class>traversable</class> object or an <info>array</info>.

<comment>Return:</comment>
  <info>Ds\Deque</info>  The result of adding all given values to the deque, effectively the same as adding the
            values to a copy, then returning that copy.
            
            The current instance won't be affected.


id: Ds\Deque::pop
type: function
doc:
<comment>Description:</comment>
  Removes and returns the last value
  
  Removes and returns the last value.

<comment>Return:</comment>
  <info>mixed</info>  The removed last value.


id: Ds\Deque::push
type: function
doc:
<comment>Description:</comment>
  Adds values to the end of the deque
  
  Adds values to the end of the deque.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to add.

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


id: Ds\Deque::reduce
type: function
doc:
<comment>Description:</comment>
  Reduces the deque to a single value using a callback function
  
  Reduces the deque to a single value using a callback function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The return value of the previous callback, or <strong>$initial</strong> if it's the first
                       iteration.
                       
                       The value of the current iteration.
  <info>mixed</info>     <strong>$carry</strong>     The return value of the previous callback, or <strong>$initial</strong> if it's the first
                       iteration.
  <info>mixed</info>     <strong>$value</strong>     The value of the current iteration.
  <info>mixed</info>     <strong>$initial</strong>   The initial value of the carry value. Can be <info>null</info>.

<comment>Return:</comment>
  <info>mixed</info>  The return value of the final callback.


id: Ds\Deque::remove
type: function
doc:
<comment>Description:</comment>
  Removes and returns a value by index
  
  Removes and returns a value by index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the value to remove.

<comment>Return:</comment>
  <info>mixed</info>  The value that was removed.


id: Ds\Deque::reverse
type: function
doc:
<comment>Description:</comment>
  Reverses the deque in-place
    
  
  Reverses the deque in-place.

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


id: Ds\Deque::reversed
type: function
doc:
<comment>Description:</comment>
  Returns a reversed copy
  
  Returns a reversed copy of the deque.

<comment>Return:</comment>
  <info>Ds\Deque</info>  A reversed copy of the deque.
              The current instance is not affected. 
            
            The current instance is not affected.


id: Ds\Deque::rotate
type: function
doc:
<comment>Description:</comment>
  Rotates the deque by a given number of rotations
  
  Rotates the deque by a given number of rotations, which is equivalent to successively calling
  $deque-&gt;push($deque-&gt;shift()) if the number of rotations is positive, or
  $deque-&gt;unshift($deque-&gt;pop()) if negative.

<comment>Param:</comment>
  <info>int</info>  <strong>$rotations</strong>  The number of times the deque should be rotated.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.. The deque of the current instance will be rotated.


id: Ds\Deque::set
type: function
doc:
<comment>Description:</comment>
  Updates a value at a given index
  
  Updates a value at a given index.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>  The index of the value to update.
  <info>mixed</info>  <strong>$value</strong>  The new value.

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


id: Ds\Deque::shift
type: function
doc:
<comment>Description:</comment>
  Removes and returns the first value
  
  Removes and returns the first value.

<comment>Return:</comment>
  <info>mixed</info>  The first value, which was removed.


id: Ds\Deque::slice
type: function
doc:
<comment>Description:</comment>
  Returns a sub-deque of a given range
    
  
  Creates a sub-deque of a given range.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>   The index at which the sub-deque starts.
                
                If positive, the deque will start at that index in the deque. If negative, the deque
                will start that far from the end.
  <info>int</info>  <strong>$length</strong>  If a length is given and is positive, the resulting deque will have up to that many
                values in it.
                 If the length results in an overflow, only values up to the end of the deque will
                be included.
                 If a length is given and is negative, the deque will stop that many values from the
                end.
                 If a length is not provided, the resulting deque will contain all values between
                the index and the end of the deque.

<comment>Return:</comment>
  <info>Ds\Deque</info>  A sub-deque of the given range.


id: Ds\Deque::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the deque in-place
   
  
  Sorts the deque in-place, using an optional <strong>$comparator</strong> function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$comparator</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>void</info>  Nenhum valor é retornado.


id: Ds\Deque::sorted
type: function
doc:
<comment>Description:</comment>
  Returns a sorted copy
  
  Returns a sorted copy, using an optional <strong>$comparator</strong> function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$comparator</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>Ds\Deque</info>  Returns a sorted copy of the deque.


id: Ds\Deque::sum
type: function
doc:
<comment>Description:</comment>
  Returns the sum of all values in the deque
  
  Returns the sum of all values in the deque.
  
  Arrays and objects are considered equal to zero when calculating the sum.

<comment>Return:</comment>
  <info>int|float</info>  The sum of all the values in the deque as either a <info>float</info> or <info>int</info> depending on the values
             in the deque.


id: Ds\Deque::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the deque to an array
    
  
  Converts the deque to an <info>array</info>.
  
  Casting to an <info>array</info> is not supported yet.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing all the values in the same order as the deque.


id: Ds\Deque::unshift
type: function
doc:
<comment>Description:</comment>
  Adds values to the front of the deque
  
  Adds values to the front of the deque, moving all the current values forward to make room for the
  new values.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to add to the front of the deque.  Multiple values will be added in the
                  same order that they are passed.
                  
                  Multiple values will be added in the same order that they are passed.

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


id: Ds\Hashable
type: class
doc:
<comment>Description:</comment>
  Hashable is an interface which allows objects to be used as keys. It’s an alternative to
  <strong>spl_object_hash()</strong>, which determines an object’s hash based on its handle: this means that two
  objects that are considered equal by an implicit definition would not treated as equal because
  they are not the same instance.
  
  <strong>hash()</strong> is used to return a scalar value to be used as the object's hash value, which determines
  where it goes in the hash table. While this value does not have to be unique, objects which are
  equal must have the same hash value.
  
  <strong>equals()</strong> is used to determine if two objects are equal. It's guaranteed that the comparing object
  will be an instance of the same class as the subject.


id: Ds\Hashable::equals
type: function
doc:
<comment>Description:</comment>
  Determines whether an object is equal to the current instance
  
  Determines whether another object is equal to the current instance.
  
  This method allows objects to be used as keys in structures such as <class>Ds\Map</class> and <class>Ds\Set</class>, or any
  other lookup structure that honors this interface.
  
  It's guaranteed that <strong>$obj</strong> is an instance of the same class.
  
  It's important that objects which are equal also have the same hash value. See
  <strong>Ds\Hashable::hash()</strong>.

<comment>Param:</comment>
  <info>object</info>  <strong>$obj</strong>  The object to compare the current instance to, which is always an instance of the
                same class.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if equal, <info>false</info> otherwise.


id: Ds\Hashable::hash
type: function
doc:
<comment>Description:</comment>
  Returns a scalar value to be used as a hash value
  
  Returns a scalar value to be used as the hash value of the objects.
  
  While the hash value does not define equality, all objects that are equal according to
  <strong>Ds\Hashable::equals()</strong> must have the same hash value. Hash values of equal objects don't have to be
  unique, for example you could just return <info>true</info> for all objects and nothing would break - the only
  implication would be that hash tables then turn into linked lists because all your objects will be
  hashed to the same bucket. It's therefore very important that you pick a good hash value, such as
  an ID or email address.
  
  This method allows objects to be used as keys in structures such as <class>Ds\Map</class> and <class>Ds\Set</class>, or any
  other lookup structure that honors this interface.
  
  Do not pick a value that might change within the object, such as a public property. Hash table
  lookups would fail because the hash has changed.
  
  All objects that are equal must have the same hash value.

<comment>Return:</comment>
  <info>mixed</info>  A scalar value to be used as this object's hash value.


id: Ds\Map
type: class
doc:
<comment>Description:</comment>
  A Map is a sequential collection of key-value pairs, almost identical to an <info>array</info> used in a
  similar context. Keys can be any type, but must be unique. Values are replaced if added to the map
  using the same key.


id: Ds\Map::allocate
type: function
doc:
<comment>Description:</comment>
  Allocates enough memory for a required capacity
  
  Allocates enough memory for a required capacity.

<comment>Param:</comment>
  <info>int</info>  <strong>$capacity</strong>  The number of values for which capacity should be allocated.
                  
                  Capacity will stay the same if this value is less than or equal to the current
                  capacity.
                  
                  Capacity will always be rounded up to the nearest power of 2.

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


id: Ds\Map::apply
type: function
doc:
<comment>Description:</comment>
  Updates all values by applying a callback function to each value
  
  Updates all values by applying a <strong>$callback</strong> function to each value in the map.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>mixed</info>callback<info>mixed</info><strong>$key</strong><info>mixed</info><strong>$value</strong>
                       
                       A <info>callable</info> to apply to each value in the map.
                       
                       The callback should return what the value should be replaced by.

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


id: Ds\Map::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values
  
  Removes all values from the map.

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


id: Ds\Map::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the map
  
  Returns a shallow copy of the map.

<comment>Return:</comment>
  <info>Ds\Map</info>  Returns a shallow copy of the map.


id: Ds\Map::count
type: function
doc:
<comment>Description:</comment>
  Returns the number of values in the map
  
  See <strong>Countable::count()</strong>


id: Ds\Map::diff
type: function
doc:
<comment>Description:</comment>
  Creates a new map using keys that aren't in another map
  
  Returns the result of removing all keys from the current instance that are present in a given
  <strong>$map</strong>.
  
  A \ B = {x ∈ A | x ∉ B}

<comment>Param:</comment>
  <info>Ds\Map</info>  <strong>$map</strong>  The map containing the keys to exclude in the resulting map.

<comment>Return:</comment>
  <info>Ds\Map</info>  The result of removing all keys from the current instance that are present in a given
          <strong>$map</strong>.

<comment>See Also:</comment>
   * Complement on Wikipedia


id: Ds\Map::filter
type: function
doc:
<comment>Description:</comment>
  Creates a new map using a callable to determine which pairs to include
    
  
  Creates a new map using a <info>callable</info> to determine which pairs to include.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>bool</info>callback<info>mixed</info><strong>$key</strong><info>mixed</info><strong>$value</strong>
                       
                       Optional <info>callable</info> which returns <info>true</info> if the pair should be included, <info>false</info>
                       otherwise.
                       
                       If a callback is not provided, only values which are <info>true</info> (see converting to
                       boolean) will be included.

<comment>Return:</comment>
  <info>Ds\Map</info>  A new map containing all the pairs for which either the <strong>$callback</strong> returned <info>true</info>, or all
          values that convert to <info>true</info> if a <strong>$callback</strong> was not provided.


id: Ds\Map::first
type: function
doc:
<comment>Description:</comment>
  Returns the first pair in the map
  
  Returns the first pair in the map.

<comment>Return:</comment>
  <info>Ds\Pair</info>  The first pair in the map.


id: Ds\Map::get
type: function
doc:
<comment>Description:</comment>
  Returns the value for a given key
  
  Returns the value for a given key, or an optional default value if the key could not be found.
  
  Keys of type <info>object</info> are supported.
   If an object implements <class>Ds\Hashable</class>, equality will be determined by the object's equals function.
   If an object does not implement <class>Ds\Hashable</class>, objects must be references to the same instance to
  be considered equal.
  
  You can also use array syntax to access values by key, eg. $map["key"].
  
  Be careful when using array syntax. Scalar keys will be coerced to integers by the engine. For
  example, $map["1"] will attempt to access int(1), while $map-&gt;get("1") will correctly look up
  the string key.
  
  See Arrays.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>      The key to look up.
  <info>mixed</info>  <strong>$default</strong>  The optional default value, returned if the key could not be found.

<comment>Return:</comment>
  <info>mixed</info>  The value mapped to the given <strong>$key</strong>, or the <strong>$default</strong> value if provided and the key could not
         be found in the map.


id: Ds\Map::hasKey
type: function
doc:
<comment>Description:</comment>
  Determines whether the map contains a given key
  
  Determines whether the map contains a given key.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  The key to look for.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the key could found, <info>false</info> otherwise.


id: Ds\Map::hasValue
type: function
doc:
<comment>Description:</comment>
  Determines whether the map contains a given value
  
  Determines whether the map contains a given value.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The value to look for.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the value could found, <info>false</info> otherwise.


id: Ds\Map::intersect
type: function
doc:
<comment>Description:</comment>
  Creates a new map by intersecting keys with another map
  
  Creates a new map containing the pairs of the current instance whose keys are also present in the
  given <strong>$map</strong>.
   In other words, returns a copy of the current instance with all keys removed that are not also in
  the other <strong>$map</strong>.
  
  A ∩ B = {x : x ∈ A ∧ x ∈ B}
  
  Values from the current instance will be kept.

<comment>Param:</comment>
  <info>Ds\Map</info>  <strong>$map</strong>  The other map, containing the keys to intersect with.

<comment>Return:</comment>
  <info>Ds\Map</info>  The key intersection of the current instance and another <strong>$map</strong>.

<comment>See Also:</comment>
   * Intersection on Wikipedia


id: Ds\Map::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the map is empty
  
  Returns whether the map is empty.

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


id: Ds\Map::keys
type: function
doc:
<comment>Description:</comment>
  Returns a set of the map's keys
  
  Returns a set containing all the keys of the map, in the same order.

<comment>Return:</comment>
  <info>Ds\Set</info>  A <class>Ds\Set</class> containing all the keys of the map.


id: Ds\Map::ksort
type: function
doc:
<comment>Description:</comment>
  Sorts the map in-place by key
   
  
  Sorts the map in-place by key, using an optional <strong>$comparator</strong> function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$comparator</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>void</info>  Nenhum valor é retornado.


id: Ds\Map::ksorted
type: function
doc:
<comment>Description:</comment>
  Returns a copy, sorted by key
  
  Returns a copy sorted by key, using an optional <strong>$comparator</strong> function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$comparator</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>Ds\Map</info>  Returns a copy of the map, sorted by key.


