# php_manual

id: ALPHACHANNEL_ACTIVATE
type: constant
doc:
<comment>Description:</comment>
  Esta constante está disponible si Imagick ha sido compilado con ImageMagick en su versión  6.3.8 o
  superior.


id: ALPHACHANNEL_COPY
type: constant
doc:
<comment>Description:</comment>
  Esta constante está disponible si Imagick ha sido compilado con ImageMagick en su versión  6.4.6 o
  superior.


id: APCUIterator
type: class
doc:
<comment>Description:</comment>
  La clase <class>APCUIterator</class> hace más fácil iterar sobre grandes cachés de APCu. Esto es útil ya que
  permite iterar sobre grandes  cachés en pasos, al mismo tiempo que captura un número definido de
  entradas por instancia de bloqueo, por lo que libera los bloqueos de caché para otras actividades
  en lugar de mantener todo el caché  para obtener 100 entradas (el valor por defecto). Además,
  utilizar comparación por expresiones regulares es más eficiente ya que se ha movido al nivel de C.


id: APCUIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un objeto iterador APCUIterator
  
  Construye un  <class>APCUIterator</class> <info>object</info>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$search</strong>      Una expresión regular del PCRE que coincide con los nombres clave de la APCu,
                      ya sea como <info>string</info> para una sola expresión regular, o como un <info>array</info> de
                      expresiones regular. O, opcionalmente pasar en <info>null</info> para saltarse la búsqueda.
  <info>int</info>    <strong>$format</strong>      El formato deseado, tal como está configurado con una o más de las constantes
                      APC_ITER_*.
  <info>int</info>    <strong>$chunk_size</strong>  El tamaño del fragmento. Debe ser un valor mayor que 0. El valor por defecto
                      es 100.
  <info>int</info>    <strong>$list</strong>        El tipo de lista. O bien pasar en <info>APC_LIST_ACTIVE</info> o <info>APC_LIST_DELETED</info>.

<comment>Return:</comment>
  <info>unknown</info>  Un <class>APCUIterator</class> <info>object</info> en caso de éxito, o <info>null</info> en caso de error.

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


id: APCUIterator::current
type: function
doc:
<comment>Description:</comment>
  Obtener el elemento actual
  
  Obtiene el elemento actual de la pila <class>APCUIterator</class>.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el elemento actual en caso de éxito, o <info>false</info> si no hay más elementos o no existen,
         o en caso de error.

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


id: APCUIterator::getTotalCount
type: function
doc:
<comment>Description:</comment>
  Obtiene el conteo total
  
  Obtener el conteo total.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>int</info>  El conteo total.

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


id: APCUIterator::getTotalHits
type: function
doc:
<comment>Description:</comment>
  Obtener resultados totales de la memoria caché
  
  Obtiene el número total de visitas a la memoria caché.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>int</info>  El número de visitas en caso de éxito, o <info>false</info> en caso de error.

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


id: APCUIterator::getTotalSize
type: function
doc:
<comment>Description:</comment>
  Obtiene el tamaño total del caché
  
  Obtiene el tamaño total del caché.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>int</info>  El tamaño total del caché.

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


id: APCUIterator::key
type: function
doc:
<comment>Description:</comment>
  Obtiene la clave del iterador
  
  Obtiene la clave del iterador actual.

<comment>Return:</comment>
  <info>string</info>  Devuelve la clave en caso de éxito, o <info>false</info> en caso de error.

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


id: APCUIterator::next
type: function
doc:
<comment>Description:</comment>
  Mueve el puntero al siguiente elemento
  
  Mueve el puntero del iterador al siguiente elemento.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


id: APCUIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rebobina el iterador
  
  Rebobina el iterador hasta el primer elemento.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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


id: APCUIterator::valid
type: function
doc:
<comment>Description:</comment>
  Comprueba si la posición actual es válida
  
  Comprueba si la posición actual del iterador es válida.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si la posición actual del iterador es válida, en caso contrario <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> se utiliza con <strong>array_filter()</strong> para pasar tanto el valor como la clave a la
  llamada de retorno proporcionada. Agregado en PHP 5.6.0.


id: ARRAY_FILTER_USE_KEY
type: constant
doc:
<comment>Description:</comment>
  <info>ARRAY_FILTER_USE_KEY</info> se utiliza con <strong>array_filter()</strong> para pasar cada clave como el primer parámetro
  a la llamada de retorno proporcionada. Agregado en PHP 5.6.0.


id: ASSERT_ACTIVE
type: constant
doc:
<comment>Description:</comment>
  assert.active
  
  Habilita la evaluación de <strong>assert()</strong>.


id: ASSERT_CALLBACK
type: constant
doc:
<comment>Description:</comment>
  assert.callback
  
  Llamada de retorno a llamar en caso que falle la aserción.


id: ASSERT_QUIET_EVAL
type: constant
doc:
<comment>Description:</comment>
  assert.quiet_eval
  
  Desactiva <return>error_reporting</return> durante la evaluación de expresiones de aserción.


id: ASSERT_WARNING
type: constant
doc:
<comment>Description:</comment>
  assert.warning
  
  Genera un warning PHP por cada aserción que falle


id: AllowDynamicProperties
type: class
doc:
<comment>Description:</comment>
  This attribute is used to mark classes that allow dynamic properties.


id: AllowDynamicProperties::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new AllowDynamicProperties attribute instance
  
  Constructs a new <class>AllowDynamicProperties</class> instance.


id: AppendIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un AppendIterator
  
  Construye un AppendIterator.

<comment>Return:</comment>
  <info>unknown</info>  No devuelve ningún valor.

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


id: AppendIterator::append
type: function
doc:
<comment>Description:</comment>
  Añade un iterador
  
  Añade un iterador.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  El iterador a añadir.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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


id: AppendIterator::current
type: function
doc:
<comment>Description:</comment>
  Obtiene el valor actual
  
  Obtiene el valor actual.

<comment>Return:</comment>
  <info>mixed</info>  Si el valor actual es válido o <info>null</info> en caso contrario.

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


id: AppendIterator::getArrayIterator
type: function
doc:
<comment>Description:</comment>
  Obtiene el getArrayIterator
  
  Este método obtiene el objeto <class>ArrayIterator</class> empleado para  almacenar los iteradores añadidos con
  AppendIterator::append.

<comment>Return:</comment>
  <info>ArrayIterator</info>  Devuelve un <class>ArrayIterator</class> que contiene los iteradores añadidos.

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


id: AppendIterator::getIteratorIndex
type: function
doc:
<comment>Description:</comment>
  Obtiene un índice de iteradores
  
  Obtiene el índice del iterador actual actual.

<comment>Return:</comment>
  <info>int</info>  Devuelve un <info>integer</info>, que es el índice basado en cero del iterador interno actual.

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


id: AppendIterator::key
type: function
doc:
<comment>Description:</comment>
  Obtiene la clave actual
  
  Obtener la clave actual.

<comment>Return:</comment>
  <info>scalar</info>  La clave actual si es válida o <info>null</info> en caso contrario.

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


id: AppendIterator::next
type: function
doc:
<comment>Description:</comment>
  Desplazarse al siguiente elemento
  
  Se desplaza al siguiente elemento. Esto significa a otro iterador por lo que rebobina ese
  iterador.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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


id: AppendIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rebobina el iterador
  
  Rebobina al primer elemento del primer iterador interno.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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


id: AppendIterator::valid
type: function
doc:
<comment>Description:</comment>
  Comprueba la validación del elemento actual
  
  Comprueba la validación del elemento actual.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si la iteración actual es válida, <info>false</info> en caso contrario.

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


id: ArrayAccess::offsetExists
type: function
doc:
<comment>Description:</comment>
  Comprobar si existe un índice
  
  Comprueba si existe o no un índice.
  
  Este método se ejecuta cuando se utilizan las funciones <strong>isset()</strong> o <strong>empty()</strong> sobre los objetos que
  implementan <class>ArrayAccess</class>.
  
  Cuando se utiliza <strong>empty()</strong>, <strong>ArrayAccess::offsetGet()</strong> será invocada para comprobar si está vacío
  solamente si <strong>ArrayAccess::offsetExists()</strong> devuelve <info>true</info>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  El índice a comprobar.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.
        
        El valor de retorno se debe convertir a <info>bool</info> si no devuelve un valor boleano.


id: ArrayAccess::offsetGet
type: function
doc:
<comment>Description:</comment>
  Offset para recuperar
  
  Devuelve el valor correspondiente a desplazamiento especificado.
  
  Este método se ejecuta para comprobar si el desplazamiento es <strong>empty()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  El desplazamiento va a recuperar.

<comment>Return:</comment>
  <info>mixed</info>  Puede devolver todos los tipos de valor.

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


id: ArrayAccess::offsetSet
type: function
doc:
<comment>Description:</comment>
  Asignar un valor al índice esepecificado
  
  Asigna un valor a un offset determinado.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  El offset al que se asigna el valor.
  <info>mixed</info>  <strong>$value</strong>   El valor a asignar.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: ArrayAccess::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Destruye un offset
  
  Destruye un offset.
  
  Este método no será llamado cuando se fuerza un tipo mediante (unset)

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  El offset a destruir.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: ArrayIterator
type: class
doc:
<comment>Description:</comment>
  Este iterador permite eliminar y modificar valores y claves cuando se  recorren arrays y objetos.
  
  Cuando se quiere iterar sobre el mismo array varias veces, se necesita  instanciar ArrayObject y
  dejarle que cree instancias ArrayIterator que  hacen referencia a la misma usando foreach o
  llamando a su método getIterator() de forma manual.


id: ArrayIterator::ARRAY_AS_PROPS
type: constant
doc:
<comment>Description:</comment>
  Se puede acceder a las entradas como propiedades (lectura y escritura).


id: ArrayIterator::STD_PROP_LIST
type: constant
doc:
<comment>Description:</comment>
  Las propiedades del objeto tienen su funcionalidad normal cuando se accede a ellas como lista
  (var_dump, foreach, etc.).


id: ArrayIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un ArrayIterator
  
  Construye un <info>objeto</info> <class>ArrayIterator</class>.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$array</strong>  El array o objecto a ser iterado.
  <info>int</info>    <strong>$flags</strong>  Banderas para controlar el comportamiento del objeto <class>ArrayIterator</class>. Véase
                 ArrayIterator::setFlags.

<comment>Return:</comment>
  <info>unknown</info>  Un <info>objeto</info> <class>ArrayIterator</class>.

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


id: ArrayIterator::append
type: function
doc:
<comment>Description:</comment>
  Añade un elemento
  
  Añade el valor cómo el último elemento.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  El valor a añadir.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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


id: ArrayIterator::asort
type: function
doc:
<comment>Description:</comment>
  Ordena array por sus valores
  
  Ordena un array por sus valores.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * ArrayIterator::ksort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort


id: ArrayIterator::count
type: function
doc:
<comment>Description:</comment>
  Cuenta elementos
  
  Obtiene el número de elementos de un <info>array</info>, o el número de propiedades públicas en un <info>objeto</info>.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>int</info>  El número.

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


id: ArrayIterator::current
type: function
doc:
<comment>Description:</comment>
  Devuelve la entrada actual del array
  
  Obtiene la entrada actual del <info>array</info>.

<comment>Return:</comment>
  <info>mixed</info>  La entrada actual del <info>array</info>.


id: ArrayIterator::getArrayCopy
type: function
doc:
<comment>Description:</comment>
  Obtener copia de un array
  
  Obtiene una copia de un array.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>array</info>  Una copia de un <info>array</info>, o un array de las propiedades públicas si ArrayIterator hace
         referencia a un <info>objeto</info>.

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


id: ArrayIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  Obtener opciones
  
  Obtiene las opciones actuales.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>void</info>  The current flags.

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


id: ArrayIterator::key
type: function
doc:
<comment>Description:</comment>
  Devuelve la clave actual del array
  
  Esta función devuelve la clave actual del array

<comment>Return:</comment>
  <info>mixed</info>  La clave actual del <info>array</info>.


id: ArrayIterator::ksort
type: function
doc:
<comment>Description:</comment>
  Ordena un array por sus claves
  
  Ordena un array por sus claves.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort


id: ArrayIterator::natcasesort
type: function
doc:
<comment>Description:</comment>
  Ordena un array de forma natural, sensible a mayúsculas
  
  Ordena las entradas por valores usando un algoritmo de "ordenado natural" sensible a mayúsculas.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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


id: ArrayIterator::natsort
type: function
doc:
<comment>Description:</comment>
  Ordena un array de forma natural
  
  Ordena las entradas por valores usando un algoritmo de "ordenado natural".
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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


id: ArrayIterator::next
type: function
doc:
<comment>Description:</comment>
  Desplaza a la siguiente entrada
  
  El iterador a la siguiente entrada.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: ArrayIterator::offsetExists
type: function
doc:
<comment>Description:</comment>
  Compruebar si el índice existe
  
  Comprueba si el índice existe.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>  El índice a ser comprobado.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si el índice existe, en caso contrario <info>false</info>

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


id: ArrayIterator::offsetGet
type: function
doc:
<comment>Description:</comment>
  Obtener el valor de un índice
  
  Obtiene el valor del índice proporcionado.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>  El índice para obtener el valor.

<comment>Return:</comment>
  <info>mixed</info>  El valor del índice <strong>$index</strong>.

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


id: ArrayIterator::offsetSet
type: function
doc:
<comment>Description:</comment>
  Establece el valor para un índice
  
  Establecer el valor para el índice dado.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>   El índice a ser establecido.
  <info>mixed</info>  <strong>$newval</strong>  El nuevo valor para almacenar en el índice.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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


id: ArrayIterator::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Destruye el valor de un índice
  
  Destruir el valor de un índice dado.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>  El índice a ser destruido.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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


id: ArrayIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rebobinar array al inicio
  
  Rebobina el iterador al inicio del array.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: ArrayIterator::seek
type: function
doc:
<comment>Description:</comment>
  Buscar la posición
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  La posición a buscar.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: ArrayIterator::serialize
type: function
doc:
<comment>Description:</comment>
  Serializar
  
  Serializa.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>string</info>  El <class>ArrayIterator</class> serializado.

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


id: ArrayIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  Definir opciones de comportamiento
  
  Define opciones de comportamiento.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$flags</strong>  Un bitmask como se indica:  0 = Propiedades del objeto tienen su normal
                  comportamiento cuando son obtenidas como lista (var_dump, foreach, etc.).  1 =
                  Índicies de array pueden ser accedidos como propiedades de lectura/escritura.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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


id: ArrayIterator::uasort
type: function
doc:
<comment>Description:</comment>
  Ordenado definido por el usuario
  
  Ordena las entradas por los valores usando una función definida por el usuario.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$cmp_function</strong>  La función de comparación usada para el ordenado.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * ArrayIterator::uksort
   * <strong>usort()</strong>


id: ArrayIterator::uksort
type: function
doc:
<comment>Description:</comment>
  Ordenado definido por el usuario
  
  Ordena las entradas por clave usando una función definida por el usuario.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$cmp_function</strong>  La función de comparación usada para el ordenado.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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


id: ArrayIterator::unserialize
type: function
doc:
<comment>Description:</comment>
  Deserializar
  
  Deserializa.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  El objecto serializado ArrayIterator para deserializar.

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

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


id: ArrayIterator::valid
type: function
doc:
<comment>Description:</comment>
  Comprueba si un array contiene más entradas
  
  Comprueba si un <info>array</info> contiene más entradas.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el iterador es válido, <info>false</info> si no.


id: ArrayObject::STD_PROP_LIST
type: constant
doc:
<comment>Description:</comment>
  Las propiedades del objeto tienen un comportamiento normal cuando se acceden como listado
  (var_dump, foreach, etc.).


id: ArrayObject::__construct
type: function
doc:
<comment>Description:</comment>
  Construir un nuevo objeto Array
  
  Esto crea un nuevo <info>objeto</info> array.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$input</strong>           Este parámetro de <strong>$input</strong> (entrada) acepta un  <info>array</info> o un <info>objeto</info>.
  <info>int</info>     <strong>$flags</strong>           Flags para controlar el comportamiento del objeto <class>ArrayObject</class>.
  <info>string</info>  <strong>$iterator_class</strong>  Especifica la clase que va a ser usada para la iteración del objeto
                           <class>ArrayObject</class>. <class>ArrayIterator</class> es la clase usada por omisión.

<comment>Return:</comment>
  <info>unknown</info>  Devuelve un objeto ArrayObject en caso de éxito.

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


id: ArrayObject::append
type: function
doc:
<comment>Description:</comment>
  Añade un valor
  
  Añade un nuevo valor como el último elemento.
  
  Este método no puede ser llamado cuando la clase <class>ArrayObject</class>  fue construida a partir de un
  objeto. Utilice ArrayObject::offsetSet en su lugar.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  El valor a ser añadido.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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


id: ArrayObject::asort
type: function
doc:
<comment>Description:</comment>
  Ordena las entradas por valor
  
  Ordenar las entradas de modo que las claves mantengan su correlación  con las entradas que están
  asociadas. Esto se utiliza principalmente  para ordenar arrays asociativos cuando el orden de los
  elementos es  importante.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * ArrayObject::uksort


id: ArrayObject::count
type: function
doc:
<comment>Description:</comment>
  Obtener el número de propiedades públicas en la clase ArrayObject
  
  Obtiene el número de propiedades públicas en la clase <class>ArrayObject</class>.

<comment>Return:</comment>
  <info>int</info>  El número de propiedades públicas en la clase <class>ArrayObject</class>.
       
       Cuando la clase <class>ArrayObject</class> se construye a partir de un array todas las propiedades son
       públicas.


id: ArrayObject::exchangeArray
type: function
doc:
<comment>Description:</comment>
  Intercambia el array por otro
  
  Intercambiar el <info>array</info> actual con otro <info>array</info> u <info>objeto</info>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$input</strong>  El nuevo <info>array</info> u <info>objeto</info> a ser intercambiado con el array actual.

<comment>Return:</comment>
  <info>array</info>  Devuelve el <info>array</info> antiguo.


id: ArrayObject::getArrayCopy
type: function
doc:
<comment>Description:</comment>
  Crea una copia de la clase ArrayObject
  
  Exporta la clase <class>ArrayObject</class> a un array.

<comment>Return:</comment>
  <info>array</info>  Devuelve una copia del array. Cuando la clase <class>ArrayObject</class> hace referencia a un  objeto, un
         array de las propiedades públicas del objeto que será devuelto.


id: ArrayObject::getFlags
type: function
doc:
<comment>Description:</comment>
  Obtiene las flags de comportamiento
  
  Obtener las flags de comportamiento de la clase <class>ArrayObject</class>.  Véase el método
  ArrayObject::setFlags para  obtener una lista de las flags disponibles.

<comment>Return:</comment>
  <info>int</info>  Devuelve las flags de comportamiento de la clase ArrayObject.

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


id: ArrayObject::getIterator
type: function
doc:
<comment>Description:</comment>
  Crear un nuevo iterador desde una instancia ArrayObject
  
  Crear un nuevo iterador desde una instancia <class>ArrayObject</class>.

<comment>Return:</comment>
  <info>ArrayIterator</info>  Un iterador de una clase <class>ArrayObject</class>.


id: ArrayObject::getIteratorClass
type: function
doc:
<comment>Description:</comment>
  Obtiene el nombre de clase iterador para ArrayObject
  
  Obtener el nombre de clase iterador de array que es utilizado por  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>
   * El método ArrayObject::setIteratorClass


id: ArrayObject::ksort
type: function
doc:
<comment>Description:</comment>
  Ordena las entradas por clave
  
  ordenar las entradas por clave, manteniendo la correlación de claves para  la entrada. Esto es
  útil principalmente en arrays asociativos.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * ArrayObject::uksort


id: ArrayObject::natcasesort
type: function
doc:
<comment>Description:</comment>
  Ordena un array usando un algoritmo orden natural
  
  Este método es la versión insensible de  ArrayObject::natsort.
  
  Este método implementa un algoritmo que ordena string alfanuméricos en la  forma en que un humano
  debe mantener la asociación clave/valor.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::uasort
   * ArrayObject::uksort


id: ArrayObject::natsort
type: function
doc:
<comment>Description:</comment>
  Ordena entradas usando un algoritmo de orden natural
  
  Este método implementa un algoritmo que ordena string alfanuméricas en la forma  en que un humano
  seguiría manteniendo la asociación clave/valor. Esto se describe como un "orden natural". Un
  ejemplo de la diferencia entre este  algoritmo y los algoritmos comunes de computadoras para
  ordenar string. (Usado en el método ArrayObject::asort)  puede verse en el siguiente ejemplo.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * ArrayObject::uksort


id: ArrayObject::offsetExists
type: function
doc:
<comment>Description:</comment>
  Devuelve si el índice solicitado existe

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>  El índice a ser comprobado.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si el índice solicitado existe, en caso contrario <info>false</info>


id: ArrayObject::offsetGet
type: function
doc:
<comment>Description:</comment>
  Devuelve el valor del índice especificado

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>  El índice con el valor.

<comment>Return:</comment>
  <info>mixed</info>  El valor del índice especificado o <info>null</info>.


id: ArrayObject::offsetSet
type: function
doc:
<comment>Description:</comment>
  Establece el valor en el índice especificado
  
  Establecer el valor en el índice especificado por newval.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>   El índice a ser establecido.
  <info>mixed</info>  <strong>$newval</strong>  El nuevo valor para el <strong>$index</strong>.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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


id: ArrayObject::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Destruye el valor para el índice especificado
  
  Destruir el valor para el índice especificado.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>  El índice a ser destruido.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: ArrayObject::serialize
type: function
doc:
<comment>Description:</comment>
  Serializar un ArrayObject
  
  Serializa un <class>ArrayObject</class>.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>string</info>  Representación serializada de <class>ArrayObject</class>.

<comment>See Also:</comment>
   * ArrayObject::unserialize
   * <strong>serialize()</strong>
   * Serialización de objetos


id: ArrayObject::setFlags
type: function
doc:
<comment>Description:</comment>
  Establece las flags de comportamiento
  
  Establecer las flags que cambian el comportamiento de la clase ArrayObject.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  El nuevo comportamiento de ArrayObject. Se necesita una máscara de bits, o constantes
               con nombre. El uso  de constantes con nombre es bastante recomendable para asegurar
               la  compatibilidad con versiones futuras.
               
               Las flags de comportamiento disponibles se enumeran a continuación.  El significado
               de estos parámetros están descritos en las  constantes predefinidas. Flags de
               comportamiento de
               ArrayObjectvalueconstant1ArrayObject::STD_PROP_LIST2ArrayObject::ARRAY_AS_PROPS

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: ArrayObject::setIteratorClass
type: function
doc:
<comment>Description:</comment>
  Establece el nombre de clase iterador para ArrayObject
  
  Establecer el nombre de clase iterador que es usado por  ArrayObject::getIterator().

<comment>Param:</comment>
  <info>string</info>  <strong>$iterator_class</strong>  El nombre de clase de el array iterador a usar cuando se itera sobre este
                           objeto.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: ArrayObject::uasort
type: function
doc:
<comment>Description:</comment>
  Ordena las entradas con una función de comparación definida por el usuario y mantiene asociación
  de
  claves
  
  Esta función ordena las entradas de forma que las claves mantengan su  correlación con la entrada
  que está asociada con, una función de comparación definida por el usuario.
  
  Esto se utiliza principalmente para ordenar arrays asociativos donde  el orden de los elementos es
  importante.

<comment>Param:</comment>
  <info>callable</info>  <strong>$cmp_function</strong>  La función <strong>$cmp_function</strong> acepta 2 parámetros  que serán llenados por
                           pares de entradas. La función de comparación debe devolver un integer
                           menor que, igual a,  o mayor que cero si el primer argumento es menor
                           que, igual a, o  mayor que el segundo.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uksort


id: ArrayObject::uksort
type: function
doc:
<comment>Description:</comment>
  Ordena las entradas por clave usando una función de comparación definida por el usuario
  
  Esta función ordena las claves de las entradas usando una función de  compración suministrada por
  el usuario. La correlación de clave será  mantenida.

<comment>Param:</comment>
  <info>callable</info>  <strong>$cmp_function</strong>  La función de devolución de llamada de comparación.
                           
                           La función <strong>$cmp_function</strong> acepta 2 parámetros  que serán llenados por
                           pares de entradas. La función de comparación debe devolver un integer
                           menor que, igual a,  o mayor que cero si el primer argumento es menor
                           que, igual a, o  mayor que el segundo.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uasort


id: ArrayObject::unserialize
type: function
doc:
<comment>Description:</comment>
  Deserializar el objeto ArrayObject
  
  Deserializa un objeto <class>ArrayObject</class> serializado.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  El objeto <class>ArrayObject</class> serializado.

<comment>Return:</comment>
  <info>void</info>  El objeto <class>ArrayObject</class> deserializado.

<comment>See Also:</comment>
   * ArrayIterator::serialize
   * <strong>unserialize()</strong>
   * Serialización de objetos


id: Attribute
type: class
doc:
<comment>Description:</comment>
  Attributes offer the ability to add structured, machine-readable metadata information on
  declarations in code: Classes, methods, functions, parameters, properties and class constants can
  be the target of an attribute. The metadata defined by attributes can then be inspected at runtime
  using the Reflection APIs. Attributes could therefore be thought of as a configuration language
  embedded directly into code.


id: Attribute::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Attribute instance
  
  Constructs a new <class>Attribute</class> instance.

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


id: BackedEnum
type: class
doc:
<comment>Description:</comment>
  The <class>BackedEnum</class> interface is automatically applied to backed enumerations by the engine.  It may
  not be implemented by user-defined classes. Enumerations may not override its methods, as default
  implementations are provided by the engine.  It is available only for type checks.


id: BackedEnum::from
type: function
doc:
<comment>Description:</comment>
  Maps a scalar to an enum instance
  
  The from method translates a <info>string</info> or <info>int</info> into the corresponding Enum case, if any.  If there is
  no matching case defined, it will throw a <class>ValueError</class>.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$value</strong>  The scalar value to map to an enum case.

<comment>Return:</comment>
  <info>static</info>  A case instance of this enumeration.

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


id: BackedEnum::tryFrom
type: function
doc:
<comment>Description:</comment>
  Maps a scalar to an enum instance or null
  
  The tryFrom method translates a <info>string</info> or <info>int</info> into the corresponding Enum case, if any.  If there
  is no matching case defined, it will return null.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$value</strong>  The scalar value to map to an enum case.

<comment>Return:</comment>
  <info>static|null</info>  A case instance of this enumeration, or <info>null</info> if not found.

<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: CASE_LOWER
type: constant
doc:
<comment>Description:</comment>
  <info>CASE_LOWER</info> junto con <strong>array_change_key_case()</strong> se utiliza para convertir claves de array a
  minúsculas. Es también la constante predefinida para <strong>array_change_key_case()</strong>.


id: CASE_UPPER
type: constant
doc:
<comment>Description:</comment>
  <info>CASE_UPPER</info> junto con <strong>array_change_key_case()</strong> se utiliza para convertir claves de array a
  mayúsculas.


id: CLSCTX_ALL
type: constant
doc:
<comment>Description:</comment>
  Indica todos los contextos de clase. Esta definición usa el operador OR con <info>CLSCTX_INPROC_HANDLER</info>
  y  <info>CLSCTX_SERVER</info>.


id: CLSCTX_INPROC_HANDLER
type: constant
doc:
<comment>Description:</comment>
  El código que administra objetos de esta clase es un gestor "en-proceso". Es una DLL que se
  ejecuta en el proceso cliente e implementa estructuras del lado del cliente de esta clase cuando a
  las instancias de la clase se acceden de forma remota.


id: CLSCTX_INPROC_SERVER
type: constant
doc:
<comment>Description:</comment>
  El código que crea y administra objetos de esta clase es una DLL que se ejecuta en el mismo
  proceso que el llamador a la función especificando el contexto de la clase.


id: CLSCTX_LOCAL_SERVER
type: constant
doc:
<comment>Description:</comment>
  El código EXE que crea y administra objetos de esta clase se ejecuta en la misma máquina, pero se
  carga en un espacio de proceso distinto.


id: CLSCTX_REMOTE_SERVER
type: constant
doc:
<comment>Description:</comment>
  Un contexto remoto. El código que crea y administra objetos de esta clase se ejecuta en un
  ordenador diferente.


id: CLSCTX_SERVER
type: constant
doc:
<comment>Description:</comment>
  Indica código de servidor, si es "en-proceso", local, o remoto. Esta definición usa el operador OR
  con <info>CLSCTX_INPROC_SERVER</info>,  <info>CLSCTX_LOCAL_SERVER</info>, y <info>CLSCTX_REMOTE_SERVER</info>.


id: CL_EXPUNGE
type: constant
doc:
<comment>Description:</comment>
  Expurga el buzón silenciosamente antes de cerralo al llamar a <strong>imap_close()</strong>


id: COLORSPACE_CMY
type: constant
doc:
<comment>Description:</comment>
  Esta constante está disponible si Imagick ha sido compilado con ImageMagick en su versión  6.4.2 o
  superior.


id: COMPOSITE_ATOP
type: constant
doc:
<comment>Description:</comment>
  El resultado tiene la misma forma que la imagen, con la imagen compuesta oscurenciendo la imagen,
  donde la imagen forma traslapado


id: COMPOSITE_BUMPMAP
type: constant
doc:
<comment>Description:</comment>
  Lo mismo que COMPOSITE_MULTIPLY, excepto que el origen primero se covierte a escala de grises.


id: COMPOSITE_COLORDODGE
type: constant
doc:
<comment>Description:</comment>
  Hace más brillante la imagen destino para reflejar la imagen de origen


id: COMPOSITE_DIFFERENCE
type: constant
doc:
<comment>Description:</comment>
  Sustrae el más oscuro de los dos colores constituyentes del más luminiso


id: COMPOSITE_DISPLACE
type: constant
doc:
<comment>Description:</comment>
  Cambia los píxeles de la imagen objetivo como se definió en el origen


id: COMPOSITE_DSTATOP
type: constant
doc:
<comment>Description:</comment>
  La parte de la capa destino dentro del origen se compone sobre el origen y reemplaza el destino


id: COMPOSITE_EXCLUSION
type: constant
doc:
<comment>Description:</comment>
  Produce un efecto similar al de imagick::COMPOSITE_DIFFERENCE, pero aparece con un contraste menor


id: COMPOSITE_HARDLIGHT
type: constant
doc:
<comment>Description:</comment>
  Multiplica u oculta los colores, dependiendo del valor del color de origen


id: COMPOSITE_MODULATE
type: constant
doc:
<comment>Description:</comment>
  Modula el brillo, la saturación y el tono del objetivo como se definió en el origen


id: COMPOSITE_SCREEN
type: constant
doc:
<comment>Description:</comment>
  El origen y destino son complementados, después multiplicados, y después reemplazan el destino


id: COMPOSITE_SRCATOP
type: constant
doc:
<comment>Description:</comment>
  La parte de la capa de origen dentro del destino es compuesta en el destino


id: COMPOSITE_SRCIN
type: constant
doc:
<comment>Description:</comment>
  La parte de la capa del origen dentro del destino reemplaza el destino


id: COMPOSITE_SRCOUT
type: constant
doc:
<comment>Description:</comment>
  La parte de la capa del origen fuera del destino reemplaza el destino


id: COMPOSITE_THRESHOLD
type: constant
doc:
<comment>Description:</comment>
  El origen es compuesto en el objetivo como se definió en el umbral del origen


id: COMPOSITE_XOR
type: constant
doc:
<comment>Description:</comment>
  La parte del origen que yace fuera del destino se combina con la parte del destino que yace fuera
  del origen


id: COMPRESSION_DXT1
type: constant
doc:
<comment>Description:</comment>
  Esta constante está disponible si Imagick ha sido compilado con ImageMagick en su versión  6.4.0 o
  superior.


id: COMPersistHelper
type: class
doc:
<comment>Description:</comment>
  <class>COMPersistHelper</class> mejora la interoperabilidad de COM y PHP con respecto a la directiva php.ini
  open_basedir, y stream recursos.


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>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


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>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


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 recurso from which to load the object.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


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>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


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 recurso to which to save the object.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


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>
  Borra los mensajes del buzón actual después de copiarlos con <strong>imap_mail_copy()</strong>


id: CREDITS_ALL
type: constant
doc:
<comment>Description:</comment>
  -1
  
  Todos los créditos, es equivalente a usar: <return>CREDITS_DOCS + CREDITS_GENERAL + CREDITS_GROUP +
  CREDITS_MODULES + CREDITS_QA CREDITS_FULLPAGE</return>. Genera una página HTML independiente con las
  apropiadas etiquetas. Este es el valor por defecto.


id: CREDITS_FULLPAGE
type: constant
doc:
<comment>Description:</comment>
  Normalmente se utiliza en combiación con otras opciones.Indica que una página HTML independiente
  debe ser mostrada incluyendo la información indicada por otras opciones.


id: CREDITS_GENERAL
type: constant
doc:
<comment>Description:</comment>
  Créditos generales: Diseño del lenguaje y concepto, autores de PHP y módulos SAPI.


id: CURLFile
type: class
doc:
<comment>Description:</comment>
  <class>CURLFile</class> debería emplearse para subir un fichero con <info>CURLOPT_POSTFIELDS</info>.


id: CURLFile::__construct
type: function
doc:
<comment>Description:</comment>
  Crear un objeto CURLFile
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Crea un objeto <class>CURLFile</class> , utilizado para transferir (upload) un fichero con <info>CURLOPT_POSTFIELDS</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Ruta de acceso al fichero a ser transferido.
  <info>string</info>  <strong>$mimetype</strong>  Tipo MIME del fichero.
  <info>string</info>  <strong>$postname</strong>  Nombre del fichero para los datos de subida.

<comment>Return:</comment>
  <info>CURLFile</info>  Devuelve un objeto <class>CURLFile</class> .

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


id: CURLFile::getFilename
type: function
doc:
<comment>Description:</comment>
  Recupera el nombre de un fichero

<comment>Return:</comment>
  <info>string</info>  Devuelve el nombre de fichero.


id: CURLFile::getMimeType
type: function
doc:
<comment>Description:</comment>
  Recupera el tipo MIME

<comment>Return:</comment>
  <info>string</info>  Devuelve el tipo MIME.


id: CURLFile::getPostFilename
type: function
doc:
<comment>Description:</comment>
  Recupera el nombre de fichero para POST

<comment>Return:</comment>
  <info>string</info>  Recupera el nombre de fichero para POST.


id: CURLFile::setMimeType
type: function
doc:
<comment>Description:</comment>
  Configura el tipo MIME

<comment>Param:</comment>
  <info>string</info>  <strong>$mime</strong>  Tipo MIME para los datos de POST.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: CURLFile::setPostFilename
type: function
doc:
<comment>Description:</comment>
  Establecer el nombre de fichero para POST

<comment>Param:</comment>
  <info>string</info>  <strong>$postname</strong>  El nombre de fichero para los datos de POST.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: CURLOPT_FOLLOWLOCATION
type: constant
doc:
<comment>Description:</comment>
  Esta constante no está disponible cuando open_basedir está habilitado.


id: CURL_WRAPPERS_ENABLED
type: constant
doc:
<comment>Description:</comment>
  Definida si PHP fue configurado con --with-curlwrappers. Movido a PECL en PHP 5.5.0.


id: CachingIterator
type: class
doc:
<comment>Description:</comment>
  Este objeto admite iteraciones almacenadas en caché sobre otros iteradores.


id: CachingIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construir un nuevo objeto CachingIterator para el iterador
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  Iterador a usar en caché
  <info>int</info>       <strong>$flags</strong>     Máscara de bits de las opciones.


id: CachingIterator::__toString
type: function
doc:
<comment>Description:</comment>
  Devolver la representación en formato cadena del elemento actual
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.
  
  Obtiene la representación en formato cadena del elemento actual.

<comment>Return:</comment>
  <info>void</info>  La representación en formato <info>cadena</info> del elemento actual.


id: CachingIterator::count
type: function
doc:
<comment>Description:</comment>
  El número de elementos en el iterador
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.
  
  Devuelve el número de elementos en el iterador.

<comment>Return:</comment>
  <info>int</info>  La cuenta del número de elementos que han sido iterados.


id: CachingIterator::current
type: function
doc:
<comment>Description:</comment>
  Devuelve el elemento actual
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.
  
  Devuelve el elemento actual en el iterador.

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

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


id: CachingIterator::getCache
type: function
doc:
<comment>Description:</comment>
  Recuperar el contenido de la caché
  
  Recupera el contenido de la caché.
  
  Se debe utilizar el indicador <info>CachingIterator::FULL_CACHE</info>.

<comment>Return:</comment>
  <info>array</info>  Un <info>array</info> que contiene los elementos de la caché.


id: CachingIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  Obtener las banderas utilizadas
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.
  
  Obtiene la máscara de bits usada para esta instancia de ChachingIterator.

<comment>Return:</comment>
  <info>int</info>  Descripción...


id: CachingIterator::hasNext
type: function
doc:
<comment>Description:</comment>
  Comprueba que el iterador interno tenga un elemento siguiente válido
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>void</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: CachingIterator::key
type: function
doc:
<comment>Description:</comment>
  Devuelve la clave del elemento actual
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.
  
  Este método devuelve la clave del elemento actual.

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


id: CachingIterator::next
type: function
doc:
<comment>Description:</comment>
  Desplaza el iterador adelante
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.
  
  Desplaza el iterador adelante.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: CachingIterator::offsetExists
type: function
doc:
<comment>Description:</comment>
  Comprobar existencia de un índice
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>  El índice a ser comprobado.

<comment>Return:</comment>
  <info>void</info>  Devuelve <info>true</info> si la entrada a la que hace referencia el índice existe, en caso contrario
        <info>false</info>.


id: CachingIterator::offsetGet
type: function
doc:
<comment>Description:</comment>
  El propósito offsetGet
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$index</strong>  Descripción...

<comment>Return:</comment>
  <info>void</info>  Descripción...


id: CachingIterator::offsetSet
type: function
doc:
<comment>Description:</comment>
  El propósito offsetSet
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>   El índice del elemento a ser establecido.
  <info>mixed</info>  <strong>$newval</strong>  El nuevo valor para el <strong>$index</strong>.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: CachingIterator::offsetUnset
type: function
doc:
<comment>Description:</comment>
  El propósito offsetUnset
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$index</strong>  El índice de el elemento a ser destruido.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: CachingIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rebobina el iterador
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.
  
  Rebobinar el iterador.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: CachingIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  El propósito de setFlags
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.
  
  Establece las flags para el objeto CachingIterator.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Máscara de flags a establecer.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: CachingIterator::valid
type: function
doc:
<comment>Description:</comment>
  Comprueba que el elemento actual sea válido
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.
  
  Comprueba que el elemento actual sea válido.

<comment>Return:</comment>
  <info>void</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: CallbackFilterIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Crear un iterador filtrado desde otro iterador
  
  Crea un iterador filtrado usando <strong>$callback</strong> (llamada de retorno) Creates a filtered iterator using
  the <strong>$callback</strong> para determinar  que elementos van a ser aceptados o rechazados.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  El iterador a ser filtrado.
  <info>callable</info>  <strong>$callback</strong>  La llamada de retorno, debe devolver <info>true</info> para aceptar el elemento  actual o
                       en caso contrario <info>false</info>. Véase los Ejemplos.
                       
                       Puede ser cualquier valor válido de <info>callback</info>.

<comment>Return:</comment>
  <info>unknown</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * Ejemplos de CallbackFilterIterator
   * CallbackFilterIterator::accept


id: CallbackFilterIterator::accept
type: function
doc:
<comment>Description:</comment>
  Llama la llamada de retorno con el valor actual, la clave actual y el iterador interior como
  argumentos
  
  Este método llama a la llamada de retorno con el valor actual, la clave  actual y el iterador
  interno.
  
  La llamada de retorno se espera que devuelva <info>true</info> si el elemento actual  es aceptado, o en caso
  contrario <info>false</info>.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> para aceptar el elemento actual, o en caso contrario <info>false</info>.

<comment>See Also:</comment>
   * Ejemplos de CallbackFilterIterator
   * CallbackFilterIterator::__construct


id: ClassName::class
type: constant
doc:
<comment>Description:</comment>
  El nombre de clase completamente cualificado. Véase también  ::class.


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>
  Clase empleada para representar funciones anónimas.
  
  Las funciones anónimas producían objetos de este tipo. Esta clase tiene métodos que permiten más
  control sobre las funciones anónimas después de haber sido creadas.
  
  Además de los métodos listados aquí, esta clase también posse un método <return>__invoke</return>. Está por
  consistencia con otras clases que implementan la llamada mágica, ya que este método no se usa para
  llamar a la función.


id: Closure::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor que anula la instanciación
  
  Este método sólo existe para anular la instanciación de la clase <class>Closure</class>. Los objetos de esta
  clase se crean del modo descrito en la página funciones anónimas.

<comment>See Also:</comment>
   * Funciones anónimas


id: Closure::bind
type: function
doc:
<comment>Description:</comment>
  Duplicar un cierre con un objeto vinculado y ámbito de clase especificados
    
  
  Este método es una versión estática de Closure::bindTo. Véase la documentación de ese método para
  más información.

<comment>Param:</comment>
  <info>Closure</info>             <strong>$closure</strong>   La función anónima a vincular.
  <info>object|null</info>         <strong>$newThis</strong>   El objeto al que la función anónima dada debería ser vinculado, o
                                 <info>null</info> para que el cierre sea desvinculado.
  <info>object|string|null</info>  <strong>$newScope</strong>  El ámbito de clase a la que asociar el cierre, o 'static' para
                                 mantener el actual. Si se proporciona un objeto, el tipo del mismo
                                 se usará en su lugar. Esto determina la visibilidad de métodos
                                 protegidos y privados del objeto vinculado. No se permite pasar (un
                                 objeto de) una clase interna a este parámetro.

<comment>Return:</comment>
  <info>Closure|null</info>  Devuelve un nuevo objeto <class>Closure</class> object, o <info>null</info> en caso de error.

<comment>See Also:</comment>
   * Funciones anónimas
   * Closure::bindTo


id: Closure::bindTo
type: function
doc:
<comment>Description:</comment>
  Duplicar el cierre con un objeto vinculado y ámbito de clase nuevos
    
  
  Crea y devuelve una nueva función anónima con el cuerpo y variables vinculadas como ésta, pero
  posiblemente con un objeto vinculado diferente y un nuevo ámbito de clase.
  
  El "objeto vinculado" determina el valor que <return>$this</return> tendrá en el cuerpo de la función, y el "ámbito
  de clase" representa una clase que determina los miembros privados y protegidos a los que será
  capaz de acceder la función anónima. Concretamente, los miembros que serán visibles son los mismos
  que si la función anónima fuese un método de la clase dada como valor del parámetro <strong>$newScope</strong>.
  
  Los cierres estáticos no pueden tener ningún objeto vinculado (el valor del parámetro <strong>$newThis</strong>
  debería ser <info>null</info>), pero esta función puede, no obstante, usarse para cambiar su ámbito de clase.
  
  Esta función se asegurará de que a un cierre no estático que tenga una instancia vinculada se le
  aplique un ámbito y viceversa. En este punto, los cierres no estáticos que le son dados un ámbito,
  excepto una instancia <info>null</info>, son hechos estáticos, y los cierres no estáticos y sin ámbito que le
  son dados una instancia no nula se les aplica un ámbito de clase no especificado.
  
  Si solamente se quieren duplicar las funciones anónimas, se puede usar cloning en su lugar.

<comment>Param:</comment>
  <info>object|null</info>         <strong>$newThis</strong>   El objeto al que la función anónima dada debería ser vinculado, o
                                 <info>null</info> para que el cierre sea desvinculado.
  <info>object|string|null</info>  <strong>$newScope</strong>  El ámbito de la clase a la que se va a asociar el cierre, o
                                 'static' para mantener el actual. Si se proporciona un objeto, el
                                 tipo del mismo se usará en su lugar. Esto determina la visibilidad
                                 de métodos protegidos y privados del objeto vinculado. No se
                                 permite pasar (un objeto de) una clase interna a este parémtro.

<comment>Return:</comment>
  <info>Closure|null</info>  Devuelve el objeto <class>Closure</class> recién creado, o <info>null</info> en caso de error.

<comment>See Also:</comment>
   * Funciones anónimas
   * Closure::bind


id: Closure::call
type: function
doc:
<comment>Description:</comment>
  Vincula y llama al cierre
  
  Vincula temporalmente el cierre a <strong>$newThis</strong>, y lo llama con cualquier parámetro dado.

<comment>Param:</comment>
  <info>object</info>  <strong>$newThis</strong>  El <info>object</info> a vincular al cierre mientras dure la llamada.
  <info>mixed</info>   <strong>$args</strong>     Cero o más parámetros, que serán dados como parámetros al cierre.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el valor devuelto por el cierre.


id: Closure::fromCallable
type: function
doc:
<comment>Description:</comment>
  Convierte un 'callable' en un cierre
  
  Crea y devuelve una nueva función anónima desde el <strong>$callback</strong> dado empleando el ámbito actual. Este
  método comprueba si <strong>$callback</strong> es llamable en el ámbito actual, lanzando un <class>TypeError</class> si no lo es.
  
  A partir de PHP 8.1.0, Sintaxis de llamada de primera clase tiene la misma semántica que este
  método.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  El «callable» a convertir.

<comment>Return:</comment>
  <info>Closure</info>  Devuelve el recién creado <class>Closure</class> o lanza un <class>TypeError</class> si <strong>$callback</strong> no es llamable en el
           ámbito actual.

<comment>See Also:</comment>
   * Funciones anónimas
   * Sintaxis de las llamadas de primera clase


id: Collator
type: class
doc:
<comment>Description:</comment>
  Proporciona la capacidad de comparar strings, con soporte para una ordenación apropiada, según la
  región.


id: Collator::ALTERNATE_HANDLING
type: constant
doc:
<comment>Description:</comment>
  El atributo Alternate se usa para controlar el manejo de los también llamados caracters variables
  en el UCA: los espacios en blanco, de puntuación y símbolos. Si Alternate se establece a
  NonIgnorable (N), las diferencias entre estos caracteres son de la misma importancia que las
  diferencias entre letras. Si Alternate se establece a Shifted (S), estos caracteres son de menor
  importancia. El valor Shifted a menudo se usa en combinación con Strength establecido a
  Quaternary. En tal caso, los espacios en blanco, de puntuación y símbolos se consideran cuando se
  comparan las cadenas, pero sólo si todos los demás aspectos de las cadenas (letras base, acentos y
  si son mayúsculas/minúsculas) son idénticos. Si Alternate no se establece a Shifted, no existe
  ninguna diferencia entre un Strength de 3 y un Strength de 4. Para más información y algunos
  ejemplos véase Variable_Weighting en el UCA. La razoón de que los valores de Alternate no sean
  simplemente On y Off es que se pueden añadir valores adicionales a Alternate en el futuro. La
  opción del UCA, Blanked, se expresa con Strength establecido a 3, y Alternate establecido a
  Shifted. Lo predeterminado para la mayoría de las configuraciones regionales es NonIgnorable. Si
  se selecciona Shifted, puede ser más lento si existen muchas cadenas que son la misma excepto por
  la puntuación; la longitud de la clave de ordenación no se verá afectada a menos que el nivel de
  fuerza (Strength) también sea aumentado.
  
  Los valores posibles son: <info>Collator::NON_IGNORABLE</info>
  (predeterminado)<info>Collator::SHIFTED</info><info>Collator::DEFAULT_VALUE</info>
  
  Reglas de ALTERNATE_HANDLING 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>
  El atributo Case_First se usa para controlar si las letras mayúsculas van antes que las minúsculas
  o viceversa, en ausencia de otras diferencias en las cadenas. Los valores posibles son
  Uppercase_First (U) y Lowercase_First (L), más el estándar Default y Off. No existe casi ninguna
  diferencia entre las opciones Off y Lowercase_First en términos de resultados, por lo que
  normalmente los usuarios no usarán Lowercase_First: solamente Off o Uppercase_First. (Los
  interesados en los detalles de las diferencias entre X y L deberían consultar la <return>Personalización
  del Cotejo</return>). Especificar L o U no afectará al rendimiento de la comparación de cadenas, pero
  afectará a la longitud de la clave de ordenación.
  
  Los valores posibles son: <info>Collator::OFF</info>
  (predeterminado)<info>Collator::LOWER_FIRST</info><info>Collator::UPPER_FIRST</info><info>Collator:DEFAULT</info>
  
  Reglas de CASE_FIRSTC=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>
  El atributo Case_Level se usa para cuando en el texto se quieren ignorar los acentos pero no si
  son mayúsculas/minúsculas. En tal situación, se establece Strength a Primary, y Case_Level a On.
  En la mayoría de las configuraciones regionales, este ajuste está establecido a Off por omision.
  Existe un pequeño impacto en el rendimiento de comparación de cadenas y en la ordenación por clave
  si este atributo se establece a On.
  
  Los valores posibles son: <info>Collator::OFF</info> (predeterminado)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>
  
  Reglas de CASE_LEVELS=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>
  Ordenar cadenas con diferentes acentos. Este atributo es establecido automáticamente a On para los
  identificadores regionales franceses y unos pocos más. Los usuarios normalmente no necesitarán
  establecer explicitamente este atributo. Existe un coste de rendimiento en la comparación de
  cadenas cuando se establece a On, excepto para la longitud de la clave de ordenación, que no se ve
  afectada. Los valores posibles son: <info>Collator::ON</info><info>Collator::OFF</info>
  (predeterminado)<info>Collator::DEFAULT_VALUE</info>
  
  Reglas de FRENCH_COLLATIONF=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>
  La compatibilidad con JIS x 4061 requiere la introducción de un nivel adinional para poder
  distinguir entre caracteres Hiragana y Katakana. Si se necesita compatibilidad con el estándar,
  este atributo debería establecerse a On y la fuerza (strength) a Quaternary. Esto afectará a la
  longitud de la clave de ordenación y al rendimiento en la comparación de cadenas.
  
  Los valores posibles son: <info>Collator::OFF</info> (predeterminado)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::NORMALIZATION_MODE
type: constant
doc:
<comment>Description:</comment>
  El ajuste Normalization determina si el texto se normaliza por completo o no en la comparación.
  Incluso si el ajuste está desactivado (lo predeterminado en muchas configuraciones regionales), el
  texto representado en su uso común se comparará correctamente (para más detalles, véase UTN #5).
  Solamente si los acentos están en orden no canónico existirá un problema. Si el ajuste se
  establece a On, se garantizan los mejores resultados para todas las posibles entradas de texto.
  Existe un coste medio de rendimiento en la comparación de cadenas si este atributo se establece a
  On, dependiendo de la frecuencia de secuencias que requiera la normalización. No hay un efecto
  significativo en la longitud de la clave de ordenación. Si el texto de entrada se sabe que está en
  la forma de normalización NFD o NFKD, no hay necesidad de habilitar esta opción Normalization.
  
  Los valores posibles son: <info>Collator::OFF</info> (predeterminado)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::NUMERIC_COLLATION
type: constant
doc:
<comment>Description:</comment>
  Cuando se activa, este atributo genera una clave de cotejo para el valor numérico de subcadenas de
  dígitos. Es una manera de obtener '100' DESPUÉS de '2' en una ordenación
  
  Los valores posibles son: <info>Collator::OFF</info> (predeterminado)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::STRENGTH
type: constant
doc:
<comment>Description:</comment>
  El Servicio de Cotejo de ICU soporta muchos niveles de comparación (llamados "Levels", pero
  también conocidos como "Strengths"). Tener estas categorías habilita a ICU para ordenar cadenas de
  manera precisa según las convenciones regionales. Sin embargo, al permitir que los niveles sean
  empleados selectivamente, la búsqueda de una cadena en un texto se podrá realizar con varias
  condiciones de coincidencia. Para una información más detallada, véase el capítlo
  <strong>collator_set_strength()</strong>.
  
  Los valores posibles son: <info>Collator::PRIMARY</info><info>Collator::SECONDARY</info><info>Collator::TERTIARY</info>
  (predeterminado)<info>Collator::QUATERNARY</info><info>Collator::IDENTICAL</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::__construct
type: function
doc:
<comment>Description:</comment>
  Crear un objeto Collator
  
  Crea una nueva instancia de Collator.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  La configuración regional cuyas normas de cotejo deberían usarse. Se pueden pasar
                   valores especiales de configuraciones regionales - si se proporciona null, se
                   usarán las normas de cotejo regionales predeterminadas. Si se proporciona "root",
                   se usarán las normas del UCA.
                   
                   Normalmente, el atributo Locale es el más importante para una ordenación y
                   comparación correctas, de acuerdo a las expectativas de los usuarios de paises y
                   regiones diferentes. La ordenación del UCA predeterminada sólo ordenará unos
                   pocos lenguajes, como el holandés y el portugués, de forma correcta ("de forma
                   correcta" significa de acuerdo a las expectativas normales de los usuarios de
                   dichos lenguajes). De otro modo, es necesario proporcionar la región al UCA para
                   cotejar apropiadamente el texto de un lenguaje dado. Por lo tanto, es necesario
                   proporcionar tanto una configuración regional como elegir un cotejador que se
                   adapte correctamente a esa región. La elección de una configuración regional
                   restablecerá automáticamente todos los atributos a valores que sean razonables
                   para esa región. Por lo tanto, la mayoría de las veces no es necesario establecer
                   los demás atributos de manera explícita. En algunos casos, la elección de una
                   configuración regional creará diferencias en el rendimiento de la comparación de
                   string y/o en la longitud de la clave de ordenación.

<comment>Return:</comment>
  <info>unknown</info>  Devuelve un objeto Collator.

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


id: Collator::asort
type: function
doc:
<comment>Description:</comment>
  Ordenar un array manteniendo la relación de índices
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Esta función ordena un array de forma que sus índices mantienen su correlación con los elementos
  del array a los que están asociados. Se usa principalmente en la ordenación de arrays asociativos
  donde el orden real de los elementos es significativo. Los elementos del array estarán ordenados
  según las normas actuales regionales.
  
  Es equivalente al estándar de PHP <strong>asort()</strong>.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$coll</strong>       Un objeto <class>Collator</class>.
  <info>array</info>     <strong>$arr</strong>        El array de cadenas a ordenar.
  <info>int</info>       <strong>$sort_flag</strong>  El tipo de ordenación opcional, uno de los siguientes:
                        <info>Collator::SORT_REGULAR</info> - comparar los elementos de forma normal (no cambia
                        los tipos) <info>Collator::SORT_NUMERIC</info> - comparar los elementos de forma numérica
                        <info>Collator::SORT_STRING</info> - comparar los elementos como cadenas
                        
                        <info>Collator::SORT_REGULAR</info> - comparar los elementos de forma normal (no cambia
                        los tipos)
                        
                        <info>Collator::SORT_NUMERIC</info> - comparar los elementos de forma numérica
                        
                        <info>Collator::SORT_STRING</info> - comparar los elementos como cadenas
                        
                        El valor predeterminado de $sort_flag value es <info>Collator::SORT_REGULAR</info>.
                        También se utiliza si se ha especificado un valor no válido para $sort_flag.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * Las constantes de <class>Collator</class>
   * <strong>collator_sort()</strong>
   * <strong>collator_sort_with_sort_keys()</strong>


id: Collator::compare
type: function
doc:
<comment>Description:</comment>
  Comparar dos cadenas Unicode
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Compara dos cadenas Unicode según las normas de cotejo.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$coll</strong>  Un objeto <class>Collator</class>.
  <info>string</info>    <strong>$str1</strong>  La primera cadena a comparar.
  <info>string</info>    <strong>$str2</strong>  La segunda cadena a comparar.

<comment>Return:</comment>
  <info>int</info>  Devuelve el resultado de la comparación:
       
        1 si <strong>$str1</strong> es mayor que <strong>$str2</strong> ;  0 si <strong>$str1</strong> es igual a <strong>$str2</strong>;  -1 si <strong>$str1</strong> es menor que
       <strong>$str2</strong> .  En caso de error es devuelto el valor <info>false</info> de tipo <info>boolean</info>.
       
       1 si <strong>$str1</strong> es mayor que <strong>$str2</strong> ;
       
       0 si <strong>$str1</strong> es igual a <strong>$str2</strong>;
       
       -1 si <strong>$str1</strong> es menor que <strong>$str2</strong> .
       
       Esta función puede
       devolver el valor booleano <info>false</info>, pero también puede devolver un valor no booleano que se
       evalúa como <info>false</info>. Por favor lea la sección sobre Booleanos para más
       información. Use el operador
       === para comprobar el valor devuelto por esta
       función.

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


id: Collator::create
type: function
doc:
<comment>Description:</comment>
  Crear un cotejador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Las cadenas serán comparadas usando las opciones ya especificadas.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  La configuración regional que contiene las normas de cotejo requeridas. Se pueden
                   pasar valores especiales de configuraciones regionales - si se le pasa null, se
                   usarán las normas de cotejo regionales predeterminadas. Si se le pasa una cadena
                   vacía ("") o "root", se usarán las normas del UCA.

<comment>Return:</comment>
  <info>Collator</info>  Devuelve una nueva instancia de un objeto <class>Collator</class>, o <info>null</info> en case de error.

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


id: Collator::getAttribute
type: function
doc:
<comment>Description:</comment>
  Obtener el valor de un atributo de cotejo
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene el valor de un atributo de cotejo de tipo integer.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$coll</strong>  <class>Collator</class> object.
  <info>int</info>       <strong>$attr</strong>  El atributo del que obtener el valor.

<comment>Return:</comment>
  <info>int</info>  El valor del atributo, o <info>false</info> de tipo <info>boolean</info> en case de error.

<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>
  Obtener el último código de error del cotejeador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Un objeto de la clase <class>Collator</class>.

<comment>Return:</comment>
  <info>int|false</info>  El código de error devuelto por la última llamada a una función de la API de Collator,
             o <info>false</info> en caso de error.

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


id: Collator::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Obtener el texto del último código de error del cotejador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Recupera el mensaje del último error.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Un objeto de la clase <class>Collator</class>.

<comment>Return:</comment>
  <info>string|false</info>  La descripción de un error ocurrido en la última llamada a una función de la API de
                Collator, o <info>false</info> en caso de error.

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


id: Collator::getLocale
type: function
doc:
<comment>Description:</comment>
  Obtener el nombre de la configuración regional del cotejador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene el nombre de la configuración regional del cotejador.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$coll</strong>  Un objeto de la clase <class>Collator</class>.
  <info>int</info>       <strong>$type</strong>  Se puede escoger entre una configuración regional válida y real (
                   <info>Locale::VALID_LOCALE</info> y <info>Locale::ACTUAL_LOCALE</info>, respectivamente).

<comment>Return:</comment>
  <info>string</info>  El nombre de la configuración regional real de donde viene la información del cotejador.
          Si el cotejador fue instanciado desde normas u ocurrió un error, devuelve <info>false</info> de tipo
          <info>boolean</info>.

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


id: Collator::getSortKey
type: function
doc:
<comment>Description:</comment>
  Obtener la clave de ordenación de una cadena
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve la clave de cotejo de una cadena.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$coll</strong>  Un objeto de la clase <class>Collator</class>.
  <info>string</info>    <strong>$str</strong>   La cadena desde la que producir la clave.

<comment>Return:</comment>
  <info>string</info>  Devuelve la calve de cotejo de una cadena. Las claves de cotejo se pueden comparar
          directamente en lugar de por cadenas.
          
          Esta función puede
          devolver el valor booleano <info>false</info>, pero también puede devolver un valor no booleano que se
          evalúa como <info>false</info>. Por favor lea la sección sobre Booleanos para más
          información. Use el operador
          === para comprobar el valor devuelto por esta
          función.

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


id: Collator::getStrength
type: function
doc:
<comment>Description:</comment>
  Obtener la fuerza de cotejo actual
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  

<comment>Param:</comment>
  <info>Collator</info>  <strong>$coll</strong>  Un objeto <class>Collator</class>.

<comment>Return:</comment>
  <info>int</info>  Devuelve la fuerza de cotejo actual, o <info>false</info> de tipo <info>boolean</info> en caso de error.

<comment>See Also:</comment>
   * Las constantes de <class>Collator</class>
   * <strong>collator_set_strength()</strong>
   * <strong>collator_get_attribute()</strong>


id: Collator::setAttribute
type: function
doc:
<comment>Description:</comment>
  Establecer el atributo de cotejo
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  

<comment>Param:</comment>
  <info>Collator</info>  <strong>$coll</strong>  <class>Collator</class><info>object</info>.
  <info>int</info>       <strong>$attr</strong>  Attribute.
  <info>int</info>       <strong>$val</strong>   El valor del atributo.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * Las constantes de <class>Collator</class>
   * <strong>collator_get_attribute()</strong>
   * <strong>collator_set_strength()</strong>


id: Collator::setStrength
type: function
doc:
<comment>Description:</comment>
  Establecer la fuerza (strength) de un cotejo
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  El Servicio de Cotejo de ICU soporta muchos niveles de comparación (llamados "Levels", pero
  también conocidos como "Strengths"). Tener estas categorías habilita a ICU para ordenar cadenas de
  manera precisa según las convenciones regionales. Sin embargo, al permitir que los niveles sean
  empleados selectivamente, la búsqueda de una cadena en un texto se podrá realizar con varias
  condiciones de coincidencia.
  
   Nivel Primario (Primary): Se utiliza normalmente para denotar diferencias entre caracteres base
  (por ejemplo, "a"
  \< "b"). Es la diferencia más fuerte. Por ejemplo, los diccionarios están divididos en diferentes secciones mediante caracteres base. También se le llama fuerza de nivel 1.  Nivel Secundario (Secondary): Los acentos de los caracteres se consideran diferencias secundarias (por ejemplo, "as" \< "às" \< "at"). También se pueden considerar como secundarias otras diferencias entre letras, dependiendo del lenguaje. Una diferencia secundaria es ignorada cuando existe una diferencia primaria en cualquier lugar de las cadenas. También se le llama fuerza de nivel 2.  Nota: En algunos lenguajes (como en el danés), algunas letras acentuadas están consideradas como caracteres base por separado. Sin embargo, en la mayoría de los lenguajes, una letra acentuada solamente tiene una diferencia secundaria con su versión no acentuada de esa misma letra.   Nivel Terciario (Tertiary): Las diferencias entre caracteres mayúsculas y minúsculas se distinguen en el nivel terciario (por ejemplo, "ao" \< "Ao" \< "aò"). Además, una variante de una letra difiere de su forma base en este nivel (como "A" y " "). Otro ejemplo es la diferencia entre un Kana grande y uno pequeño. Una diferencia terciaria es ignorada cuando existe una diferencia primaria o secundaria en cualquier lugar de las cadenas. También se le llama fuerza de nivel 3.  Nivel Cuaternario (Quaternary): Cuando se ignora la puntuación (véase Ignorar la Puntuación) en el nivel 13, se puede usar un nivel adicional para distinguir entre palabra con y sin puntuación (por ejemplo, "ab" \< "a-b" \< "aB"). Esta diferencia es ignorada cuando existe una diferencia primaria, secundaria o terciaria. También se le llama fuerza de nivel 4. El nivel cuaternario sólo debería usarse si es necesario ignorar la puntuación o al procesar texto japonés (véase el procesamiento de Hiragana).  Nivel Idéntico (Identical): Cuando todos los demás niveles son iguales, el nivel idéntico se usa como "desempate". Los valores de los caracteres Unicode de la forma NFD de cada cadena se comparan en este nivel, como en el caso de que no existan diferencias en los niveles 14. Por ejemplo, las marcas de cantilación hebreas sólo son distinguibles en este nivel. Este nivel debería usarse poco, ya que las diferencias de los valores de los caracteres entre dos cadenas ocurre en raras ocasiones. Usar este nivel disminuye sustancialmente el rendimiento de la comparación incremental y la generación de claves de ordenación (así como también aumenta la longitud de las claves de ordenación). También es conocido como fuerza de nivel 5
  
   Nivel Primario (Primary): Se utiliza normalmente para denotar diferencias entre caracteres base
  (por ejemplo, "a"
  \< "b"). Es la diferencia más fuerte. Por ejemplo, los diccionarios están divididos en diferentes secciones mediante caracteres base. También se le llama fuerza de nivel 1.
  
   Nivel Secundario (Secondary): Los acentos de los caracteres se consideran diferencias secundarias
  (por ejemplo, "as"
  \< "às" \< "at"). También se pueden considerar como secundarias otras diferencias entre letras, dependiendo del lenguaje. Una diferencia secundaria es ignorada cuando existe una diferencia primaria en cualquier lugar de las cadenas. También se le llama fuerza de nivel 2.  Nota: En algunos lenguajes (como en el danés), algunas letras acentuadas están consideradas como caracteres base por separado. Sin embargo, en la mayoría de los lenguajes, una letra acentuada solamente tiene una diferencia secundaria con su versión no acentuada de esa misma letra.
  
  Nota: En algunos lenguajes (como en el danés), algunas letras acentuadas están consideradas como
  caracteres base por separado. Sin embargo, en la mayoría de los lenguajes, una letra acentuada
  solamente tiene una diferencia secundaria con su versión no acentuada de esa misma letra.
  
   Nivel Terciario (Tertiary): Las diferencias entre caracteres mayúsculas y minúsculas se
  distinguen en el nivel terciario (por ejemplo, "ao"
  \< "Ao" \< "aò"). Además, una variante de una letra difiere de su forma base en este nivel (como "A" y " "). Otro ejemplo es la diferencia entre un Kana grande y uno pequeño. Una diferencia terciaria es ignorada cuando existe una diferencia primaria o secundaria en cualquier lugar de las cadenas. También se le llama fuerza de nivel 3.
  
   Nivel Cuaternario (Quaternary): Cuando se ignora la puntuación (véase Ignorar la Puntuación) en
  el nivel 13, se puede usar un nivel adicional para distinguir entre palabra con y sin puntuación
  (por ejemplo, "ab"
  \< "a-b" \< "aB"). Esta diferencia es ignorada cuando existe una diferencia primaria, secundaria o terciaria. También se le llama fuerza de nivel 4. El nivel cuaternario sólo debería usarse si es necesario ignorar la puntuación o al procesar texto japonés (véase el procesamiento de Hiragana).
  
   Nivel Idéntico (Identical): Cuando todos los demás niveles son iguales, el nivel idéntico se usa
  como "desempate". Los valores de los caracteres Unicode de la forma NFD de cada cadena se comparan
  en este nivel, como en el caso de que no existan diferencias en los niveles 14. Por ejemplo, las
  marcas de cantilación hebreas sólo son distinguibles en este nivel. Este nivel debería usarse
  poco, ya que las diferencias de los valores de los caracteres entre dos cadenas ocurre en raras
  ocasiones. Usar este nivel disminuye sustancialmente el rendimiento de la comparación incremental
  y la generación de claves de ordenación (así como también aumenta la longitud de las claves de
  ordenación). También es conocido como fuerza de nivel 5
  
  Por ejemplo, se puede escoger ignorar los acentos o ignorara los acentos y si son
  mayúsculas/minúsculas en la búsqueda de un texto. La mayoría de los caracteres son distinguibles
  por los tres primeros niveles, y en la mayoría de las configuraciones regionales el valor
  predeterminado es por lo tanto Tertiary. Sin embargo, si Alternate se establece a Shifted, la
  fuerza Quaternary se podría usar para romper "empates" entre espacios en blanco, puntiaciones y
  símbolos que de otra manera serían ignorados. Si se necesita distinguir de manera precisa entre
  caracteres, se puede usar la fuerza Identical (por ejemplo, la Fuerza Identical distinque entre la
  A Matemática Pequeña Negrita y la A Matemática Pequeña Itálica). Sin embargo, al usar niveles
  mayores que el terciario la fuerza Identical resulta en claves de ordenación significativamente
  más grandes, y un rendimiento más lento en la comparación de cadenas iguales.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$coll</strong>      Uh objeto <class>Collator</class>.
  <info>int</info>       <strong>$strength</strong>  La fuerza a establecer.
                       
                       Los valores posibles son:
                       <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>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * Las constantes de <class>Collator</class>
   * <strong>collator_get_strength()</strong>


id: Collator::sort
type: function
doc:
<comment>Description:</comment>
  Ordenar un array usando cotejador especificado
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Esta función ordena un array según las normal regionales actuales.
  
  Es equivalente al estándar de PHP <strong>sort()</strong>.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Un objeto <class>Collator</class>.
  <info>array</info>     <strong>$array</strong>   El array de cadenas a ordenar.
  <info>int</info>       <strong>$flags</strong>   El tipo de ordenación opcional, uno de los siguientes:
                     
                     <info>Collator::SORT_REGULAR</info> - comparar los elementos de forma normal (no cambia los
                     tipos) <info>Collator::SORT_NUMERIC</info> - comparar los elementos de forma numérica
                     <info>Collator::SORT_STRING</info> - comparar los elementos como cadenas  El valor
                     predeterminado de $sort_flag value es <info>Collator::SORT_REGULAR</info>. También se
                     utiliza si se ha especificado un valor no válido para <strong>$flags</strong>.
                     
                     <info>Collator::SORT_REGULAR</info> - comparar los elementos de forma normal (no cambia los
                     tipos)
                     
                     <info>Collator::SORT_NUMERIC</info> - comparar los elementos de forma numérica
                     
                     <info>Collator::SORT_STRING</info> - comparar los elementos como cadenas

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * Las constantes de <class>Collator</class>
   * <strong>collator_asort()</strong>
   * <strong>collator_sort_with_sort_keys()</strong>


id: Collator::sortWithSortKeys
type: function
doc:
<comment>Description:</comment>
  Ordenar un array usando el cotejador y las claves de ordenación especificados
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Esta función es similar <strong>collator_sort()</strong> excepto que utiliza las claves de ordenación de ICU
  producidas por ucol_getSortKey() para conseguir más velocidad en arrays grandes.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Un objeto <class>Collator</class>.
  <info>array</info>     <strong>$array</strong>   El array de cadenas a ordenar.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * Las constantes de <class>Collator</class>
   * <strong>collator_sort()</strong>
   * <strong>collator_asort()</strong>


id: Collectable::isGarbage
type: function
doc:
<comment>Description:</comment>
  Determinar si un objeto ha sido marcado como basura
  
  Se puede llamar en Pool::collect para determinar si este objeto es basura.

<comment>Return:</comment>
  <info>bool</info>  Siempre devuelve <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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.


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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: ColumnResult::getCollationName
type: function
doc:
<comment>Description:</comment>
  Get collation name
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: ColumnResult::getColumnLabel
type: function
doc:
<comment>Description:</comment>
  Get column label
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: ColumnResult::getColumnName
type: function
doc:
<comment>Description:</comment>
  Get column name
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: ColumnResult::getLength
type: function
doc:
<comment>Description:</comment>
  Get column field length
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: ColumnResult::getTableLabel
type: function
doc:
<comment>Description:</comment>
  Get table label
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: ColumnResult::getTableName
type: function
doc:
<comment>Description:</comment>
  Get table name
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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::accept
type: function
doc:
<comment>Description:</comment>
  Visitation

<comment>Param:</comment>
  <info>CommonMark\Interfaces\IVisitor</info>  <strong>$visitor</strong>  Un objeto implementando <class>CommonMark\Interfaces\IVisitor</class>

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

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


id: CommonMark\Node::appendChild
type: function
doc:
<comment>Description:</comment>
  AST Manipulation
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: CommonMark\Node\BulletList::__construct
type: function
doc:
<comment>Description:</comment>
  BulletList Construction
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.


id: CommonMark\Node\CodeBlock::__construct
type: function
doc:
<comment>Description:</comment>
  CodeBlock Construction
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.


id: CommonMark\Node\Image::__construct
type: function
doc:
<comment>Description:</comment>
  Image Construction
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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>
  Constructor OrderedList
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: CommonMark\Parse
type: function
doc:
<comment>Description:</comment>
  Parsing
  
  Deberá analizar <strong>$content</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$content</strong>  reducción de la carga string
  <info>int</info>     <strong>$options</strong>  Una máscara de:

<comment>Return:</comment>
  <info>CommonMark\Node</info>  Devolverá la raíz de 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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: CommonMark\Parser::finish
type: function
doc:
<comment>Description:</comment>
  Parsing
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: CommonMark\Parser::parse
type: function
doc:
<comment>Description:</comment>
  Parsing
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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>
  Esta abstracta final representa una entrada de clase, y no debe ser usado por el programador.


id: Componere\Abstract\Definition::addInterface
type: function
doc:
<comment>Description:</comment>
  Añadir Interface
  
  Implementará la interface dada en la definición actual

<comment>Param:</comment>
  <info>string</info>  <strong>$interface</strong>  El nombre de una interface insensible a las mayúsculas y minúsculas

<comment>Return:</comment>
  <info>Definition</info>  La definición actual


id: Componere\Abstract\Definition::addMethod
type: function
doc:
<comment>Description:</comment>
  Añadir método
  
  Creará o anulará un método en la definición actual.

<comment>Param:</comment>
  <info>string</info>             <strong>$name</strong>    El nombre del método insensible a las mayúsculas y minúsculas
  <info>\Componere\Method</info>  <strong>$method</strong>  <info>\Componere\Method</info> que no se haya añadido previamente a otra <info>Definition</info>

<comment>Return:</comment>
  <info>Definition</info>  La Definition actual


id: Componere\Abstract\Definition::addTrait
type: function
doc:
<comment>Description:</comment>
  Añadir rasgo
  
  Usará el rasgo dado para la definición actual

<comment>Param:</comment>
  <info>string</info>  <strong>$trait</strong>  El nombre del rasgo insensible a las mayúsculas y minúsculas

<comment>Return:</comment>
  <info>Definition</info>  La definición actual


id: Componere\Abstract\Definition::getReflector
type: function
doc:
<comment>Description:</comment>
  Reflection
  
  Creará o devolverá una clase Reflection

<comment>Return:</comment>
  <info>\ReflectionClass</info>  Una clase Reflection para la definición actual (en caché)


id: Componere\Definition
type: class
doc:
<comment>Description:</comment>
  La clase Definition permite al programador construir y registrar un tipo en tiempo de ejecución.
  
  En caso de que una Definition reemplace una clase existente, la clase existente será restaurada
  cuando la Definition sea destruida.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>        Un nombre de clase insensible a las mayúsculas y minúsculas
  <info>string</info>  <strong>$parent</strong>      Un nombre de clase insensible a las mayúsculas y minúsculas
  <info>array</info>   <strong>$interfaces</strong>  Un array de nombres de clase insensibles a las mayúsculas y minúsculas


id: Componere\Definition::addConstant
type: function
doc:
<comment>Description:</comment>
  Añade constante
  
  Declarará una constante de clase en la definición actual

<comment>Param:</comment>
  <info>string</info>            <strong>$name</strong>   El nombre de la constante que distingue entre mayúsculas y minúsculas
  <info>\Componere\Value</info>  <strong>$value</strong>  El valor de la constante, no debe ser indefinido o estático

<comment>Return:</comment>
  <info>Definition</info>  La definición actual


id: Componere\Definition::addProperty
type: function
doc:
<comment>Description:</comment>
  Añade propiedad
  
  Declarará una propiedad de clase sobre la definición actual

<comment>Param:</comment>
  <info>string</info>            <strong>$name</strong>   El nombre de la propiedad distingue mayúsculas y minúsculas
  <info>\Componere\Value</info>  <strong>$value</strong>  El valor por omisión de la propiedad

<comment>Return:</comment>
  <info>Definition</info>  La definición actual


id: Componere\Definition::getClosure
type: function
doc:
<comment>Description:</comment>
  Obtener Cierre
  
  Devolverá un cierre para el método especificado por el nombre

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El nombre del método insensible a las mayúsculas y minúsculas

<comment>Return:</comment>
  <info>\Closure</info>  Un cierre vinculado al alcance correcto


id: Componere\Definition::getClosures
type: function
doc:
<comment>Description:</comment>
  Obtener Cierres
  
  Devolverá un array de cierres

<comment>Return:</comment>
  <info>array</info>  Devolverá todos los métodos como un array de objetos de cierre vinculados al alcance
         correcto


id: Componere\Definition::isRegistered
type: function
doc:
<comment>Description:</comment>
  Detección del estado
  
  Deberá detectar el estado de registro de Definition

<comment>Return:</comment>
  <info>bool</info>  Devolverá true si Definition está registrada


id: Componere\Definition::register
type: function
doc:
<comment>Description:</comment>
  Registro
  
  Registrará la Definition actual

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


id: Componere\Method
type: class
doc:
<comment>Description:</comment>
  Un método representa una función con banderas de accesibilidad modificables


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

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


id: Componere\Method::getReflector
type: function
doc:
<comment>Description:</comment>
  Reflection
  
  Creará o devolverá un Método de Reflection

<comment>Return:</comment>
  <info>\ReflectionMethod</info>  Un método de Reflection para el método actual (en caché)


id: Componere\Method::setPrivate
type: function
doc:
<comment>Description:</comment>
  Modificación de la accesibilidad

<comment>Return:</comment>
  <info>Method</info>  El método actual


id: Componere\Patch
type: class
doc:
<comment>Description:</comment>
  La clase Patch permite al programador cambiar el tipo de una instancia en tiempo de ejecución sin
  registrar una nueva Definition
  
  Cuando se destruye un parche se revierte, de modo que los casos que fueron parcheados durante la
  vida del Parche son restaurados a su tipo formal.


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

<comment>Param:</comment>
  <info>object</info>  <strong>$instance</strong>    El objetivo de este Patch
  <info>array</info>   <strong>$interfaces</strong>  Un array  de nombres de clase insensibles a las mayúsculas y minúsculas


id: Componere\Patch::apply
type: function
doc:
<comment>Description:</comment>
  Aplicación
  
  Aplicará el parche actual

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


id: Componere\Patch::derive
type: function
doc:
<comment>Description:</comment>
  Derivación del parche
  
  Derivará un <info>Patch</info> (parche) para la <strong>$instance</strong> (instancia) dada

<comment>Param:</comment>
  <info>object</info>  <strong>$instance</strong>  El objetivo del Parche derivado

<comment>Return:</comment>
  <info>Patch</info>  <info>Patch</info> (parche) para la <strong>$instance</strong> (instancia) derivada del <info>Patch</info> (parche) actual


id: Componere\Patch::getClosure
type: function
doc:
<comment>Description:</comment>
  Obtener Cierre
  
  Devolverá un cierre para el método especificado por el nombre

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El nombre del método insensible a las mayúsculas y minúsculas

<comment>Return:</comment>
  <info>\Closure</info>  Un cierre vinculado al ámbito y objeto correctos


id: Componere\Patch::getClosures
type: function
doc:
<comment>Description:</comment>
  Obtener Cierres
  
  Devolverá un array de Cierres

<comment>Return:</comment>
  <info>array</info>  Devolverá todos los métodos como un array de objetos de cierre unidos al ámbito y objeto
         correctos


id: Componere\Patch::isApplied
type: function
doc:
<comment>Description:</comment>
  Detección del estado

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


id: Componere\Patch::revert
type: function
doc:
<comment>Description:</comment>
  Reversión
  
  Revertirá el parche actual

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


id: Componere\Value
type: class
doc:
<comment>Description:</comment>
  Una clase Value representa una variable PHP de todos los tipos, incluyendo las indefinidas


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

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


id: Componere\Value::hasDefault
type: function
doc:
<comment>Description:</comment>
  Interacción de Value

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


id: Componere\Value::isPrivate
type: function
doc:
<comment>Description:</comment>
  Detección de accesibilidad

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


id: Componere\Value::setPrivate
type: function
doc:
<comment>Description:</comment>
  Modificación de la accesibilidad

<comment>Return:</comment>
  <info>Value</info>  El valor actual


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

<comment>Param:</comment>
  <info>Type</info>  <strong>$type</strong>    Un tipo definido por el usuario
  <info></info>      <strong>$object</strong>  Un objeto con un tipo definido por el usuario compatible con Type

<comment>Return:</comment>
  <info>Type</info>  Un <info>object</info> de tipo Type, moldeado de <strong>$object</strong>

<comment>See Also:</comment>
   * 


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

<comment>Param:</comment>
  <info></info>  <strong>$object</strong>  Un objeto con un tipo definido por el usuario compatible con Type

<comment>Return:</comment>
  <info>Type</info>  Un <info>object</info> de tipo Type, moldeado de <strong>$object</strong>, donde los miembros son referencias a miembros
        de <strong>$object</strong>

<comment>See Also:</comment>
   * 


id: Countable
type: class
doc:
<comment>Description:</comment>
  Las clases implementado <class>Countable</class> pueden ser usadas con la función <strong>count()</strong>.


id: Countable::count
type: function
doc:
<comment>Description:</comment>
  Cuenta los elementos de un objeto
  
  Este método se ejecuta cuando se utiliza la función <strong>count()</strong> sobre un objeto que implemente la
  interfaz <class>Countable</class>.

<comment>Return:</comment>
  <info>int</info>  El recuento personalizado como un <info>integer</info>.
       
       El valor devuelto se convierte en <info>integer</info>.


id: CrudOperationBindable::bind
type: function
doc:
<comment>Description:</comment>
  Bind value to placeholder
  
  Binds a value to a specific placeholder.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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: DATE_ISO8601
type: constant
doc:
<comment>Description:</comment>
  ISO-8601 (ejemplo: 2005-08-15T15:52:01+0000)
  
  Este formato no es compatible con el ISO-8601, aunque se deja por razones de retrocompatibilidad.
  Use <info>DateTime::ATOM</info> o <info>DATE_ATOM</info> en su lugar para que sea compatible con el ISO-8601.


id: DATE_RFC3339_EXTENDED
type: constant
doc:
<comment>Description:</comment>
  RFC 3339 EXTENDED format (desde PHP 7.0.0) (ejemplo: 2005-08-15T15:52:01.000+00:00)


id: DB2_AUTOCOMMIT_OFF
type: constant
doc:
<comment>Description:</comment>
  Indica que se debe deshabilitar la opción autocommit (No se realizan los cambios inmediatamente).


id: DB2_AUTOCOMMIT_ON
type: constant
doc:
<comment>Description:</comment>
  Indica que se debe habilitar la opción autocommit (Realizar cambios inmediatamente).


id: DB2_BINARY
type: constant
doc:
<comment>Description:</comment>
  Indica que los datos binarios se tienen que devolver tal cual. Este es el modo por omisión.


id: DB2_CASE_LOWER
type: constant
doc:
<comment>Description:</comment>
  Indica que los nombres de las columnas se devolverán en minúsculas.


id: DB2_CASE_NATURAL
type: constant
doc:
<comment>Description:</comment>
  Especifica que los nombres de columnas se devolverán respetando mayúsculas y minúsculas.


id: DB2_CASE_UPPER
type: constant
doc:
<comment>Description:</comment>
  Indica que los nombres de las columnas se devolverán en mayúsculas.


id: DB2_CHAR
type: constant
doc:
<comment>Description:</comment>
  Indica que la variable se establecerá en forma de CHAR o VARCHAR.


id: DB2_CONVERT
type: constant
doc:
<comment>Description:</comment>
  Indica que los datos binarios se tienen que codificar a hexadecimal y se devuelven en forma de
  string ASCII.


id: DB2_DEFERRED_PREPARE_OFF
type: constant
doc:
<comment>Description:</comment>
  Deshabilita las sentencias preparadas en el recurso especificado.


id: DB2_DOUBLE
type: constant
doc:
<comment>Description:</comment>
  Indica que la variable se establecerá en forma de DOUBLE, FLOAT, o REAL.


id: DB2_FORWARD_ONLY
type: constant
doc:
<comment>Description:</comment>
  Especifica un cursor de sólo avance en un recurso de tipo sentencia. Este es el tipo de cursor por
  omisión y está soportado por todas las bases de datos.


id: DB2_LONG
type: constant
doc:
<comment>Description:</comment>
  Indica que la variable se establecerá en forma de SMALLINT, INTEGER, o BIGINT.


id: DB2_PARAM_FILE
type: constant
doc:
<comment>Description:</comment>
  Indica que la columna debe vincularse directamente a un fichero de entrada.


id: DB2_PARAM_IN
type: constant
doc:
<comment>Description:</comment>
  Indifica que la variable PHP se utilizará como parámetro IN en los procedimientos almacenados.


id: DB2_PARAM_INOUT
type: constant
doc:
<comment>Description:</comment>
  Especifica que la variable PHP se utilizará como parámetro INOUT en los procedimientos
  almacenados.


id: DB2_PARAM_OUT
type: constant
doc:
<comment>Description:</comment>
  Especifica que la variable PHP se utilizará como parámetro OUT en los procedimientos almacenados.


id: DB2_PASSTHRU
type: constant
doc:
<comment>Description:</comment>
  Indica que los datos binarios se tienen que convertir al valor <info>null</info>.


id: DB2_SCROLLABLE
type: constant
doc:
<comment>Description:</comment>
  Especifica un cursor trasladable en un recurso de tipo sentencia. Este modo permite acceder
  libremente a las filas de un juego de resultados, pero por ahora sólo está soportado por la Base
  de datos Universal IBM DB2.


id: DISP_E_DIVBYZERO
type: constant
doc:
<comment>Description:</comment>
  -2147352558
  
  Un error devuelto que indica un error de división por cero.


id: DISP_E_OVERFLOW
type: constant
doc:
<comment>Description:</comment>
  -2147352566
  
  Un error que indica que un valor no puede ser coaccionado a su representación esperada.


id: DISTORTION_AFFINE
type: constant
doc:
<comment>Description:</comment>
  Esta constante está disponible si Imagick ha sido compilado con ImageMagick en su versión  6.3.6 o
  superior.


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_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 un atributo en el objeto <class>DOMElement</class>.


id: DOMAttr::__construct
type: function
doc:
<comment>Description:</comment>
  Crea un nuevo objeto DOMAttr
  
  Crea un nuevo objeto DOMAttr. Este objeto es de sólo lectura.  Puede ser anexado a un documento,
  pero no se le podrán anexar nodos adicionales a este hasta que sea asociado con un documento. Para
  crear un nodo modificable utilice  .

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   El nombre de etiqueta del atributo.
  <info>string</info>  <strong>$value</strong>  El valor de atributo.

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


id: DOMAttr::isId
type: function
doc:
<comment>Description:</comment>
  Verifica si un atributo es un ID definido.
    
  
  Esta función verifica si el atributo es un ID definido.
  
  De acuerdo al estándar DOM esto requiere una DTD que defina que el atributo ID  sea de tipo ID.
  Necesitará validar su documento con   o <return>DOMDocument::validateOnParse</return> antes de utilizar esta
  función.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: DOMCdataSection
type: class
doc:
<comment>Description:</comment>
  <class>DOMCdataSection</class> hereda de <class>DOMText</class> para la representación textural de constructores CData.


id: DOMCdataSection::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un nuevo objeto DOMCdataSection
  
  Construye un nuevo nodo CDATA. Funciona igual que la clase <class>DOMText</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  El valor del nodo CDATA. Si no se proporciona, se crea un nodo CDATA vacío.

<comment>See Also:</comment>
   * DOMText::__construct
   * DOMDocument::createTextNode


id: DOMCharacterData
type: class
doc:
<comment>Description:</comment>
  Representa nodos con datos de caracteres. Ningún nodo corresponde directamente a esta clase pero
  otros nodos pueden heredar de ella.


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>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMCharacterData::before


id: DOMCharacterData::appendData
type: function
doc:
<comment>Description:</comment>
  Añade el string de caracteres al final de los datos de carácter del nodo.
    
  
  Añade el string <strong>$data</strong> hasta el final de los datos de carácter del nodo.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  El string de caracteres a añadir.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<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>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * DOMChildNode::before
   * DOMCharacterData::after


id: DOMCharacterData::deleteData
type: function
doc:
<comment>Description:</comment>
  Eliminar una serie de caracteres del nodo
    
  
  Elimina <strong>$count</strong> caracteres comenzando desde la posición    <strong>$offset</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  El índice desde el cual se comenzará a remover.
  <info>int</info>  <strong>$count</strong>   La cantidad de caracteres a eliminar. Si la suma de <strong>$offset</strong> y <strong>$count</strong> excede la
                longitud, entonces todos los caracteres al final de la data son eliminados.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * DOMCharacterData::appendData
   * DOMCharacterData::insertData
   * DOMCharacterData::replaceData
   * DOMCharacterData::substringData


id: DOMCharacterData::insertData
type: function
doc:
<comment>Description:</comment>
  Inserta un string en la posición de 16-bit especificada
    
  
  Inserta el string <strong>$data</strong> en la posición <strong>$offset</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>  La posición en la cual se insertará.
  <info>string</info>  <strong>$data</strong>    El string a insertar.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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

<comment>See Also:</comment>
   * DOMChildNode::remove
   * DOMCharacterData::after
   * DOMCharacterData::before
   * DOMCharacterData::replaceWith
   * DOMNode::removeChild


id: DOMCharacterData::replaceData
type: function
doc:
<comment>Description:</comment>
  Reemplaza un substring dentro de un nodo DOMCharacterData
    
  
  Reemplaza <strong>$count</strong> caracteres comenzando en la posicion <strong>$offset</strong> con <strong>$data</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>  La posición inicial a partir de la cual se iniciara el reemplazo.
  <info>int</info>     <strong>$count</strong>   El número de carácteres a reemplazar. Si la suma de <strong>$offset</strong> y <strong>$count</strong> excede la
                   longitud, entonces todos los carácteres al final de la data son reemplazados.
  <info>string</info>  <strong>$data</strong>    El string con el cual el rango debe ser reemplazado.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<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>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * DOMChildNode::replaceWith
   * DOMCharacterData::after
   * DOMCharacterData::before
   * DOMCharacterData::remove


id: DOMCharacterData::substringData
type: function
doc:
<comment>Description:</comment>
  Extrae una serie de datos del nodo
    
  
  Devuelve el substring especificado.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  Posición de inicio del substring a extraer.
  <info>int</info>  <strong>$count</strong>   El número de carácteres a extraer.

<comment>Return:</comment>
  <info>string</info>  El substring especificado. Si la suma de <strong>$offset</strong>  y <strong>$count</strong> excede la longitud, entonces
          todas las unidades de 16-bit hasta el final de la cadena son devueltas.

<comment>See Also:</comment>
   * DOMCharacterData::appendData
   * DOMCharacterData::deleteData
   * DOMCharacterData::insertData
   * DOMCharacterData::replaceData


id: DOMComment
type: class
doc:
<comment>Description:</comment>
  Representa nodos comentario, caracteres delimitados por \<!-- y --&gt;.


id: DOMComment::__construct
type: function
doc:
<comment>Description:</comment>
  Crea un nuevo objeto DOMComment
    
  
  Crea un nuevo objeto <class>DOMComment</class> . Este objeto es de solo lectura.  Puede ser anexado a un
  documento, pero nodos adicionales no pueden ser anexados a este nodo hasta tando no haya sido
  asociado con un documento.  Para crear un nodo modificable utilice .

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  El valor del comentario.

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


id: DOMDocument
type: class
doc:
<comment>Description:</comment>
  Representa un documento HTML o XML en su totalidad; sirve como raíz del árbol de documento.


id: DOMDocument::__construct
type: function
doc:
<comment>Description:</comment>
  Crea un nuevo objeto DOMDocument
    
  
  Crea un nuevo objeto <class>DOMDocument</class> .

<comment>Param:</comment>
  <info>string</info>  <strong>$version</strong>   El numero de versión del documento como parte de la declaración XML.
  <info>string</info>  <strong>$encoding</strong>  La codificación del documento como parte de la declaración XML.

<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>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * DOMParentNode::append
   * DOMDocument::prepend


id: DOMDocument::createAttribute
type: function
doc:
<comment>Description:</comment>
  Crear nuevo attribute
  
  Esta función crea una nueva instancia de la clase <class>DOMAttr</class>.  Este nodo no se mostrará en el
  documento a no ser que
  sea insertado con (p.e.j.) <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El nombre del atributo.

<comment>Return:</comment>
  <info>DOMAttr</info>  El nuevo <class>DOMAttr</class> o <info>false</info> si ha ocurrido un error.

<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>
  Crea un nuevo nodo atributo con un namespace asociado.
    
  
  Esta función crea una nueva instancia de la clase <class>DOMAttr</class>. Este nodo no se mostrará en el
  documento a no ser que
  sea insertado con (p.e.j.) <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespaceURI</strong>   El URI del namespace.
  <info>string</info>  <strong>$qualifiedName</strong>  El nombre de etiqueta y prefijo del atributo, como <return>prefix:tagname</return>.

<comment>Return:</comment>
  <info>DOMAttr</info>  El nuevo <class>DOMAttr</class> o <info>false</info> si ha ocurrido un error.

<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>
  Crea un nuevo nodo cdata
  
  Esta función crea una nueva instancia de la clase <class>DOMCDATASection</class>. Este nodo no se mostrará en el
  documento a no ser que
  sea insertado con (p.e.j.) <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  El contenido del cdata.

<comment>Return:</comment>
  <info>DOMCDATASection</info>  El nuevo <class>DOMCDATASection</class> o <info>false</info> si ha ocurrido un error.

<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>
  Crea un nuevo nodo de comentario
  
  Esta función crea una nueva instancia de la clase <class>DOMComment</class>. Este nodo no se mostrará en el
  documento a no ser que
  sea insertado con (p.e.j.) <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  El contenido del comentario.

<comment>Return:</comment>
  <info>DOMComment</info>  El nuevo <class>DOMComment</class> o <info>false</info> si ha ocurrido un error.

<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>
  Crea un nuevo fragmento de documento
  
  Esta función crea una nueva instancia de la clase  <class>DOMDocumentFragment</class>. Este nodo no se mostrará
  en el documento a no ser que
  sea insertado con (p.e.j.) <strong>DOMNode::appendChild()</strong>.

<comment>Return:</comment>
  <info>DOMDocumentFragment</info>  El nuevo <class>DOMDocumentFragment</class> o <info>false</info> si ha ocurrido un error.

<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>
  Crea un nuevo nodo elemento
  
  Esta función crea una nueva instancia de la clase  <class>DOMElement</class>. Este nodo no se mostrará en el
  documento a no ser que
  sea insertado con (p.e.j.) <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   El nombre de etiqueta del elemento.
  <info>string</info>  <strong>$value</strong>  El valor del elemento. De manera predeterminada se creará un elemento vacio. El
                  valor también puede ser asignado más tarde con DOMElement::$nodeValue.
                  
                  El valor es usado al pie de la letra, excepto que las referencias de entidad
                  \< y &gt; se escaparán. Tenga en cuenta que & tiene que ser escapado manualmente;  de lo contrario, se tomará como inicio de una referencia de entidad. Además " no sera escapado.

<comment>Return:</comment>
  <info>DOMElement</info>  Devuelve una nueva instanca de la clase <class>DOMElement</class> o <info>false</info> si ha ocurrido un error.

<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>
  Crea un nuevo nodo elemento con el nombre de espacio asociado
    
  
  Esta función crea un nuevo nodo elemento con el nombre de espacio asociado. Este nodo no se
  mostrará en el documento a no ser que
  sea insertado con (p.e.j.) <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespaceURI</strong>   El URI del nombre de espacio.
  <info>string</info>  <strong>$qualifiedName</strong>  Elo nombre cualificado del elemento, como <return>prefix:tagname</return>.
  <info>string</info>  <strong>$value</strong>          El valor del elemento. De manera predeterminada se creará un elemento
                          vacio. El valor también puede ser asignado más tarde con
                          DOMElement::$nodeValue.

<comment>Return:</comment>
  <info>DOMElement</info>  El nuevo <class>DOMElement</class> o <info>false</info> si ha ocurrido un error.

<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
  
  Esta función crea una nueva instancia de la clase <class>DOMEntityReference</class>. Este nodo no se mostrará en
  el documento a no ser que
  sea insertado con (p.e.j.) <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El contenido de la entidad referencia, p.ej. la entidad referencia menos los
                 carácteres <return>&</return>  inicial y el <return>;</return> final.

<comment>Return:</comment>
  <info>DOMEntityReference</info>  El nuevo <class>DOMEntityReference</class> o <info>false</info> si ha ocurrido un error.

<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>
  Crea un nuevo nodo PI
  
  Esta función crea una nueva instancia de la clase <class>DOMProcessingInstruction</class>. Este nodo no se
  mostrará en el documento a no ser que
  sea insertado con (p.e.j.) <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$target</strong>  El objetivo de la instrucción de procesamiento.
  <info>string</info>  <strong>$data</strong>    El contenido de la instrucción de procesamiento.

<comment>Return:</comment>
  <info>DOMProcessingInstruction</info>  El nuevo <class>DOMProcessingInstruction</class> o <info>false</info> si ha ocurrido un error.

<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>
  Crea un nuevo nodo de texto
  
  Esta función crea una nueva instancia de la clase <class>DOMText</class>. Este nodo no se mostrará en el
  documento a no ser que
  sea insertado con (p.e.j.) <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$content</strong>  El contenido del texto.

<comment>Return:</comment>
  <info>DOMText</info>  El nuevo <class>DOMText</class> o <info>false</info> si ha ocurrido un error.

<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>
  Busca un elemento con cierto id
  
  Esta función es similar a pero  busca un elemento con el id dado.
  
  Para que esta función trabaje, necesitará asignar algunos atributos ID con  o un DTD que defina un
  atributo de tipo ID.  En el último caso necesitará validar el documento con   o
  DOMDocument::$validateOnParse antes de utilizar esta función.

<comment>Param:</comment>
  <info>string</info>  <strong>$elementId</strong>  El valor de id único para un elemento.

<comment>Return:</comment>
  <info>DOMElement</info>  Devuelve el <class>DOMElement</class> o <info>null</info> si el elemento no ha sido encontrado.

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


id: DOMDocument::getElementsByTagName
type: function
doc:
<comment>Description:</comment>
  Busca todos los elementos con el nombre de etiqueta local dado
  
  Esta función devuelve una nueva instancia de la clase <class>DOMNodeList</class> que contiene los elementos con
  el nombre de  etiqueta local buscado.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El nombre local (sin namespace) de la etiqueta con el cual se hará comparación. El
                 valor especial <return>*</return> coincindirá con todas las etiquetas.

<comment>Return:</comment>
  <info>DOMNodeList</info>  Un nuevo objeto <class>DOMNodeList</class> que contiene todos los elementos coincidentes.

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


id: DOMDocument::getElementsByTagNameNS
type: function
doc:
<comment>Description:</comment>
  Busca todos los elementos con el nombre de etiqueta dado en el espacio de nombre especificado.
    
  
  Devuelve un <class>DOMNodeList</class> de todos los elementos con el nombre local dado y el URI del espacio de
  nombre.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespaceURI</strong>  El URI del espacio de nombre de los elementos en los que se buscara.  El
                         valor especial <return>*</return> coincide con todos los espacios de nombre.
  <info>string</info>  <strong>$localName</strong>     El nombre local de los elementos buscados.  El valor especial <return>*</return> coincide
                         con todos los nombres locales.

<comment>Return:</comment>
  <info>DOMNodeList</info>  Un nuevo objeto <class>DOMNodeList</class> que contiene todos los elementos coincidentes.

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


id: DOMDocument::importNode
type: function
doc:
<comment>Description:</comment>
  Importa un nodo dentro del documento actual
  
  Esta función devuelve una copia del nodo a importar y le asocia con el documento actual.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$importedNode</strong>  El nodo que desea importar
  <info>bool</info>     <strong>$deep</strong>          Si se establece en <info>true</info>, este método importará  de forma recursiva el
                          subárbol  bajo el <strong>$importedNode</strong>.
                          
                          Para copiar los atributos de los nodos  <strong>$deep</strong> debe establecerse a <info>true</info>

<comment>Return:</comment>
  <info>DOMNode</info>  El nodo copiado o <info>false</info>, si no puede ser copiado.


id: DOMDocument::load
type: function
doc:
<comment>Description:</comment>
  Cargar un documento XML de un archivo.
    
  
  Carga un documento XML de un archivo.
  
  Rutas tipo Unix con barras inclinadas hacia a delante, pueden causar  una degradacion
  significativa de rendimiento en sistemas Windows,  si es el caso, asegúrese de llamar <strong>realpath()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  La ruta al documento XML.
  <info>int</info>     <strong>$options</strong>   Bitwise <return>OR</return> de las constantes de opción .

<comment>Return:</comment>
  <info>mixed</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.  Si se llama estáticamente,
         devuelve un  <class>DOMDocument</class> o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * DOMDocument::loadXML
   * DOMDocument::save
   * DOMDocument::saveXML


id: DOMDocument::loadHTML
type: function
doc:
<comment>Description:</comment>
  Cargar HTML de una cadena
    
  
  Esta función procesa el HTML contenido en la cadena <strong>$source</strong>. De manera distinta a cargar XML, HTML
  no tiene que estar bien formado para cargarse.   Esta función también puede llamarse estáticamente
  para cargar y crear un  objeto <class>DOMDocument</class>. La invocación estática puede utilizarse  aún cuando
  ninguna propiedad de <class>DOMDocument</class> haya sido establecida antes de la lectura.

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>   La cadena HTML.
  <info>int</info>     <strong>$options</strong>  Desde PHP 5.4.0 y Libxml 2.6.0, se puede usar el parámetro <strong>$options</strong> para
                    especificar parámetros de Libxml adicionales.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Si es llamada de manera estática
        devuelve un objeto <class>DOMDocument</class> o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * DOMDocument::loadHTMLFile
   * DOMDocument::saveHTML
   * DOMDocument::saveHTMLFile


id: DOMDocument::loadHTMLFile
type: function
doc:
<comment>Description:</comment>
  Cargar HTML desde un fichero
    
  
  Esta función analiza el documento HTML del fichero llamado <strong>$filename</strong>. A diferencia de cargar XML,
  HTML no tiene que estar bien formado para cargarse.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  La ruta al fichero HTML.
  <info>int</info>     <strong>$options</strong>   Desde PHP 5.4.0 y Libxml 2.6.0, se puede usar el parámetro <strong>$options</strong> para
                     especificar parámetros de Libxml adicionales.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Si se llama estáticamente, devuelve
        un <class>DOMDocument</class> o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * DOMDocument::loadHTML
   * DOMDocument::saveHTML
   * DOMDocument::saveHTMLFile


id: DOMDocument::loadXML
type: function
doc:
<comment>Description:</comment>
  Cargar XML desde una cadena
    
  
  Carga un documento XML desde una cadena.

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>   La cadena que contiene el XML.
  <info>int</info>     <strong>$options</strong>  Operador a nivel de bits <return>OR</return> de las constantes de opciones libxml.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Si se llama estáticamente,
         devuelve un <class>DOMDocument</class> o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * DOMDocument::load
   * DOMDocument::save
   * DOMDocument::saveXML


id: DOMDocument::normalizeDocument
type: function
doc:
<comment>Description:</comment>
  Normaliza el documento
  
  Este método actúa como si guardara y después cargara el documento, poniendo el el documento en una
  forma "normal".

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * La Especificación DOM
   * 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>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * DOMParentNode::prepend
   * DOMDocument::append


id: DOMDocument::registerNodeClass
type: function
doc:
<comment>Description:</comment>
  Registra una clase extendida usada para crear tipos de nodos base
  
  Este método permite registrar su propia clase DOM extendida para usarla después por la extensión
  DOM de PHP.
  
  Este método no es parte del estándar DOM.

<comment>Param:</comment>
  <info>string</info>  <strong>$baseclass</strong>      La clase DOM que se quiere extender. Se puede encontrar una lista de estas
                          clases en el capítulo introducción.
  <info>string</info>  <strong>$extendedclass</strong>  El nombre de la clase extendida. Si se proporciona <info>null</info>, cualquier clase
                          registrada previamente que extienda <strong>$baseclass</strong> será eliminada.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: DOMDocument::relaxNGValidate
type: function
doc:
<comment>Description:</comment>
  Realiza una validación relaxNG del documento
    
  
  Realiza una validación relaxNG del documento basándose en el esquema RNG dado.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  El fichero RNG.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * DOMDocument::relaxNGValidateSource
   * DOMDocument::schemaValidate
   * DOMDocument::schemaValidateSource
   * DOMDocument::validate


id: DOMDocument::relaxNGValidateSource
type: function
doc:
<comment>Description:</comment>
  Realiza una validación relaxNG del documento
    
  
  Realiza una validación relaxNG del documento basándose en la fuente RNG dada.

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>  Una cadena que contiene el esquema RNG.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<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>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * DOMParentNode::replaceChildren
   * DOMDocument::append
   * DOMDocument::prepend


id: DOMDocument::save
type: function
doc:
<comment>Description:</comment>
  Copia el árbol XML interno a un archivo
    
  
  Crea un documento XML desde la representación DOM. Esta función normalmente se llama después de
  construir un nuevo documento desde ceros, como en el ejemplo de abajo.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  La ruta al documento XML guardado.
  <info>int</info>     <strong>$options</strong>   Opciones Adicionales. Actualmente sólo está soportada LIBXML_NOEMPTYTAG.

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de bytes escritos o <info>false</info> si ocurrió un error.

<comment>See Also:</comment>
   * DOMDocument::saveXML
   * DOMDocument::load
   * DOMDocument::loadXML


id: DOMDocument::saveHTML
type: function
doc:
<comment>Description:</comment>
  Copia el documento interno a una cadena usando el formato HTML
    
  
  Crea un documento HTML desde la representación DOM. Esta función normalmente se llama después de
  construir un nuevo documento desde cero, como en el ejemplo de abajo.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>  Parámetro opcional que devuelve una parte del documento.

<comment>Return:</comment>
  <info>string</info>  Devuelve el HTML, o <info>false</info> si ocurrió un error.

<comment>See Also:</comment>
   * DOMDocument::saveHTMLFile
   * DOMDocument::loadHTML
   * DOMDocument::loadHTMLFile


id: DOMDocument::saveHTMLFile
type: function
doc:
<comment>Description:</comment>
  Copia el documento interno a un fichero usando el formato HTML
    
  
  Crea un documento HTML desde la representación DOM. Esta función normalmente se llama después de
  construir un nuevo documento desde cero, como en el ejemplo de abajo.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  La ruta al documento HTML guardado.

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de bytes escritos o <info>false</info> si ocurrió un error.

<comment>See Also:</comment>
   * DOMDocument::saveHTML
   * DOMDocument::loadHTML
   * DOMDocument::loadHTMLFile


id: DOMDocument::saveXML
type: function
doc:
<comment>Description:</comment>
  Copia el arbol XML interno a un string
    
  
  Crea un documento XML desde la representación DOM. Esta función normalmente se llama después de
  construir un nuevo documento desde cero, como en el ejemplo de abajo.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>     Use este parámetro para imprimir sólo un nodo especifico sin la declaración XML
                     en vez del documento completo.
  <info>int</info>      <strong>$options</strong>  Opciones Adicionales. Actualmente sólo está soportada LIBXML_NOEMPTYTAG.

<comment>Return:</comment>
  <info>string</info>  Devuelve el XML, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * DOMDocument::save
   * DOMDocument::load
   * DOMDocument::loadXML


id: DOMDocument::schemaValidate
type: function
doc:
<comment>Description:</comment>
  Valida un documento basado en un esquema
    
  
  Valida un documento basado en el fichero de esquema dado.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  La ruta al esquema.
  <info>int</info>     <strong>$flags</strong>     Una máscara de bits de banderas de validación de esquemas de Libxml.
                     Actualmente el único valor admitido es LIBXML_SCHEMA_CREATE. Disponible desde
                     PHP 5.5.2 y Libxml 2.6.14.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * DOMDocument::schemaValidateSource
   * DOMDocument::relaxNGValidate
   * DOMDocument::relaxNGValidateSource
   * DOMDocument::validate


id: DOMDocument::schemaValidateSource
type: function
doc:
<comment>Description:</comment>
  Valida un documento basado en un esquema
    
  
  Valida un documento basado en un esquema definido en la cadena dada.

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>  Una cadena que contiene el esquema.
  <info>int</info>     <strong>$flags</strong>   Una máscara de bits de banderas de validación de esquemas de Libxml. Actualmente
                   el único valor admitido es LIBXML_SCHEMA_CREATE. Disponible desde PHP 5.5.2 y
                   Libxml 2.6.14.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * DOMDocument::schemaValidate
   * DOMDocument::relaxNGValidate
   * DOMDocument::relaxNGValidateSource
   * DOMDocument::validate


id: DOMDocument::validate
type: function
doc:
<comment>Description:</comment>
  Valida el documento basado en su DTD
    
  
  Valida el documento basado en su DTD.
  
  También se puede usar la propiedad <return>validateOnParse</return> de <class>DOMDocument</class> para realizar la validación de
  DTD.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Si el documento no tiene el DTD
        adjunto, este método devolverá <info>false</info>.

<comment>See Also:</comment>
   * DOMDocument::schemaValidate
   * DOMDocument::schemaValidateSource
   * DOMDocument::relaxNGValidate
   * DOMDocument::relaxNGValidateSource


id: DOMDocument::xinclude
type: function
doc:
<comment>Description:</comment>
  Sustituye XIncludes en un objeto DOMDocument
    
  
  Este método sustituye XIncludes en un objeto DOMDocument.
  
  Debido a que libxml2 resuelve automáticamente entidades, este método producirá resultados
  inesperados si el fichero XML incluido tiene un DTD adjunto.

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  Parámetros de libxml. Disponible desde PHP 5.1.0 y Libxml 2.6.7.

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de XIncludes del documento, -1 si falló algún proceso, o <info>false</info> si no hubo
       sustituciones.


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>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * DOMParentNode::append
   * DOMDocumentFragment::prepend


id: DOMDocumentFragment::appendXML
type: function
doc:
<comment>Description:</comment>
  Añade información XML sin formato
  
  Añade información XML sin formato a un DOMDocumentFragment.
  
  Este método no es parte del estándar DOM. Fue creado como enfoque más sencillo para añadir un
  DocumentFragment de XML a un DOMDocument.
  
  Si quiere mantener los estándares, tendrá que crear un DOMDocument temporal con una raíz
  cualquiera y después ir a través de los nodos hijo de la raíz de su información XML para
  añadirlos.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  XML a añadir.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


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>Return:</comment>
  <info>void</info>  

<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>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * DOMParentNode::replaceChildren
   * DOMDocumentFragment::append
   * DOMDocumentFragment::prepend


id: DOMDocumentType
type: class
doc:
<comment>Description:</comment>
  Cada <class>DOMDocument</class> tiene un atributo <return>doctype</return> cuyo valor es <info>null</info> o un objeto <class>DOMDocumentType</class>.


id: DOMElement::__construct
type: function
doc:
<comment>Description:</comment>
  Crea un nuevo objeto DOMElement
    
  
  Crea un nuevo objeto <class>DOMElement</class>. Este objeto es de sólo lectura. Puede ser añadido a un documento,
  pero no se pueden añadir nodos adicionales a este nodo hasta que el nodo esté asociado con un
  documento. Para crear un nodo modificable, use  o .

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>          El nombre de la etiqueta del elemento. Cuando también se pasa en
                         namespaceURI, el nombre del elemento puede tomar un prefijo para asociarlo
                         con la URI.
  <info>string</info>  <strong>$value</strong>         El valor del elemento.
  <info>string</info>  <strong>$namespaceURI</strong>  Una URI del espacio de nombres para crear el elemento dentro de un espacio
                         de nombres especificado.

<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>Return:</comment>
  <info>void</info>  

<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>Return:</comment>
  <info>void</info>  

<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>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * DOMChildNode::before
   * DOMElement::after


id: DOMElement::getAttribute
type: function
doc:
<comment>Description:</comment>
  Devuelve el valor de un atributo
  
  Obtiene el valor del atributo de nombre <strong>$name</strong>  para el nodo actual.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El nombre del atributo.

<comment>Return:</comment>
  <info>string</info>  El valor del atributo, o una cadena vacía si no se encuentra un atributo con el nombre
          dado por <strong>$name</strong>.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::setAttribute
   * DOMElement::removeAttribute


id: DOMElement::getAttributeNS
type: function
doc:
<comment>Description:</comment>
  Devuelve el valor de un atributo
  
  Obtiene el valor del atributo en el espacio de nombres <strong>$namespaceURI</strong>  con el nombre local
  <strong>$localName</strong> para el nodo actual.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespaceURI</strong>  La URI del espacio de nombres.
  <info>string</info>  <strong>$localName</strong>     El nombre local.

<comment>Return:</comment>
  <info>string</info>  El valor del atributo, o una cadena vacía si no se ecuentra el atributo con los <strong>$localName</strong>
          y <strong>$namespaceURI</strong>  dados.

<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>
  Devuelve el nodo de un atributo
  
  Devuelve el nodo del atributo con nombre  <strong>$name</strong> para el elemento actual.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El nombre del atributo.

<comment>Return:</comment>
  <info>DOMAttr</info>  El nodo de atributos. Observe que para los atributos de las declaraciones  del espacio de
           nombres XML (<return>xmlns</return> y <return>xmlns:*</return>) una  instancia de <class>DOMNameSpaceNode</class> es devuelta en vez de
           una instancia de  <class>DOMAttr</class>.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::setAttributeNode
   * DOMElement::removeAttributeNode


id: DOMElement::getAttributeNodeNS
type: function
doc:
<comment>Description:</comment>
  Devuelve el nodo de un atributo
    
  
  Devuelve el nodo del atributo en el espacio de nombres  <strong>$namespaceURI</strong>  con el nombre local
  <strong>$localName</strong> para el nodo actual.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespaceURI</strong>  La URI del espacio de nombres.
  <info>string</info>  <strong>$localName</strong>     El nombre local.

<comment>Return:</comment>
  <info>DOMAttr</info>  El nodo de atributos. Observe que para los atributos de las declaraciones  del espacio de
           nombres XML (<return>xmlns</return> y <return>xmlns:*</return>) una  instancia de <class>DOMNameSpaceNode</class> es devuelta en vez de
           una instancia de  <class>DOMAttr</class>.

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::setAttributeNodeNS
   * DOMElement::removeAttributeNode


id: DOMElement::getElementsByTagName
type: function
doc:
<comment>Description:</comment>
  Obtiene los elementos por nombre de etiqueta
  
  Esta función devuelve una nueva instancia de la clase <class>DOMNodeList</class> con todos los elementos
  descendientes con un nombre de etiqueta dado por <strong>$name</strong>, en el orden en que fueron encontrados en
  un recorrido preorden de este elemento árbol.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El nombre de la etiqueta. Use <return>*</return> para devolver todos los elementos dentro del
                 elemento árbol.

<comment>Return:</comment>
  <info>DOMNodeList</info>  Esta función devuelve una nueva instancia de la clase <class>DOMNodeList</class> con todos los
               elementos coincidentes.

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


id: DOMElement::getElementsByTagNameNS
type: function
doc:
<comment>Description:</comment>
  Obtener los elementos por la URI del espacio de nombres y el nombre local
  
  Esta función trae todos los elementos descendientes con unos <strong>$localName</strong> y <strong>$namespaceURI</strong> dados.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespaceURI</strong>  La URI del espacio de nombres.
  <info>string</info>  <strong>$localName</strong>     EL nombre local. Use <return>*</return> para devolver todos los elementos dentro del
                         elemento árbol.

<comment>Return:</comment>
  <info>DOMNodeList</info>  Esta función devuelve una nueva instancia de la clase <class>DOMNodeList</class> con todos los
               elementos coincidentes en el orden en que fueron encontrados en un recorriendo en
               preorden este elemento árbol.

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


id: DOMElement::hasAttribute
type: function
doc:
<comment>Description:</comment>
  Comprueba si existe un atributo
  
  Indica si un atributo llamado <strong>$name</strong>  existe como miembro del elemento.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El nombre del atributo.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttribute
   * DOMElement::setAttribute
   * DOMElement::removeAttribute


id: DOMElement::hasAttributeNS
type: function
doc:
<comment>Description:</comment>
  Comprueba si un atributo existe
    
  
  Indica si un atributo en el espacio de nombres <strong>$namespaceURI</strong>  llamado <strong>$localName</strong> existe como
  miembro del elemento.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespaceURI</strong>  La URI del espacio de nombres.
  <info>string</info>  <strong>$localName</strong>     El nombre local.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<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>  No devuelve ningún valor.

<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>Return:</comment>
  <info>void</info>  

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

<comment>See Also:</comment>
   * DOMElement::after
   * DOMElement::before
   * DOMElement::replaceWith
   * DOMNode::removeChild


id: DOMElement::removeAttribute
type: function
doc:
<comment>Description:</comment>
  Elimina un atributo
  
  Elimina el atributo llamado <strong>$name</strong> del elemento.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El nombre del atributo.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttribute
   * DOMElement::setAttribute


id: DOMElement::removeAttributeNS
type: function
doc:
<comment>Description:</comment>
  Elimina un atributo
  
  Elimina el atributo <strong>$localName</strong> en el espacio de nombre <strong>$namespaceURI</strong> de el elemento.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespaceURI</strong>  La URI del espacio de nombres.
  <info>string</info>  <strong>$localName</strong>     El nombre local.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttributeNS
   * DOMElement::setAttributeNS


id: DOMElement::removeAttributeNode
type: function
doc:
<comment>Description:</comment>
  Elimina un atributo
  
  Elimina el atributo <strong>$oldnode</strong> del elemento.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$oldnode</strong>  El nodo atributo.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<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>Return:</comment>
  <info>void</info>  

<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>Return:</comment>
  <info>void</info>  

<comment>See Also:</comment>
   * DOMChildNode::replaceWith
   * DOMElement::replaceChildren
   * DOMElement::after
   * DOMElement::before
   * DOMElement::remove


id: DOMElement::setAttribute
type: function
doc:
<comment>Description:</comment>
  Añade un nuevo atributo
  
  Establece un atributo con nombre <strong>$name</strong> al valor dado. Si el atributo no existe, se creará.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   El nombre del atributo.
  <info>string</info>  <strong>$value</strong>  El valor del atributo.

<comment>Return:</comment>
  <info>DOMAttr</info>  El nuevo objeto <class>DOMAttr</class> o <info>false</info> si ocurrió un error.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttribute
   * DOMElement::removeAttribute


id: DOMElement::setAttributeNS
type: function
doc:
<comment>Description:</comment>
  Añade un nuevo atributo
  
  Establece un atributo con el espacio de nombres <strong>$namespaceURI</strong> y el nombre <strong>$name</strong> al valor dado. Si
  el atributo no existe, se creará.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespaceURI</strong>   La URI del espacio de nombres.
  <info>string</info>  <strong>$qualifiedName</strong>  El nombre cualificado del atributo, como <return>prefijo:nombre_etiqueta</return>.
  <info>string</info>  <strong>$value</strong>          El valor del atributo.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttributeNS
   * DOMElement::removeAttributeNS


id: DOMElement::setAttributeNode
type: function
doc:
<comment>Description:</comment>
  Añade un nuevo nodo de atributo al elemento
  
  Añade el nuevo nodo de atributo dado por <strong>$attr</strong> al elemento.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  El nodo de atributo.

<comment>Return:</comment>
  <info>DOMAttr</info>  Devuelve el nodo antiguo si el atributo ha sido reemplazado o <info>null</info>.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttributeNode
   * DOMElement::removeAttributeNode


id: DOMElement::setAttributeNodeNS
type: function
doc:
<comment>Description:</comment>
  Aña de un nuevo nodo de atributo al elemento
  
  Añade el nuevo nodo atributo <strong>$attr</strong> al elemento.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  El nodo atributo.

<comment>Return:</comment>
  <info>DOMAttr</info>  Devuelve el antiguo nodo si el atributo ya sido reemplazado.

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttributeNodeNS
   * DOMElement::removeAttributeNode


id: DOMElement::setIdAttribute
type: function
doc:
<comment>Description:</comment>
  Declara el atributo especificado por su nombre como de tipo ID
  
  Declara el atributo <strong>$name</strong> como de tipo ID.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El nombre del atributo.
  <info>bool</info>    <strong>$isId</strong>  Establecer a <info>true</info> si se quiere que <strong>$name</strong> sea de tipo ID, <info>false</info> si no.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * DOMDocument::getElementById
   * DOMElement::setIdAttributeNode
   * DOMElement::setIdAttributeNS


id: DOMElement::setIdAttributeNS
type: function
doc:
<comment>Description:</comment>
  Declara el atributo especificado por su nombre local y su URI del espacio de nombres como de tipo
  ID
  
  Declara el atributo especificado por <strong>$localName</strong> y <strong>$namespaceURI</strong> como de tipo ID.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespaceURI</strong>  La URI del espacio de nombres del atributo.
  <info>string</info>  <strong>$localName</strong>     El nombre local del atributo, como <return>prefijo:nombre_etiqueta</return>.
  <info>bool</info>    <strong>$isId</strong>          Establecer a <info>true</info> si se quiere que <strong>$name</strong> sea de tipo ID, <info>false</info> si no.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * DOMDocument::getElementById
   * DOMElement::setIdAttribute
   * DOMElement::setIdAttributeNode


id: DOMElement::setIdAttributeNode
type: function
doc:
<comment>Description:</comment>
  Declara el atributo especificado por su nodo como de tipo ID
  
  Declara el atributo especificado por <strong>$attr</strong> como de tipo ID.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  El nodo atributo.
  <info>bool</info>     <strong>$isId</strong>  Establecer a <info>true</info> si se quiere que <strong>$name</strong> sea de tipo ID, <info>false</info> si no.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<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 interfaz representa una entidad conocida, analizada o sin analizar, de un documento XML.


id: DOMEntityReference::__construct
type: function
doc:
<comment>Description:</comment>
  Crea un nuevo objeto DOMEntityReference
    
  
  Crea un nuevo objeto <class>DOMEntityReference</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El nombre de la referencia de entidad.

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


id: DOMImplementation
type: class
doc:
<comment>Description:</comment>
  La interfaz <class>DOMImplementation</class> proporciona varios métodos para realizar operaciones que son
  independientes de cualquier instancia en particular del modelo de objetos del documento.


id: DOMImplementation::__construct
type: function
doc:
<comment>Description:</comment>
  Crea un nuevo objeto DOMImplementation
    
  
  Crea un nuevo objeto <class>DOMImplementation</class>.


id: DOMImplementation::createDocument
type: function
doc:
<comment>Description:</comment>
  Crea un objeto DOMDocument del tipo especificado con su elemento documento
    
  
  Crea un objeto <class>DOMDocument</class> del tipo especificado con su elemento documento.

<comment>Param:</comment>
  <info>string</info>           <strong>$namespaceURI</strong>   La URI del espacio de nombres del elemento documento a crear.
  <info>string</info>           <strong>$qualifiedName</strong>  El nombre cualificado del elemento documento a crear.
  <info>DOMDocumentType</info>  <strong>$doctype</strong>        El tipo de documento a crear o <info>null</info>.

<comment>Return:</comment>
  <info>DOMDocument</info>  Un nuevo objeto <class>DOMDocument</class>. Si <strong>$namespaceURI</strong>, <strong>$qualifiedName</strong>,  y <strong>$doctype</strong> son null,
               el <class>DOMDocument</class> devuelto está vacío sin elemento documento

<comment>See Also:</comment>
   * DOMDocument::__construct
   * DOMImplementation::createDocumentType


id: DOMImplementation::createDocumentType
type: function
doc:
<comment>Description:</comment>
  Crear un objeto DOMDocumentType vacío
    
  
  Crea un objeto <class>DOMDocumentType</class> vacío. Las declaraciones de entidades y las notaciones no están
  disponibles. Las expansiones de referencias de entidades y la adición de atributos por defecto no
  ocurren.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  El nombre cualificado del tipo de documente a crear.
  <info>string</info>  <strong>$publicId</strong>       El identificador público del subconjunto externo.
  <info>string</info>  <strong>$systemId</strong>       El identificador de sistema del subconjunto externo.

<comment>Return:</comment>
  <info>DOMDocumentType</info>  Un nuevo nodo <class>DOMDocumentType</class> con su <return>ownerDocument</return> establecido a <info>null</info>.

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


id: DOMImplementation::hasFeature
type: function
doc:
<comment>Description:</comment>
  Comprueba si la implementación de DOM implementa una característica específica
    
  
  Comprueba si la implementación de DOM implementa una característica específica dada por <strong>$feature</strong>.
  
  Se puede encontrar una lista de todas las características en la sección Conformance de la
  especificación DOM.

<comment>Param:</comment>
  <info>string</info>  <strong>$feature</strong>  La característica a comprobar.
  <info>string</info>  <strong>$version</strong>  El número de versión de <strong>$feature</strong> a comprobar. En el nivel 2 puede ser <return>2.0</return> o <return>1.0</return>.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<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>  Una instancia de un objeto que implementa <class>Iterator</class> o <class>Traversable</class>

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


id: DOMNamedNodeMap::getNamedItem
type: function
doc:
<comment>Description:</comment>
  Recupera un nodo especificado por su nombre
    
  
  Recupera un nodo especificado por su <return>nodeName</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El <return>nodeName</return> del nodo a recuperar.

<comment>Return:</comment>
  <info>DOMNode</info>  Un nodo (de cualquier tipo) con el <return>nodeName</return> especificado, o <info>null</info> si no se encuentra
           ningún nodo.

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


id: DOMNamedNodeMap::getNamedItemNS
type: function
doc:
<comment>Description:</comment>
  Recupera un nodo especificado por el nombre local y la URI del espacio de nombres
    
  
  Recupera un nodo especificado por <strong>$localName</strong> y <strong>$namespaceURI</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespaceURI</strong>  La URI del espacio de nombres del nodo a recuperar.
  <info>string</info>  <strong>$localName</strong>     El nombre local del nodo a recuperar.

<comment>Return:</comment>
  <info>DOMNode</info>  Un nodo (de cualquier tipo) con el nombre local y la URI del espacio de nombres
           especificados, o <info>null</info> si no se encuentra ningún nodo.

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


id: DOMNamedNodeMap::item
type: function
doc:
<comment>Description:</comment>
  Recupera un nodo especificado por su índice
  
  Recupera un nodo especificado por <strong>$index</strong> dentro del objeto <class>DOMNamedNodeMap</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Índice dentro de este mapa.

<comment>Return:</comment>
  <info>DOMNode</info>  El nodo en la posición marcada por <strong>$index</strong> en el mapa, o <info>null</info> si no es un índice válido
           (mayor o igual que el número de nodos de este mapa).


id: DOMNode::C14N
type: function
doc:
<comment>Description:</comment>
  Canonizar nodos a una cadena
  
  Canoniza nodos a una cadena

<comment>Param:</comment>
  <info>bool</info>   <strong>$exclusive</strong>      Habilita el análisis exclusivo de los nodos que coincidan únicamente con el
                         xpath o los prefijos de nombres de espacio proporcionados.
  <info>bool</info>   <strong>$with_comments</strong>  Conservar los comentarios en la salida.
  <info>array</info>  <strong>$xpath</strong>          Un array de <return>xpath</return>s por los que filtrar los nodos.
  <info>array</info>  <strong>$ns_prefixes</strong>    Un array de prefijos de nombres de espacio por los que filtrar los nodos.

<comment>Return:</comment>
  <info>string</info>  Devuelve los nodos canonizados como cadenas  o <info>false</info> en caso de error

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


id: DOMNode::C14NFile
type: function
doc:
<comment>Description:</comment>
  Canonizar nodos a un fichero
  
  Canoniza nodos a un fichero

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>            La ruta en la que escribir la salida.
  <info>bool</info>    <strong>$exclusive</strong>      Habilita el análisis exclusivo de los nodos que coincidan únicamente con
                          el xpath o los prefijos de nombres de espacio proporcionados.
  <info>bool</info>    <strong>$with_comments</strong>  Conservar los comentarios en la salida.
  <info>array</info>   <strong>$xpath</strong>          Un array de <return>xpath</return>s por los que filtrar los nodos.
  <info>array</info>   <strong>$ns_prefixes</strong>    Un array de prefijos de nombres de espacio por los que filtrar los nodos.

<comment>Return:</comment>
  <info>int</info>  El número de bytes escritos  o <info>false</info> en caso de error

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


id: DOMNode::appendChild
type: function
doc:
<comment>Description:</comment>
  Añade un nuevo hijo al final de los hijos
    
  
  Esta función agrega un hijo a una lista existente de hijos o crea una nueva lista de hijos.  El
  hijo se puede crear con, p.ej., DOMDocument::createElement, DOMDocument::createTextNode etc. o
  simplemente usando cualquier otro nodo.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$newnode</strong>  El hijo añadido.

<comment>Return:</comment>
  <info>DOMNode</info>  El nodo añadido.

<comment>See Also:</comment>
   * DOMNode::insertBefore
   * DOMNode::removeChild
   * DOMNode::replaceChild


id: DOMNode::cloneNode
type: function
doc:
<comment>Description:</comment>
  Clona un nodo
    
  
  Crea una copia del nodo.

<comment>Param:</comment>
  <info>bool</info>  <strong>$deep</strong>  Indica si copiar todos los nodos descendientes. Este parámetro es <info>false</info> de manera
               predeterminada.

<comment>Return:</comment>
  <info>DOMNode</info>  El nodo clonado.


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>
  Obtener el número de línea de un nodo
  
  Obtiene el número de línea donde está definido el nodo.

<comment>Return:</comment>
  <info>int</info>  Siempre devuelve el número de línea donde está definido el nodo.


id: DOMNode::getNodePath
type: function
doc:
<comment>Description:</comment>
  Obtener un XPath de un nodo
  
  Obtiene una ruta de ubicación XPath del nodo.

<comment>Return:</comment>
  <info>string</info>  Devuelve un <info>string</info> que contiene el XPath, o <info>null</info> en caso de 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>
  Comprueba si un nodo tiene atributos
    
  
  Este método comprueba si el nodo tiene atributos. El nodo comprobado tiene que ser un
  <info>XML_ELEMENT_NODE</info>.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


id: DOMNode::hasChildNodes
type: function
doc:
<comment>Description:</comment>
  Comprueba si el nodo tiene hijos
    
  
  Esta función comprueba si el nodo tiene hijos.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


id: DOMNode::insertBefore
type: function
doc:
<comment>Description:</comment>
  Añade un nuevo hijo antes del nodo de referencia
    
  
  Esta función inserta un nuevo nodo justo antes que el nodo de referencia. Si planea hacer
  modificaciones posteriores al hijo añadido debe usar el nodo devuelto.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$newnode</strong>  El nuevo nodo.
  <info>DOMNode</info>  <strong>$refnode</strong>  El nodo de referencia. Si no se proporciona, <strong>$newnode</strong> es añadido al hijo.

<comment>Return:</comment>
  <info>DOMNode</info>  El nodo insertado.

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


id: DOMNode::isDefaultNamespace
type: function
doc:
<comment>Description:</comment>
  Comprueba si la URI del espacio de nombres especificada es el espacio de nombres predeterminado
  
  Indica si <strong>$namespaceURI</strong> es el espacio de nombres especificado.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespaceURI</strong>  La URI del espacio de nombres a buscar.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si <strong>$namespaceURI</strong> es el espacio de nombres predeterminado, <info>false</info> si no.


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>
  Indica si dos nodos son el mismo nodo
    
  
  Esta función indica si dos nodos son el mismo nodo. La comparación no está basada en el contenido

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>  El nodo comparado.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: DOMNode::isSupported
type: function
doc:
<comment>Description:</comment>
  Comprueba si una característica está soportada para la versión especificada
    
  
  Comprueba si la característica solicitada dada por <strong>$feature</strong> está soportada para la versión
  especificada dada por <strong>$version</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$feature</strong>  La característica a comprobar. Véase el ejemplo de DOMImplementation::hasFeature
                    para una lista de características.
  <info>string</info>  <strong>$version</strong>  El número de versión de <strong>$feature</strong> a comprobar.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


id: DOMNode::lookupNamespaceUri
type: function
doc:
<comment>Description:</comment>
  Obtiene la URI del espacio de nombres del nodo basado en el prefijo
    
  
  Obtiene la URI del espacio de nombres del nodo basado en <strong>$prefix</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  El prefijo del espacio de nombres.

<comment>Return:</comment>
  <info>string</info>  La URI del espacio de nombres del nodo.

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


id: DOMNode::lookupPrefix
type: function
doc:
<comment>Description:</comment>
  Obtiene el prefijo del espacio de nombres del nodo basándoes en la URI del espacio de nombres
    
  
  Obtiene el prefijo del espacio de nombres del nodo basándoes en la URI del espacio de nombres.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespaceURI</strong>  La URI del espacio de nombres.

<comment>Return:</comment>
  <info>string</info>  El prefijo del espacio de nombres.

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


id: DOMNode::normalize
type: function
doc:
<comment>Description:</comment>
  Normaliza el nodo
    
  
  Elimina nodos de texto vacíos y une nodos de texto adyacentes en este nodo y todos sus hijos.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * La Especificación DOM
   * DOMDocument::normalizeDocument


id: DOMNode::removeChild
type: function
doc:
<comment>Description:</comment>
  Elimina un hijo de la lista de hijos.
    
  
  Esta función elimina un hijo de la lista de hijos.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$oldnode</strong>  El hijo eliminado.

<comment>Return:</comment>
  <info>DOMNode</info>  Si el hijo ha podido ser eliminado la función devuelve el hijo antiguo.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMNode::replaceChild


id: DOMNode::replaceChild
type: function
doc:
<comment>Description:</comment>
  Reemplaza un hijo
    
  
  Esta función reemplaza el hijo <strong>$oldnode</strong>  con es nuevo nodo <strong>$newnode</strong> proporcionado. Si el nuevo
  nodo ya es un hijo no será añadido una segunda vez. Si el reemplazo tiene éxito se devuelve el
  nodo antiguo.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$newnode</strong>  El nuevo nodo. Debe ser un miembro del documento objetivo, es decir, creado con
                     uno de los métodos DOMDocument-&gt;createXXX() o importado al documento por .
  <info>DOMNode</info>  <strong>$oldnode</strong>  El nodo antiguo.

<comment>Return:</comment>
  <info>DOMNode</info>  El nodo antiguo o <info>false</info> si ocurrió un error.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMNode::removeChild


id: DOMNodeList::count
type: function
doc:
<comment>Description:</comment>
  Obtiene el número de nodos en la lista
  
  Obtiene el número de nodos de la lista.

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de nodos de la lista, que es idéntica a la propiedad length.


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>  Una instancia de un objeto que implementa <class>Iterator</class> o <class>Traversable</class>

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


id: DOMNodeList::item
type: function
doc:
<comment>Description:</comment>
  Recupera un nodo especificado por un índice
    
  
  Recupera un nodo especificado por <strong>$index</strong> dentro del objeto <class>DOMNodeList</class>.
  
  Si necesita conocer el número de nodos de la colección, use la propiedad <return>length</return> del objeto
  <class>DOMNodeList</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Índice del nodo de la colección.

<comment>Return:</comment>
  <info>DOMNode</info>  El nodo en la posición marcada por <strong>$index</strong> del objeto <class>DOMNodeList</class>, o <info>null</info> si no es un
           índice válido.


id: DOMProcessingInstruction::__construct
type: function
doc:
<comment>Description:</comment>
  Crea un nuevo objeto DOMProcessingInstruction
    
  
  Crea un nuevo objeto <class>DOMProcessingInstruction</class>. Este objeto es de sólo lectura. Se puede añadir a
  un documento, pero no se pueden añadir nodos adicionales a este nodo hata que el nodo esté
  asociado con un documento. Para crear un nodo modificable, use  .

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   El nombre de la etiqueta de la instrucción en proceso.
  <info>string</info>  <strong>$value</strong>  El valor de la intrucción en proceso.

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


id: DOMSTRING_SIZE_ERR
type: constant
doc:
<comment>Description:</comment>
  Si el rango especificado de texto no cabe en un  <class>DOMString</class>.


id: DOMText
type: class
doc:
<comment>Description:</comment>
  La clase <class>DOMText</class> hereda de <class>DOMCharacterData</class> y representa el contenido textual de un objeto
  <class>DOMElement</class> o <class>DOMAttr</class>.


id: DOMText::__construct
type: function
doc:
<comment>Description:</comment>
  Crea un nuevo objeto DOMText
    
  
  Crea un nuevo objeto <class>DOMText</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  El valor del nodo de texto. Si no se proporciona, se crea un nodo de texto vacío.

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


id: DOMText::isElementContentWhitespace
type: function
doc:
<comment>Description:</comment>
  Devuelve si este nodo de texto contiene espacios en blanco en el contenido del elemento

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: DOMText::isWhitespaceInElementContent
type: function
doc:
<comment>Description:</comment>
  Indica si este nodo de texto contiene espacios en blanco
    
  
  Indica si este nodo de texto contiene únicamente espacios en blanco o si está vacío. El nodo de
  texto está determinado a contener espacios en blanco en el contenido del elemento durante la carga
  del documento.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el nodo contiene cero o más carecteres espacio en blanco y nada más. De lo
        contrario deveulve <info>false</info>.


id: DOMText::splitText
type: function
doc:
<comment>Description:</comment>
  Rompe este nodo en dos nodos en el índice especificado
    
  
  Rompe este nodo en dos nodos en el índice especificado por <strong>$offset</strong>,  manteniéndolos en el árbol
  como hermanos.
  
  Después de la separación, este nodo contendrá todos el contenido hata <strong>$offset</strong>. Si el nodo original
  tenía un nodo padre, el nuevo nodo se inserta como el hermano siguiente del nodo original.  Cuando
  <strong>$offset</strong> es igual a la longitud de este nodo, el nuevo nodo no tendrá información.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  El índice en el que se hace la separación, comenzando en 0.

<comment>Return:</comment>
  <info>DOMText</info>  El nuevo nodo del mismo tipo, que contiene todo el contenido desde y después de <strong>$offset</strong>.


id: DOMXPath::__construct
type: function
doc:
<comment>Description:</comment>
  Crea un nuevo objeto DOMXPath
    
  
  Crea un nuevo objeto <class>DOMXPath</class>.

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$doc</strong>  El objeto <class>DOMDocument</class> asociado con el objeto <class>DOMXPath</class>.


id: DOMXPath::evaluate
type: function
doc:
<comment>Description:</comment>
  Evalúa la expresión XPath dada y devuelve un resultado escrito si es posible
    
  
  Ejecuta la expresión XPath dada por <strong>$expression</strong> y devuelve un resultado escrito si es posible.

<comment>Param:</comment>
  <info>string</info>   <strong>$expression</strong>      La expresión XPath a ejecutar.
  <info>DOMNode</info>  <strong>$contextnode</strong>     El parámetro opcional <strong>$contextnode</strong> se puede especificar para hacer
                            consultas XPath relativas. Por omisión, las consultas son relativas al
                            elemento raíz.
  <info>bool</info>     <strong>$registerNodeNS</strong>  El parámetro opcional <strong>$registerNodeNS</strong> puede ser especificado para
                            deshabilitar el registro automático del nodo de contexto.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve un resultado escrito si es posible o un objeto <class>DOMNodeList</class>  que contiene todos los
         nodos coincidentes con la expresión XPath dada por <strong>$expression</strong>.
         
         Si el parámetro <strong>$expression</strong> está malformado o el parámetro <strong>$contextnode</strong> es inválido,
         DOMXPath::evaluate devuelve <info>false</info>.

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


id: DOMXPath::query
type: function
doc:
<comment>Description:</comment>
  Evalúa la expresión XPath dada
    
  
  Ejecuta la expresión XPath dada por <strong>$expression</strong>.

<comment>Param:</comment>
  <info>string</info>   <strong>$expression</strong>      La expresión XPath a ejecutar.
  <info>DOMNode</info>  <strong>$contextnode</strong>     El parámetro opcional <strong>$contextnode</strong> se puede especificar para hacer
                            consultas XPath relativas. Por omisión, las consultas son relativas al
                            elemento raíz.
  <info>bool</info>     <strong>$registerNodeNS</strong>  El parámetro opcional <strong>$registerNodeNS</strong> puede ser especificado para
                            deshabilitar el registro automático del nodo de contexto.

<comment>Return:</comment>
  <info>DOMNodeList</info>  Devuelve un objeto <class>DOMNodeList</class> que contiene todos los nodos coincidentes con la
               expresión XPath dada por <strong>$expression</strong>. Cualquier expresión que no devuelva nodos
               devolverá un objeto <class>DOMNodeList</class> vacío.
               
               Si el parámetro <strong>$expression</strong> está malformado o el parámetro <strong>$contextnode</strong> es inválido,
               DOMXPath::query devuelve <info>false</info>.

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


id: DOMXPath::registerNamespace
type: function
doc:
<comment>Description:</comment>
  Registra el espacio de nombres con el objeto DOMXPath
    
  
  Registra <strong>$namespaceURI</strong> y  <strong>$prefix</strong> con el objeto DOMXPath.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>        El prefijo.
  <info>string</info>  <strong>$namespaceURI</strong>  La URI del espacio de nombres.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: DOMXPath::registerPhpFunctions
type: function
doc:
<comment>Description:</comment>
  Registra funciones de PHP como funciones XPath
  
  Este método habilita la capacidad de usar funciones de PHP dentro de expresiones XPath.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$restrict</strong>  Use este parámetro para permitir solamente que ciertas funciones sean llamadas
                    desde XPath.
                    
                    Este parámetro puede ser un <info>string</info> (un nombre de función) o un <info>array</info> de nombres
                    de funciones.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * DOMXPath::registerNamespace
   * DOMXPath::query
   * DOMXPath::evaluate


id: DOM_INDEX_SIZE_ERR
type: constant
doc:
<comment>Description:</comment>
  Si el índice o el tamaño es negativo, o mayor que el valor permitido.


id: DOM_INUSE_ATTRIBUTE_ERR
type: constant
doc:
<comment>Description:</comment>
  Si se intenta agregar un atributo que esta siendo usado en otro lugar.


id: DOM_INVALID_ACCESS_ERR
type: constant
doc:
<comment>Description:</comment>
  Si un parámetro u operación no es soportado por el objeto subyacente.


id: DOM_INVALID_CHARACTER_ERR
type: constant
doc:
<comment>Description:</comment>
  Si un carácter ilegal o inválido es especificado, como en un nombre.


id: DOM_INVALID_STATE_ERR
type: constant
doc:
<comment>Description:</comment>
  Si se intenta utilizar un objeto que no es o ha dejado de ser usable.


id: DOM_NAMESPACE_ERR
type: constant
doc:
<comment>Description:</comment>
  Si se intenta crear o modificar un objeto de una manera que es incorrecta con respecto a su
  espacio de nombre (namespace).


id: DOM_NOT_FOUND_ERR
type: constant
doc:
<comment>Description:</comment>
  Si se intenta referenciar un nodo en un contexto en el que no existe.


id: DOM_NOT_SUPPORTED_ERR
type: constant
doc:
<comment>Description:</comment>
  Si la implementación no soporta el tipo de objeto u operación solicitado.


id: DOM_NO_MODIFICATION_ALLOWED_ERR
type: constant
doc:
<comment>Description:</comment>
  Si se intenta modificar un objeto donde las modificaciones no están permitidas.


id: DOM_PHP_ERR
type: constant
doc:
<comment>Description:</comment>
  El código de Error no forma parte de la especificación DOM. Significado para errores PHP.


id: DOM_VALIDATION_ERR
type: constant
doc:
<comment>Description:</comment>
  Si la llamada a un método como insertBefore o removeChild invalidará el Nodo con respecto a la
  "validez parcial", esta excepción  sera lanzada y la operación no se realizará.


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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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 función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: DateInterval
type: class
doc:
<comment>Description:</comment>
  Representa un intervalo de fechas.
  
  Un intervalo de fechas almacena o bien una cantidad fija de instantes (en años, meses, días,
  horas, etc.) o bien una cadena con un instante relativo en el formato que admite el constructor de
  <class>DateTime</class>.


id: DateInterval::__construct
type: function
doc:
<comment>Description:</comment>
  Crea un nuevo objeto DateInterval
  
  Crea un nuevo objeto DateInterval.

<comment>Param:</comment>
  <info>string</info>  <strong>$interval_spec</strong>  Una especificación de intervalo.
                          
                          El formato empieza con la letra <return>P</return>, de periodo. Cada periodo de duración
                          está representado por un valor de tipo integer seguido de un indicador de
                          periodo. Si la duración contiene elementos de hora, esa parte de la
                          especificación estará precedida por una letra <return>T</return>.
                          
                           Indicadores de periodo de <strong>$interval_spec</strong> Indicador de
                          periodoDescripción<return>Y</return>años<return>M</return>meses<return>D</return>días<return>W</return> semanas; estas se convierten a días,
                          Antes de PHP 8.0.0, no se puede combinar con <return>D</return>. <return>H</return>horas<return>M</return>minutos<return>S</return>segundos
                          
                          Algunos ejemplos sencillos: Dos días es <return>P2D</return>. Dos segundos es <return>PT2S</return>. Seis
                          años y cinco minutos es <return>P6YT5M</return>.
                          
                          Los tipos de unidades deben ser escritos desde la unidad de escala más
                          grande a la izquierda a la unidad de escala más pequeña a la derecha. Así
                          los años van antes que los meses, meses antes que días, días antes que
                          minutos, etc. Así un año y cuatro días debe representarse como <return>P1Y4D</return>, y no
                          como <return>P4D1Y</return>.
                          
                          La especificación también puede ser representada como una fecha/hora. Un
                          ejemplo de un año y cuatro días sería <return>P0001-00-04T00:00:00</return>. Pero los
                          valores en este formato no pueden exceder el punto de desbordamiento de un
                          periodo (p.ej. <return>25</return> horas no es válido).
                          
                          Estos formatos están basados en la especificación de duración ISO 8601.

<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>
  Establece un objeto DateInterval desde las partes relativas de una cadena
  
  Emplea el analizador de fechas normal y establece un objeto DateInterval desde las partes
  relativas de la cadena analizada.

<comment>Param:</comment>
  <info>string</info>  <strong>$time</strong>  Una fecha con partes relativas. Específicamente, los formatos relativos admitidos
                 por el analizador utilzados para <strong>strtotime()</strong> y <class>DateTime</class> serán los empleados para
                 construir el objeto DateInterval.

<comment>Return:</comment>
  <info>DateInterval</info>  Devuelve una nueva instancia de <class>DateInterval</class>.


id: DateInterval::format
type: function
doc:
<comment>Description:</comment>
  Formatea el intervalo
  
  Formatea el intervalo.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>   Los siguietes caracteres están reconocidos en el parámetro de cadena <strong>$format</strong>.
                   Cada carácter de formato debe ser prefijado con un signo de porcentaje (<return>%</return>).
                   Carácter <strong>$format</strong>DescripciónValores de ejemplo<return>%</return>Literal <return>%</return><return>%</return><return>Y</return>Años, numérico, al menos
                   2 dígitos empezando con 0<return>01</return>, <return>03</return><return>y</return>Años, numérico<return>1</return>, <return>3</return><return>M</return>Meses, numérico, al menos 2
                   dígitos empezando con 0<return>01</return>, <return>03</return>, <return>12</return><return>m</return>Meses, numérico<return>1</return>, <return>3</return>, <return>12</return><return>D</return>Días, numérico, al
                   menos 2 dígitos empezando con 0<return>01</return>, <return>03</return>, <return>31</return><return>d</return>Días, numérico<return>1</return>, <return>3</return>, <return>31</return><return>a</return>Número total de
                   días como resultado de una operación con DateTime::diff, o de lo contrario
                   <return>(unknown)</return><return>4</return>, <return>18</return>, <return>8123</return><return>H</return>Horas, numérico, al menos 2 dígitos empezando con 0<return>01</return>, <return>03</return>,
                   <return>23</return><return>h</return>Horas, numérico<return>1</return>, <return>3</return>, <return>23</return><return>I</return>Minutos, numérico, al menos 2 dígitos empezando con
                   0<return>01</return>, <return>03</return>, <return>59</return><return>i</return>Minutos, numérico<return>1</return>, <return>3</return>, <return>59</return><return>S</return>Segundos, numérico, al menos 2 dígitos
                   empezando con 0<return>01</return>, <return>03</return>, <return>57</return><return>s</return>Segundos, numérico<return>1</return>, <return>3</return>, <return>57</return><return>R</return>Signo "<return>-</return>" cuando es
                   negativo, "<return>+</return>" cuando es positivo<return>-</return>, <return>+</return><return>r</return>Signo "<return>-</return>" cuando es negativo, vacío cuando
                   es positivo<return>-</return>,

<comment>Return:</comment>
  <info>string</info>  Devuelve el intervalo formateado.

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


id: DatePeriod
type: class
doc:
<comment>Description:</comment>
  Representa un período de fechas.
  
  Un período de fechas permite la iteración sobre un conjunto de fechas y horas, repitiéndose a
  intervalos regulares durante un período dado.


id: DatePeriod::EXCLUDE_START_DATE
type: constant
doc:
<comment>Description:</comment>
  Excluir la fecha inicial, usado en <strong>DatePeriod::__construct()</strong>.


id: DatePeriod::__construct
type: function
doc:
<comment>Description:</comment>
  Crea un nuevo objeto DatePeriod
  
  Crea un nuevo objeto DatePeriod.

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$start</strong>        La fecha de inicio del periodo.
  <info>DateInterval</info>       <strong>$interval</strong>     El intervalo entre repeticiones dentro del periodo.
  <info>int</info>                <strong>$recurrences</strong>  El número de repeticiones.
  <info>DateTimeInterface</info>  <strong>$end</strong>          La fecha final del periodo.
  <info>string</info>             <strong>$isostr</strong>       Una especificación ISO 8601 del intervalo de repetición.
  <info>int</info>                <strong>$options</strong>      Se puede establecer a <info>DatePeriod::EXCLUDE_START_DATE</info> para excluir
                                   la fecha de inicio del conjunto de fechas de repetición dentro
                                   del periodo.


id: DatePeriod::createFromISO8601String
type: function
doc:
<comment>Description:</comment>
  Creates a new DatePeriod object from an ISO8601 string
  
  Creates a new DatePeriod object from an ISO8601 string, as specified with <strong>$specification</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$specification</strong>  A subset of the ISO 8601 repeating interval specification.
                          
                          An example of an accepted ISO 8601 interval specifications is
                          <return>R5/2008-03-01T13:00:00Z/P1Y2M10DT2H30M</return>, which specifies:
                          
                          5 iterations (<return>R5/</return>)
                          
                          Starting at <return>2008-03-01T13:00:00Z</return>.
                          
                          Each iteration is an 1 year, 2 months, 10 days, 2 hours, and 30 minute
                          interval (<return>/P1Y2M10DT2H30M</return>).
                          
                          Examples of some ISO 8601 interval specification features that PHP does
                          not support are:
                          
                          zero occurrences (<return>R0/</return>)
                          
                          time offsets other than UTC (<return>Z</return>), such as <return>+02:00</return>.
  <info>int</info>     <strong>$options</strong>        A bit field which can be used to control certain behaviour with start- and
                          end- dates.
                          
                          With <info>DatePeriod::EXCLUDE_START_DATE</info> you exclude the start date from the
                          set of recurring dates within the period.
                          
                          With <info>DatePeriod::INCLUDE_END_DATE</info> you include the end date in the set of
                          recurring dates within the period.

<comment>Return:</comment>
  <info>static</info>  Creates a new DatePeriod object.
          
          <class>DatePeriod</class> objects created with this method can be used as an iterator to generate a
          number of <class>DateTimeImmutable</class> objects.


id: DatePeriod::getDateInterval
type: function
doc:
<comment>Description:</comment>
  Obtener el intervalo
    
  
  Estilo orientado a objetos
  
  Obtiene un objeto <class>DateInterval</class>  representa el intervalo empleado para el periodo.

<comment>Return:</comment>
  <info>DateInterval</info>  Devuelve un objeto <class>DateInterval</class>

<comment>See Also:</comment>
   * DatePeriod::getStartDate
   * DatePeriod::getEndDate


id: DatePeriod::getEndDate
type: function
doc:
<comment>Description:</comment>
  Obtener la fecha final
    
  
  Estilo orientado a objetos
  
  Obtiene la fecha final del periodo.

<comment>Return:</comment>
  <info>DateTimeInterface</info>  Devuelve <info>null</info> si el objeto <class>DatePeriod</class> no posee una fecha final. Por ejemplo,
                     cuando se inicializó con el parámetro <strong>$recurrences</strong>, o el parámetro <strong>$isostr</strong> sin
                     una fecha final.
                     
                     Devuelve un objeto <class>DateTimeImmutable</class> cuando el objeto <class>DatePeriod</class> se inicializó
                     con un objeto <class>DateTimeImmutable</class> para el parámetro <strong>$end</strong>.
                     
                     De lo contrario, devuelve un objeto <class>DateTime</class>.

<comment>See Also:</comment>
   * DatePeriod::getStartDate
   * DatePeriod::getDateInterval


id: DatePeriod::getRecurrences
type: function
doc:
<comment>Description:</comment>
  Gets the number of recurrences
  
  Estilo orientado a objetos
  
  Get the number of recurrences.

<comment>Return:</comment>
  <info>int|null</info>  The number of recurrences as set by explicitly passing the <return>$recurrences</return> to the
            contructor of the <class>DatePeriod</class> class, or <info>null</info> otherwise.

<comment>See Also:</comment>
   * DatePeriod::$recurrences


id: DatePeriod::getStartDate
type: function
doc:
<comment>Description:</comment>
  Obtener la fecha inicial
    
  
  Estilo orientado a objetos
  
  Obtiene la fecha inicial del periodo.

<comment>Return:</comment>
  <info>DateTimeInterface</info>  Devuelve un objeto <class>DateTimeImmutable</class> cuando el objeto <class>DatePeriod</class> se inicializó
                     con un objeto <class>DateTimeImmutable</class> para el parámetro <strong>$start</strong>.
                     
                     De lo contrario, devuelve un objeto <class>DateTime</class>.

<comment>See Also:</comment>
   * DatePeriod::getEndDate
   * DatePeriod::getDateInterval


id: DateTime::__construct
type: function
doc:
<comment>Description:</comment>
  Devuelve un nuevo objeto DateTime
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve un nuevo objeto DateTime.

<comment>Param:</comment>
  <info>string</info>        <strong>$time</strong>      Una cadena de fecha/hora. Los formatos válidos se explican en Formatos de
                           fecha y hora.
                           
                           Introducir <info>null</info> aquí para obtener el instante actual cuando se emplee el
                           parámetro <strong>$timezone</strong>.
  <info>DateTimeZone</info>  <strong>$timezone</strong>  Un objeto <class>DateTimeZone</class> que representa la zona horaria de <strong>$time</strong>.
                           
                           Si se omite <strong>$timezone</strong>, se usará la zona horaria actual.
                           
                           El parámetro <strong>$timezone</strong> y la zona horaria actuales se ignoran cuando el
                           parámetro <strong>$time</strong> es una marca temporal de UNIX (p.ej. <return>@946684800</return>) o
                           especifica una zona horaria (p.ej. <return>2010-01-28T15:00:00+02:00</return>).

<comment>Return:</comment>
  <info>DateTime</info>  Devuelve una nueva instancia de DateTime. Estilo por procedimientos devuelve <info>false</info> en
            caso de error.

<comment>See Also:</comment>
   * <strong>DateTime::createFromFormat()</strong>
   * <strong>DateTimeZone::__construct()</strong>
   * Formatos de fecha y hora
   * Configuración ini de date.timezone
   * <strong>date_default_timezone_set()</strong>
   * <strong>DateTime::getLastErrors()</strong>
   * <strong>checkdate()</strong>


id: DateTime::__set_state
type: function
doc:
<comment>Description:</comment>
  El gestor __set_state
  
  El gestor __set_state().

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  Array de inicialización.

<comment>Return:</comment>
  <info>DateTime</info>  Devuelve una nueva instancia de un objeto DateTime.


id: DateTime::__wakeup
type: function
doc:
<comment>Description:</comment>
  El gestor __wakeup
  
  El gestor __wakeup().

<comment>Return:</comment>
  <info>unknown</info>  Inicializa un objeto DateTime.


id: DateTime::add
type: function
doc:
<comment>Description:</comment>
  Añade una cantidad de días, meses, años, horas, minutos y segundos a un objeto
     DateTime
    
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Añade el objeto <class>DateInterval</class> especificado al objeto <class>DateTime</class> especificado.

<comment>Param:</comment>
  <info>DateTime</info>      <strong>$object</strong>    Solamente para el estilo por procedimientos: Un objeto <class>DateTime</class> devuelto
                           por <strong>date_create()</strong>. La función modifica este objeto.
  <info>DateInterval</info>  <strong>$interval</strong>  Un objeto <class>DateInterval</class>

<comment>Return:</comment>
  <info>DateTime</info>  Devuelve el objeto <class>DateTime</class> para la cadena de métodos  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>DateTime::sub()</strong>
   * <strong>DateTime::diff()</strong>
   * <strong>DateTime::modify()</strong>


id: DateTime::createFromFormat
type: function
doc:
<comment>Description:</comment>
  Analiza una cadena con un instante según un formato especificado
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve un nuevo objeto DateTime que representa la fecha y la hora especificadas por la cadena
  <strong>$time</strong>, la cual fue formateada en el formato dado por <strong>$format</strong>.

<comment>Param:</comment>
  <info>string</info>        <strong>$format</strong>    El formato en el que debe estar el <info>string</info> proporcionado. Véanse las
                           opciones de formateo más abajo. En la mayoría de los casos se pueden usar
                           las mismas letras que para <strong>date()</strong>.
                           
                           Se reconocen los siguientes caracteres en el string del parámetro
                           <strong>$format</strong>Carácter de <strong>$format</strong>DescripciónEjemplo de valores
                           analizablesDía------<return>d</return> y <return>j</return>Día del mes, 2 dígitos con o sin ceros
                           iniciales<return>01</return> a <return>31</return> o <return>1</return> a <return>31</return> <return>D</return> y <return>l</return>Una representación textual de un día<return>Mon</return>
                           hasta <return>Sun</return> o <return>Sunday</return> hasta <return>Saturday</return> <return>S</return>Sufijo ordinal inglés para el día del
                           mes; 2 caracteres. Se ignora mientras se procesa.<return>st</return>, <return>nd</return>, <return>rd</return> o <return>th</return>. <return>z</return>El día
                           del año (comenzando por 0)<return>0</return> hasta <return>365</return>Mes------<return>F</return> y <return>M</return>Una representación
                           textual de un mes, como January o Sept<return>January</return> hasta <return>December</return> o <return>Jan</return> hasta
                           <return>Dec</return> <return>m</return> y <return>n</return>Representación numérica de un mes, con o sin ceros iniciales<return>01</return>
                           hasta <return>12</return> o <return>1</return> hasta <return>12</return> Año------<return>Y</return>Una representación numérica completa de
                           un año, 4 dígitosEjemplos: <return>1999</return> o <return>2003</return><return>y</return> Una representación de dos dígitos
                           de un año (el cual se asume que esté en el rango 1970-2069, inclusive)
                           Ejemplos: <return>99</return> o <return>03</return> (que serán representados como <return>1999</return> y <return>2003</return>,
                           respectivamente) Hora------<return>a</return> y <return>A</return>Ante meridiem y Post meridiem<return>am</return> o <return>pm</return><return>g</return> y
                           <return>h</return>Formato de 12 horas de una hora con o sin ceros iniciales<return>1</return> hasta <return>12</return> o <return>01</return>
                           hasta <return>12</return> <return>G</return> y <return>H</return>Formato de 24 horas de una hora con o sin ceros iniciales<return>0</return>
                           hasta <return>23</return> o <return>00</return> hasta <return>23</return> <return>i</return>Minutos con ceros iniciales<return>00</return> hasta <return>59</return><return>s</return>Segundos,
                           con ceros iniciales<return>00</return> hasta <return>59</return><return>u</return>Microsegundos (hasta seis dígitos)Ejemplo:
                           <return>45</return>, <return>654321</return>Zona horaria------<return>e</return>, <return>O</return>, <return>P</return> y <return>T</return> Identificador de zona horaria, o
                           diferencia con UTC en horas, o diferencia con UTC con dos puntos entre
                           horas y minutos, o abreviatura de la zona horariaEjemplos: <return>UTC</return>, <return>GMT</return>,
                           <return>Atlantic/Azores</return> o <return>+0200</return> o <return>+02:00</return> o <return>EST</return>, <return>MDT</return> Fecha/Hora
                           completas------<return>U</return>Segundos desde la Época Unix (January 1 1970 00:00:00
                           GMT)Ejemplo: <return>1292177455</return>Espacios en blanco y separadores------<return> </return>
                           (espacio)Un espacio o una tabulaciónEjemplo: <return> </return><return>#</return> Uno de los siguientes
                           símbolos de separación: <return>;</return>, <return>:</return>, <return>/</return>, <return>.</return>, <return>,</return>, <return>-</return>, <return>(</return> o <return>)</return> Ejemplo: <return>/</return><return>;</return>, <return>:</return>, <return>/</return>, <return>.</return>, <return>,</return>,
                           <return>-</return>, <return>(</return> o <return>)</return> El carácter especificado.Ejemplo: <return>-</return><return>?</return>Un byte aleatorioEjemplo: <return>^</return>
                           (Observe que para los caracteres UTF-8 podría ser necesario más de un <return>?</return>.
                           En este caso es probable que quiera usar <return>*</return> en su lugar)<return>*</return>Bytes aleatorios
                           hasta el siguiente separador o dígitoEjemplo: <return>*</return> en <return>Y-*-d</return> con el string
                           <return>2009-unaPalabra-08</return> coincidirá con <return>unaPalabra</return><return>!</return>Reinicia todos los campos
                           (año, mes, día, hora, minuto, segundo, fracción e información de la zona
                           horaria) a la Época UnixSin <return>!</return>, todos los campos serán establecidos a la
                           fecha y hora actuales.<return>|</return>Reinicia todos los campos (año, mes, día, hora,
                           minuto, segundo, fracción e información de la zona horaria) a la Época
                           Unix si no han sido aún analizados<return>Y-m-d|</return> establecerá el año, mes y día a
                           la información encontrada en el string a analizar, y establece la hora,
                           minutos y segundos a 0.<return>+</return>Si este especificador de formato está presente,
                           la información sobrante del string no causará un error, pero sí una
                           advertencia.Use DateTime::getLastErrors para averiguar si había presente
                           información sobrante.
                           
                           Los caracteres no reconocidos en el string de formato causarán que falle
                           el análisis y se añadirá un mensaje de error a la esctructura devuelta.
                           Puede consultar los mensajes de error con DateTime::getLastErrors.
                           
                           Para incluir caracters literales en <strong>$format</strong>, se han de escapar con una
                           barra invertida (<return>\</return>).
                           
                           Si <strong>$format</strong> no contiene el carácter <return>!</return>, las partes del instante generado
                           que no estén especificadas en <strong>$format</strong> serán establecidas al instante
                           actual del sistema.
                           
                           Si <strong>$format</strong> contiene el carácter <return>!</return>, las partes del instante generadas no
                           proporcionadas en <strong>$format</strong>, así como los valores más a la izquierda de <return>!</return>,
                           serán establecidos a los valores correspondientes de la época Unix.
                           
                           La época Unix es 1970-01-01 00:00:00 UTC.
  <info>string</info>        <strong>$time</strong>      Un string que representa la hora.
  <info>DateTimeZone</info>  <strong>$timezone</strong>  Un objeto <class>DateTimeZone</class> que representa la zona horaria deseada.
                           
                           Si se omite <strong>$timezone</strong> y <strong>$time</strong> no contiene ninguna zona horaria, se usará
                           la zona horaria en uso.
                           
                           El parámetro <strong>$timezone</strong> y la zona horaria actual son ignoradas cuando el
                           parámetro <strong>$time</strong> contiene una marca temporal de UNIX (p.ej. <return>946684800</return>) o
                           especifica una zona horaria (p.ej. <return>2010-01-28T15:00:00+02:00</return>).

<comment>Return:</comment>
  <info>DateTime</info>  Devuelve una nueva instancia de DateTime  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>DateTime::__construct()</strong>
   * <strong>DateTime::getLastErrors()</strong>
   * <strong>checkdate()</strong>
   * <strong>strptime()</strong>


id: DateTime::createFromImmutable
type: function
doc:
<comment>Description:</comment>
  Returns new DateTime instance encapsulating the given DateTimeImmutable object

<comment>Param:</comment>
  <info>DateTimeImmutable</info>  <strong>$object</strong>  The immutable <class>DateTimeImmutable</class> object that needs to be converted to a
                              mutable version. This object is not modified, but instead a new
                              <class>DateTime</class> instance is created containing the same date, time, and
                              timezone information.

<comment>Return:</comment>
  <info>static</info>  Returns a new <class>DateTime</class> instance.


id: DateTime::createFromInterface
type: function
doc:
<comment>Description:</comment>
  Returns new DateTime object encapsulating the given DateTimeInterface object

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  The <class>DateTimeInterface</class> object that needs to be converted to a mutable
                              version. This object is not modified, but instead a new <class>DateTime</class>
                              object is created containing the same date, time, and timezone
                              information.

<comment>Return:</comment>
  <info>DateTime</info>  Returns a new <class>DateTime</class> instance.


id: DateTime::diff
type: function
doc:
<comment>Description:</comment>
  Devuelve la diferencia entre dos objetos DateTime
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve la diferencia entre dos objetos <class>DateTimeInterface</class>.

<comment>Param:</comment>
  <info></info>      <strong>$datetime</strong>  La fecha a comparar.
  <info>bool</info>  <strong>$absolute</strong>  ¿Debería el intervalo ser forzado para ser positivo?

<comment>Return:</comment>
  <info>DateInterval</info>  El objeto <class>DateInterval</class> que representa la diferencia entre dos fechas  o <info>false</info> en
                caso de error.

<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>
  Devuelve la fecha formateada según el formato dado
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve la fecha formateada según el formato dado.

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  Solamente para el estilo por procedimientos: Un objeto <class>DateTime</class>
                              devuelto por <strong>date_create()</strong>
  <info>string</info>             <strong>$format</strong>  Formato aceptado por <strong>date()</strong>.

<comment>Return:</comment>
  <info>string</info>  Devuelve la fecha formateada en caso de éxito  o <info>false</info> en caso de error.

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


id: DateTime::getLastErrors
type: function
doc:
<comment>Description:</comment>
  Devuelve las advertencias y los errores
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve un array con las advertencias y los errores encontrados mientras se analizaba una cadena
  de fecha/hora.

<comment>Return:</comment>
  <info>array|false</info>  Devuelve un array que contiene información acerca de las advertencias y los errores,
               o <info>false</info> si no hay advertencias ni errores.


id: DateTime::getOffset
type: function
doc:
<comment>Description:</comment>
  Devuelve el índice de la zona horaria
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve el índice de la zona horaria.

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  Solamente para el estilo por procedimientos: Un objeto <class>DateTime</class>
                              devuelto por <strong>date_create()</strong>

<comment>Return:</comment>
  <info>int</info>  Devuelve el índice de la zona horaria en segundos desde UTC en caso de éxito o <info>false</info> en caso
       de error.


id: DateTime::getTimestamp
type: function
doc:
<comment>Description:</comment>
  Obtiene la marca de tiempo Unix
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene la marca de tiempo Unix.

<comment>Return:</comment>
  <info>int</info>  Devuelve la  marca de tiempo Unix que representa la fecha.

<comment>See Also:</comment>
   * <strong>DateTime::setTimestamp()</strong>
   * <strong>DateTime::format()</strong>


id: DateTime::getTimezone
type: function
doc:
<comment>Description:</comment>
  Develve la zona horaria relativa al objeto DateTime dado
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Develve la zona horaria relativa al objeto DateTime dado.

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  Solamente para el estilo por procedimientos: Un objeto <class>DateTime</class>
                              devuelto por <strong>date_create()</strong>

<comment>Return:</comment>
  <info>DateTimeZone</info>  Devuelve un objeto <class>DateTimeZone</class> en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>DateTime::setTimezone()</strong>


id: DateTime::modify
type: function
doc:
<comment>Description:</comment>
  Altera la marca temporal
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Altera la marca temporal de un objeto DateTime aumentando o disminuyendo en un formato aceptado
  por <strong>strtotime()</strong>.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>  Solamente para el estilo por procedimientos: Un objeto <class>DateTime</class> devuelto por
                     <strong>date_create()</strong>. La función modifica este objeto.
  <info>string</info>    <strong>$modify</strong>  Una cadena de fecha/hora. Los formatos válidos se explican en Formatos de fecha
                     y hora.

<comment>Return:</comment>
  <info>DateTime</info>  Devuelve el objeto <class>DateTime</class> para la cadena de métodos  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>strtotime()</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>
  Establece la fecha
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Reinicia la fecha actual del objeto DateTime a una fecha diferente.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>  Solamente para el estilo por procedimientos: Un objeto <class>DateTime</class> devuelto por
                     <strong>date_create()</strong>. La función modifica este objeto.
  <info>int</info>       <strong>$year</strong>    Año de la fecha.
  <info>int</info>       <strong>$month</strong>   Mes de la fecha.
  <info>int</info>       <strong>$day</strong>     Día de la fecha.

<comment>Return:</comment>
  <info>DateTime</info>  Devuelve el objeto <class>DateTime</class> para la cadena de métodos  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>DateTime::setISODate()</strong>
   * <strong>DateTime::setTime()</strong>


id: DateTime::setISODate
type: function
doc:
<comment>Description:</comment>
  Establece la fecha ISO
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece una fecha según el estándar ISO 8601, empleando índices de semanas y días  en vez de
  fechas específicas.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>  Solamente para el estilo por procedimientos: Un objeto <class>DateTime</class> devuelto por
                     <strong>date_create()</strong>. La función modifica este objeto.
  <info>int</info>       <strong>$year</strong>    Año de la fecha.
  <info>int</info>       <strong>$week</strong>    Semana de la fecha.
  <info>int</info>       <strong>$day</strong>     Índice del primer día de la semana.

<comment>Return:</comment>
  <info>DateTime</info>  Devuelve el objeto <class>DateTime</class> para la cadena de métodos  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>DateTime::setDate()</strong>
   * <strong>DateTime::setTime()</strong>


id: DateTime::setTime
type: function
doc:
<comment>Description:</comment>
  Establece la hora
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Reinicia la hora actual del objeto DateTime a una hora diferente.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>  Solamente para el estilo por procedimientos: Un objeto <class>DateTime</class> devuelto por
                     <strong>date_create()</strong>. La función modifica este objeto.
  <info>int</info>       <strong>$hour</strong>    Hora del instante.
  <info>int</info>       <strong>$minute</strong>  Minuto del instante.
  <info>int</info>       <strong>$second</strong>  Segundo del instante.

<comment>Return:</comment>
  <info>DateTime</info>  Devuelve el objeto <class>DateTime</class> para la cadena de métodos  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>DateTime::setDate()</strong>
   * <strong>DateTime::setISODate()</strong>


id: DateTime::setTimestamp
type: function
doc:
<comment>Description:</comment>
  Establece la fecha y la hora basándose en una marca temporal de Unix
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece la fecha y la hora basándose en una marca temporal de Unix.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>         Solamente para el estilo por procedimientos: Un objeto <class>DateTime</class> devuelto
                            por <strong>date_create()</strong>. La función modifica este objeto.
  <info>int</info>       <strong>$unixtimestamp</strong>  La marca temporal de Unix que representa la fecha.

<comment>Return:</comment>
  <info>DateTime</info>  Devuelve el objeto <class>DateTime</class> para la cadena de métodos  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>DateTime::getTimestamp()</strong>


id: DateTime::setTimezone
type: function
doc:
<comment>Description:</comment>
  Establece la zona horaria para el objeto DateTime
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece una nueva zona horaria para un <info>object</info> de <class>DateTime</class>.

<comment>Param:</comment>
  <info>DateTime</info>      <strong>$object</strong>    Solamente para el estilo por procedimientos: Un objeto <class>DateTime</class> devuelto
                           por <strong>date_create()</strong>. La función modifica este objeto.
  <info>DateTimeZone</info>  <strong>$timezone</strong>  Un objeto <class>DateTimeZone</class> que representa la zona horaria deseada.

<comment>Return:</comment>
  <info>DateTime</info>  Devuelve el objeto <class>DateTime</class> para la cadena de métodos  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>DateTime::getTimezone()</strong>
   * <strong>DateTimeZone::__construct()</strong>


id: DateTime::sub
type: function
doc:
<comment>Description:</comment>
  Sustrae una cantidad de días, meses, años, horas, minutos y segundos de un objeto
     DateTime
    
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Sustrae el objeto <class>DateInterval</class> especificado del objeto DateTime especificado.

<comment>Param:</comment>
  <info>DateTime</info>      <strong>$object</strong>    Solamente para el estilo por procedimientos: Un objeto <class>DateTime</class> devuelto
                           por <strong>date_create()</strong>. La función modifica este objeto.
  <info>DateInterval</info>  <strong>$interval</strong>  Un objeto <class>DateInterval</class>

<comment>Return:</comment>
  <info>DateTime</info>  Devuelve el objeto <class>DateTime</class> para la cadena de métodos  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>DateTime::add()</strong>
   * <strong>DateTime::diff()</strong>
   * <strong>DateTime::modify()</strong>


id: DateTimeImmutable
type: class
doc:
<comment>Description:</comment>
  Esta clase se comporta igual que <class>DateTime</class> con la excepción de que nunca se modifica a sí misma,
  sino que devuelve un nuevo objeto en su lugar.


id: DateTimeImmutable::__construct
type: function
doc:
<comment>Description:</comment>
  Devuelve un nuevo objeto DateTimeImmutable
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Igual que DateTime::__construct excepto que trabaja con <class>DateTimeImmutable</class>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  


id: DateTimeImmutable::__set_state
type: function
doc:
<comment>Description:</comment>
  El gestor __set_state
  
  Igual DateTime::__set_state excepto que trabaja con <class>DateTimeImmutable</class>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  


id: DateTimeImmutable::add
type: function
doc:
<comment>Description:</comment>
  Añade una cantidad de días, meses, años, horas, minutos y segundos
    
  
  Igual que DateTime::add excepto que trabaja con <class>DateTimeImmutable</class>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  


id: DateTimeImmutable::createFromFormat
type: function
doc:
<comment>Description:</comment>
  Devuelve un nuevo objeto DateTimeImmutable formateado según el formato especificado
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Igual que DateTime::createFromFormat excepto que trabaja con <class>DateTimeImmutable</class>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  


id: DateTimeImmutable::createFromInterface
type: function
doc:
<comment>Description:</comment>
  Returns new DateTimeImmutable object encapsulating the given DateTimeInterface object

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  The <class>DateTimeInterface</class> object that needs to be converted to an
                              immutable version. This object is not modified, but instead a new
                              <class>DateTimeImmutable</class> object is created containing the same date, time,
                              and timezone information.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Returns a new <class>DateTimeImmutable</class> instance.


id: DateTimeImmutable::createFromMutable
type: function
doc:
<comment>Description:</comment>
  Devuelve un nuevo objeto DateTimeImmutable que encapsula el objeto DateTime dado

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$datetime</strong>  El objeto <class>DateTime</class> mutable para convertirlo en una versión mutable. Este
                       objeto no se modifica, sino que en su lugar se crea un nuevo objeto
                       <class>DateTimeImmutable</class> que contiene la misma información de fecha, hora y zona
                       horaria.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Devuelve una nueva instancia de <class>DateTimeImmutable</class>.


id: DateTimeImmutable::getLastErrors
type: function
doc:
<comment>Description:</comment>
  Devuelve las advertencias y errores
  
  Igual que DateTime::getLastErrors excepto que trabaja con <class>DateTimeImmutable</class>.

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


id: DateTimeImmutable::modify
type: function
doc:
<comment>Description:</comment>
  Crea un nuevo objeto con la marca de tiempo modificada
  
  Crea un nuevo objeto <info>DateTimeImmutable</info> con la marca de tiempo modificada. El objeto original no se
  modifica.

<comment>Param:</comment>
  <info></info>        <strong>$object</strong>  Solamente para el estilo por procedimientos: Un objeto <class>DateTime</class> devuelto por
                   <strong>date_create()</strong>. La función modifica este objeto.
  <info>string</info>  <strong>$modify</strong>  Una cadena de fecha/hora. Los formatos válidos se explican en Formatos de fecha y
                   hora.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Devuelve el objeto recién creado  o <info>false</info> en caso de error.


id: DateTimeImmutable::setDate
type: function
doc:
<comment>Description:</comment>
  Establece la fecha
  
  Igual que DateTime::setDate excepto que trabaja con <class>DateTimeImmutable</class>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  


id: DateTimeImmutable::setISODate
type: function
doc:
<comment>Description:</comment>
  Establece la fecha ISO
  
  Igual que DateTime::setISODate excepto que trabaja con <class>DateTimeImmutable</class>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  


id: DateTimeImmutable::setTime
type: function
doc:
<comment>Description:</comment>
  Establece la hora
  
  Igual que DateTime::setTime excepto que trabaja con <class>DateTimeImmutable</class>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  


id: DateTimeImmutable::setTimestamp
type: function
doc:
<comment>Description:</comment>
  Establece la fecha y hora basadas en una marca de tiempo Unix
  
  Igual que DateTime::setTimestamp excepto que trabaja con <class>DateTimeImmutable</class>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  


id: DateTimeImmutable::setTimezone
type: function
doc:
<comment>Description:</comment>
  Establece la zona horaria
  
  Igualq que DateTime::setTimezone excepto que trabaja con <class>DateTimeImmutable</class>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  


id: DateTimeImmutable::sub
type: function
doc:
<comment>Description:</comment>
  Sustrae una cantidad de días, meses, años, horas, minutos y segundos
    
  
  Igual que DateTime::sub excepto que trabaja con <class>DateTimeImmutable</class>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  


id: DateTimeInterface
type: class
doc:
<comment>Description:</comment>
  El propósito de DateTimeInterface es actuar como declaración de tipo para DateTime y
  DateTimeImmutable. No es posible que el usuario implemente esta interfaz en sus propias clases.


id: DateTimeZone::ALL_WITH_BC
type: constant
doc:
<comment>Description:</comment>
  Todas las zonas horarias incluyendo las de versiones anteriores por compatibilidad.


id: DateTimeZone::__construct
type: function
doc:
<comment>Description:</comment>
  Crea un nuevo objeto DateTimeZone
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Crea un nuevo objeto DateTimeZone.

<comment>Param:</comment>
  <info>string</info>  <strong>$timezone</strong>  Uno de los nombres de zonas horarias admitidos o un índice válido (+0200).

<comment>Return:</comment>
  <info>DateTimeZone</info>  Devuelve un objeto <class>DateTimeZone</class> si tuvo éxito. Estilo por procedimientos devuelve
                <info>false</info> en caso de error.


id: DateTimeZone::getLocation
type: function
doc:
<comment>Description:</comment>
  Devuelve la información de la ubicación para una zona horaria
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve la información de la ubicación para una zona horaria, incluyendo el código de país,
  latitud/longitud y comentarios.

<comment>Param:</comment>
  <info></info>  <strong>$object</strong>  Solamente para el estilo por procedimientos: Un objeto <class>DateTimeZone</class>
             devuelto por <strong>timezone_open()</strong>

<comment>Return:</comment>
  <info>array</info>  Una matriz que contiene la información de la ubicación acerca de una zona horaria o <info>false</info>
         en caso de error.


id: DateTimeZone::getName
type: function
doc:
<comment>Description:</comment>
  Devuelve el nombre de la zona horaria
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve el nombre de la zona horaria.

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$object</strong>  El <class>DateTimeZone</class> del cual desera obtener el nombre.

<comment>Return:</comment>
  <info>string</info>  Una de los nombres de zona horaria en la lista de zonas horarias.


id: DateTimeZone::getOffset
type: function
doc:
<comment>Description:</comment>
  Devuelve el índice de la zona horaria de GMT
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Esta función devuelve el índice GMT para la fecha/hora especificada en el parámetro <strong>$datetime</strong>. El
  índice GMT se calcula con la información de la zona horaria contenida en el objeto DateTimeZone
  que se va a utilizar.

<comment>Param:</comment>
  <info></info>          <strong>$object</strong>    Solamente para el estilo por procedimientos: Un objeto <class>DateTimeZone</class>
                       devuelto por <strong>timezone_open()</strong>
  <info>DateTime</info>  <strong>$datetime</strong>  El objeto DateTime que contiene la fecha/hora desde la que se va a computar
                       el índice.

<comment>Return:</comment>
  <info>int</info>  Devuelve el índice de la zona horaria en segundos si tiene éxito  o <info>false</info> en caso de error.


id: DateTimeZone::getTransitions
type: function
doc:
<comment>Description:</comment>
  Devuelve todas las transiciones para una zona horaria
  
  Estilo orientado a objetos
  
  Estilo por procedimientos

<comment>Param:</comment>
  <info></info>     <strong>$object</strong>           Solamente para el estilo por procedimientos: Un objeto <class>DateTimeZone</class>
                         devuelto por <strong>timezone_open()</strong>
  <info>int</info>  <strong>$timestamp_begin</strong>  Marca de tiempo de inicio.
  <info>int</info>  <strong>$timestamp_end</strong>    Marca de tiempo final.

<comment>Return:</comment>
  <info>array</info>  Deveulve una matriz numérica que contiene una matriz asociativa con todas las transiciones
         si se tuvo éxito  o <info>false</info> en caso de error.


id: DateTimeZone::listAbbreviations
type: function
doc:
<comment>Description:</comment>
  Devuelve una matriz asociativa que contiene el horario de verano (dst), el índice y el nombre de
  la
  zona horaria
  
  Estilo orientado a objetos
  
  Estilo por procedimientos

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz si se tuvo éxito  o <info>false</info> en caso de error.

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


id: DateTimeZone::listIdentifiers
type: function
doc:
<comment>Description:</comment>
  Devuelve un array indexado numéricamente que contiene todos los identificadores de zonas horarias
  definidos
  
  Estilo orientado a objetos
  
  Estilo por procedimientos

<comment>Param:</comment>
  <info>int</info>     <strong>$what</strong>     Una de las constantes de la clase <class>DateTimeZone</class>.
  <info>string</info>  <strong>$country</strong>  Un código de país de dos letras compatible con ISO 3166-1.
                    
                    Esta opción sólo se usa cuando el parámetro <strong>$what</strong> está establecido a
                    <info>DateTimeZone::PER_COUNTRY</info>.

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz si se tuvo éxito  o <info>false</info> en caso de error.

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


id: DeflateContext
type: class
doc:
<comment>Description:</comment>
  Una clase completamente opaca que reemplaza los recursos <return>zlib.deflate</return> a partir de PHP 8.0.0.


id: Directory
type: class
doc:
<comment>Description:</comment>
  Las instancias de <class>Directory</class> se crean mediante una llamada a la funcion <strong>dir()</strong> , no por el operador
  new.


id: Directory::close
type: function
doc:
<comment>Description:</comment>
  Cierra un gestor de directorio
  
  Al igual que <strong>closedir()</strong>, solo que el valor predeterminado de <strong>$dir_handle</strong> es $this-&gt;handle.

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


id: Directory::read
type: function
doc:
<comment>Description:</comment>
  Lee una entrada desde el controlador de directorio
  
  Igual a <strong>readdir()</strong>,<strong>$ dir_handle</strong> por defecto $this-&gt;handle.

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


id: Directory::rewind
type: function
doc:
<comment>Description:</comment>
  Rebobina el manejador de directorio
  
  Igual a <strong>rewinddir()</strong>, <strong>$ dir_handle</strong> por defecto $this-&gt;handle.

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


id: DirectoryIterator
type: class
doc:
<comment>Description:</comment>
  La clase DirectoryIterator proporciona un sencilla interfaz para ver el contenido de los
  directorios del sistema de ficheros.


id: DirectoryIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un iterador nuevo directorio de una ruta
  
  Construye un iterador nuevo directorio de una ruta.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  La ruta del directorio a recorrer.

<comment>See Also:</comment>
   * <class>SplFileInfo</class>
   * <class>Iterator</class>


id: DirectoryIterator::__toString
type: function
doc:
<comment>Description:</comment>
  Obtiene el nombre del fichero como un string
  
  Obtener el nombre del fichero del el elemento actual <class>DirectoryIterator</class>.

<comment>Return:</comment>
  <info>string</info>  Devuelve el nombre del fichero del elemento actual <class>DirectoryIterator</class>.

<comment>See Also:</comment>
   * DirectoryIterator::getFilename
   * El método mágico __toString()


id: DirectoryIterator::current
type: function
doc:
<comment>Description:</comment>
  Devuelve el elemento actual del DirectoryIterator
  
  Obtiene el elemento actual del <class>DirectoryIterator</class>.

<comment>Return:</comment>
  <info>DirectoryIterator</info>  El elemento actual del <class>DirectoryIterator</class>.

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


id: DirectoryIterator::getBasename
type: function
doc:
<comment>Description:</comment>
  Obtener el nombre base del elemento actual DirectoryIterator
  
  Obtiene el nombre base del elemento actual <class>DirectoryIterator</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$suffix</strong>  Si el nombre base termina en <strong>$suffix</strong>,  este será cortado.

<comment>Return:</comment>
  <info>string</info>  El nombre base del elemento actual <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>
  Obtiene la extensión de un fichero
  
  Recupera la extensión de un fichero.

<comment>Return:</comment>
  <info>string</info>  Devuelve un <info>string</info> que contiene la extensión del ficher, o un <info>string</info> vacío si el fichoer
          no tiene extensión.

<comment>See Also:</comment>
   * DirectoryIterator::getFilename
   * DirectoryIterator::getBasename
   * <strong>pathinfo()</strong>


id: DirectoryIterator::getFilename
type: function
doc:
<comment>Description:</comment>
  Devuelve el nombre del fichero del elemento actual DirectoryIterator
  
  Obtiene el nombre del elemento actual <class>DirectoryIterator</class>.

<comment>Return:</comment>
  <info>string</info>  Devuelve el nombre del fichero del elemento actual <class>DirectoryIterator</class>.

<comment>See Also:</comment>
   * DirectoryIterator::getBasename
   * DirectoryIterator::getPath
   * DirectoryIterator::getPathname
   * <strong>pathinfo()</strong>


id: DirectoryIterator::isDot
type: function
doc:
<comment>Description:</comment>
  Determina si el elemento actual DirectoryIterator es '.' o '..'
  
  Determina si el elemento actual <class>DirectoryIterator</class>  es un directorio y es <return>.</return> o <return>..</return>

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si la entrada es <return>.</return> o <return>..</return>, en caso contrario <info>false</info>

<comment>See Also:</comment>
   * DirectoryIterator::getType
   * DirectoryIterator::isDir
   * DirectoryIterator::isFile
   * DirectoryIterator::isLink


id: DirectoryIterator::key
type: function
doc:
<comment>Description:</comment>
  Devuelve la clave del elemento actual DirectoryIterator
  
  Obtiene la clave para el elemento actual <class>DirectoryIterator</class>.

<comment>Return:</comment>
  <info>string</info>  La clave para el elemento actual <class>DirectoryIterator</class>.

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


id: DirectoryIterator::next
type: function
doc:
<comment>Description:</comment>
  Avanza al siguiente elemento DirectoryIterator
  
  Avanzar al siguiente elemento <class>DirectoryIterator</class>.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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


id: DirectoryIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Robobina DirectoryIterator hasta volver al inicio
  
  Robobinar <class>DirectoryIterator</class> hasta volver al inicio.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

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


id: DirectoryIterator::seek
type: function
doc:
<comment>Description:</comment>
  Mueve el apuntador interno del elemento DirectoryIterator
  
  Mueve el apuntador interno a la posición dada en el elemento <class>DirectoryIterator</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  La base cero de la posición numérica a mover el apuntador interno.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * DirectoryIterator::rewind
   * DirectoryIterator::next
   * SeekableIterator::seek


id: DirectoryIterator::valid
type: function
doc:
<comment>Description:</comment>
  Comprueba si la actual posición de DirectoryIterator es un fichero válido
  
  Comprobar si la posición actual de <class>DirectoryIterator</class> es un fichero válido.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si la posición es válida, en caso contrario <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>  No devuelve ningún valor.


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>
  Un Deque (pronunciado “deck”) es una secuencia de valores en un búfer contiguo que crece y se
  contrae automáticamente. El nombre es una abreviación inglesa común de “double-ended queue” (cola
  de doble final) y es usado internamente por <class>Ds\Queue</class>.
  
  Dos punteros son usados para mantener el seguimiento de una cabecera y una cola. Los punteros
  pueden “envolver alrededor” el final del búfer, lo cual evita la necesidad de mover otros valores
  alrededor para hacer un espacio. Esto permite que hacer cambios y deshacer cambios sean muy
  rápidos —  algo en que <class>Ds\Vector</class> no puede competir.
  
  Accediendo a un valor por el índice requiere una traducción entre el índice y su  posición
  correspondiente en el búfer: ((cabecera + posición) % capacidad).


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>  No devuelve ningún valor.


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>  No devuelve ningún valor.


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>  No devuelve ningún valor.


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>  No devuelve ningún valor.


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>  No devuelve ningún valor.


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>  No devuelve ningún valor.


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>  No devuelve ningún valor.. 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>  No devuelve ningún valor.


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>  La función de comparación debe devolver un entero menor, igual o mayor que
                         cero si el primer argumento se considera que sea respectivamente menor,
                         igual o mayor que el segundo.
                         Observe que antes de PHP 7.0.0 este entero debía estar en el rango de
                         -2147483648 a 2147483647.
                         
                         Returning non-integer values from the comparison function, such as <info>float</info>,
                         will result in an internal cast to <info>int</info> of the callback's return value. So
                         values such as <return>0.99</return> and <return>0.1</return> will both be cast to an integer value of <return>0</return>,
                         which will compare such values as equal.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


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>  La función de comparación debe devolver un entero menor, igual o mayor que
                         cero si el primer argumento se considera que sea respectivamente menor,
                         igual o mayor que el segundo.
                         Observe que antes de PHP 7.0.0 este entero debía estar en el rango de
                         -2147483648 a 2147483647.
                         
                         Returning non-integer values from the comparison function, such as <info>float</info>,
                         will result in an internal cast to <info>int</info> of the callback's return value. So
                         values such as <return>0.99</return> and <return>0.1</return> will both be cast to an integer value of <return>0</return>,
                         which will compare such values as equal.

<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>  No devuelve ningún valor.


id: Ds\Hashable
type: class
doc:
<comment>Description:</comment>
  Hashable es una interface que permite a los objetos ser usados como claves. Esta es una
  alternativa a <strong>spl_object_hash()</strong>, la cual determina el hash de un objeto basado en su gestor: estos
  significa que dos objetos que son considerados iguales por una implícita definición no serán
  tratados como iguales debido a que no son la misma instancia.
  
  <strong>hash()</strong> es utilizada para devolver un valor escalar para ser usado como el valor hash del objeto,
  el cual determina donde este va en la tabla hash. Aunque este valor no tiene que ser único, los
  objetos los cuales son iguales deben tener el mismo valor hash.
  
  <strong>equals()</strong> es utilizada para determinar si dos objetos son iguales. Está garantizado que el objeto
  de comparación será una instancia de la misma clase que el sujeto.


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>
  Un Map es una colección secuencial de pares clave-valor, casi identico a un <info>array</info> usado en un
  contexto similar. Las claves pueden ser de cualquier tipo, pero deben ser únicos. Los valores se
  reemplazan si se agregan al mapa usando la misma clave.


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>  No devuelve ningún valor.


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>  No devuelve ningún valor.


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>  No devuelve ningún valor.


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>  La función de comparación debe devolver un entero menor, igual o mayor que
                         cero si el primer argumento se considera que sea respectivamente menor,
                         igual o mayor que el segundo.
                         Observe que antes de PHP 7.0.0 este entero debía estar en el rango de
                         -2147483648 a 2147483647.
                         
                         Returning non-integer values from the comparison function, such as <info>float</info>,
                         will result in an internal cast to <info>int</info> of the callback's return value. So
                         values such as <return>0.99</return> and <return>0.1</return> will both be cast to an integer value of <return>0</return>,
                         which will compare such values as equal.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


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>  La función de comparación debe devolver un entero menor, igual o mayor que
                         cero si el primer argumento se considera que sea respectivamente menor,
                         igual o mayor que el segundo.
                         Observe que antes de PHP 7.0.0 este entero debía estar en el rango de
                         -2147483648 a 2147483647.
                         
                         Returning non-integer values from the comparison function, such as <info>float</info>,
                         will result in an internal cast to <info>int</info> of the callback's return value. So
                         values such as <return>0.99</return> and <return>0.1</return> will both be cast to an integer value of <return>0</return>,
                         which will compare such values as equal.

<comment>Return:</comment>
  <info>Ds\Map</info>  Returns a copy of the map, sorted by key.


id: Ds\Map::last
type: function
doc:
<comment>Description:</comment>
  Returns the last pair of the map
  
  Returns the last pair of the map.

<comment>Return:</comment>
  <info>Ds\Pair</info>  The last pair of the map.


id: Ds\Map::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 of 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 callable should return what the key will be mapped to in the resulting
                       map.

<comment>Return:</comment>
  <info>Ds\Map</info>  The result of applying a <strong>$callback</strong> to each value in the map.
          
          The keys and values of the current instance won't be affected.


id: Ds\Map::merge
type: function
doc:
<comment>Description:</comment>
  Returns the result of adding all given associations
  
  Returns the result of associating all keys of a given <class>traversable</class> object or <info>array</info> with their
  corresponding values, combined with the current instance.
  
  Values of the current instance will be overwritten by those provided where keys are equal.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  A <class>traversable</class> object or an <info>array</info>.

<comment>Return:</comment>
  <info>Ds\Map</info>  The result of associating all keys of a given <class>traversable</class> object or <info>array</info> with their
          corresponding values, combined with the current instance.
          
          The current instance won't be affected.


id: Ds\Map::pairs
type: function
doc:
<comment>Description:</comment>
  Returns a sequence containing all the pairs of the map
  
  Returns a <class>Ds\Sequence</class> containing all the pairs of the map.

<comment>Return:</comment>
  <info>Ds\Sequence</info>  <class>Ds\Sequence</class> containing all the pairs of the map.


id: Ds\Map::put
type: function
doc:
<comment>Description:</comment>
  Associates a key with a value
  
  Associates a <strong>$key</strong> with a <strong>$value</strong>, overwriting a previous association if one exists.
  
  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 associate values by key, eg. $map["key"] = $value.
  
  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 associate the value with.
  <info>mixed</info>  <strong>$value</strong>  The value to be associated with the key.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Map::putAll
type: function
doc:
<comment>Description:</comment>
  Associates all key-value pairs of a traversable object or array
  
  Associates all key-value <strong>$pairs</strong> of a <class>traversable</class> object or <info>array</info>.
  
  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.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$pairs</strong>  <class>traversable</class> object or <info>array</info>.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Map::reduce
type: function
doc:
<comment>Description:</comment>
  Reduces the map to a single value using a callback function
  
  Reduces the map 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 key of the current 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>$key</strong>       The key of the current 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\Map::remove
type: function
doc:
<comment>Description:</comment>
  Removes and returns a value by key
  
  Removes and returns a value by key, or return 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 remove.
  <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 that was removed, or the <strong>$default</strong> value if provided and the <strong>$key</strong> could not be
         found in the map.


id: Ds\Map::reverse
type: function
doc:
<comment>Description:</comment>
  Reverses the map in-place
    
  
  Reverses the map in-place.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Map::reversed
type: function
doc:
<comment>Description:</comment>
  Returns a reversed copy
  
  Returns a reversed copy of the map.

<comment>Return:</comment>
  <info>Ds\Map</info>  A reversed copy of the map.
            The current instance is not affected. 
          
          The current instance is not affected.


id: Ds\Map::skip
type: function
doc:
<comment>Description:</comment>
  Returns the pair at a given positional index
  
  Returns the pair at a given zero-based <strong>$position</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  The zero-based positional index to return.

<comment>Return:</comment>
  <info>Ds\Pair</info>  Returns the <class>Ds\Pair</class> at the given <strong>$position</strong>.


id: Ds\Map::slice
type: function
doc:
<comment>Description:</comment>
  Returns a subset of the map defined by a starting index and length
    
  
  Returns a subset of the map defined by a starting <strong>$index</strong> and <strong>$length</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>   The index at which the range starts.
                
                If positive, the range will start at that index in the map. If negative, the range
                will start that far from the end.
  <info>int</info>  <strong>$length</strong>  If a length is given and is positive, the resulting map will have up to that many
                pairs in it.
                 If a length is given and is negative, the range will stop that many pairs from the
                end.
                 If the length results in an overflow, only pairs up to the end of the map will be
                included.
                 If a length is not provided, the resulting map will contain all pairs between the
                index and the end of the map.

<comment>Return:</comment>
  <info>Ds\Map</info>  A subset of the map defined by a starting index and length.


id: Ds\Map::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the map in-place by value
   
  
  Sorts the map in-place by value, using an optional <strong>$comparator</strong> function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$comparator</strong>  La función de comparación debe devolver un entero menor, igual o mayor que
                         cero si el primer argumento se considera que sea respectivamente menor,
                         igual o mayor que el segundo.
                         Observe que antes de PHP 7.0.0 este entero debía estar en el rango de
                         -2147483648 a 2147483647.
                         
                         Returning non-integer values from the comparison function, such as <info>float</info>,
                         will result in an internal cast to <info>int</info> of the callback's return value. So
                         values such as <return>0.99</return> and <return>0.1</return> will both be cast to an integer value of <return>0</return>,
                         which will compare such values as equal.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Map::sorted
type: function
doc:
<comment>Description:</comment>
  Returns a copy, sorted by value
  
  Returns a copy, sorted by value using an optional <strong>$comparator</strong> function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$comparator</strong>  La función de comparación debe devolver un entero menor, igual o mayor que
                         cero si el primer argumento se considera que sea respectivamente menor,
                         igual o mayor que el segundo.
                         Observe que antes de PHP 7.0.0 este entero debía estar en el rango de
                         -2147483648 a 2147483647.
                         
                         Returning non-integer values from the comparison function, such as <info>float</info>,
                         will result in an internal cast to <info>int</info> of the callback's return value. So
                         values such as <return>0.99</return> and <return>0.1</return> will both be cast to an integer value of <return>0</return>,
                         which will compare such values as equal.

<comment>Return:</comment>
  <info>Ds\Map</info>  Returns a copy of the map, sorted by value.


id: Ds\Map::sum
type: function
doc:
<comment>Description:</comment>
  Returns the sum of all values in the map
  
  Returns the sum of all values in the map.
  
  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 map as either a <info>float</info> or <info>int</info> depending on the values
             in the map.


id: Ds\Map::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the map to an array
    
  
  Converts the map to an <info>array</info>.
  
  Maps where non-scalar keys are can't be converted to an <info>array</info>.
  
  An <info>array</info> will treat all numeric keys as integers, eg. "1" and 1 as keys in the map will only
  result in 1 being included in the array.
  
  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 map.


id: Ds\Map::union
type: function
doc:
<comment>Description:</comment>
  Creates a new map using values from the current instance and another map
  
  Creates a new map that contains the pairs of the current instance as well as the pairs of another
  <strong>$map</strong>.
  
  A ∪ B = {x: x ∈ A ∨ x ∈ B}
  
  Values of the current instance will be overwritten by those provided where keys are equal.

<comment>Param:</comment>
  <info>Ds\Map</info>  <strong>$map</strong>  The other map, to combine with the current instance.

<comment>Return:</comment>
  <info>Ds\Map</info>  A new map containing all the pairs of the current instance as well as another <strong>$map</strong>.

<comment>See Also:</comment>
   * Union on Wikipedia


id: Ds\Map::values
type: function
doc:
<comment>Description:</comment>
  Returns a sequence of the map's values
  
  Returns a sequence containing all the values of the map, in the same order.

<comment>Return:</comment>
  <info>Ds\Sequence</info>  A <class>Ds\Sequence</class> containing all the values of the map.


id: Ds\Map::xor
type: function
doc:
<comment>Description:</comment>
  Creates a new map using keys of either the current instance or of another map, but not of both
  
  Creates a new map containing keys of the current instance as well as another <strong>$map</strong>, but not of
  both.
  
  A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)}

<comment>Param:</comment>
  <info>Ds\Map</info>  <strong>$map</strong>  The other map.

<comment>Return:</comment>
  <info>Ds\Map</info>  A new map containing keys in the current instance as well as another <strong>$map</strong>, but not in
          both.

<comment>See Also:</comment>
   * Symmetric Difference on Wikipedia


id: Ds\Pair
type: class
doc:
<comment>Description:</comment>
  Un par es usado por <class>Ds\Map</class> para emparejar las claves con valores.


id: Ds\Pair::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new instance
  
  Creates a new instance using a given <strong>$key</strong> and <strong>$value</strong>.

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


id: Ds\Pair::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values
  
  Removes all values from the pair.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Pair::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the pair
  
  Returns a shallow copy of the pair.

<comment>Return:</comment>
  <info>Ds\Pair</info>  Returns a shallow copy of the pair.


id: Ds\Pair::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the pair is empty
  
  Returns whether the pair is empty.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the pair is empty, <info>false</info> otherwise.


id: Ds\Pair::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the pair to an array
    
  
  Converts the pair 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 pair.


id: Ds\PriorityQueue
type: class
doc:
<comment>Description:</comment>
  A PriorityQueue is very similar to a Queue. Values are pushed into the queue with an assigned
  priority, and the value with the highest priority will always be at the front of the queue.
  
  Implemented using a max heap.
  
  "First in, first out" ordering is preserved for values with the same priority.
  
  Iterating over a PriorityQueue is destructive, equivalent to successive pop operations until the
  queue is empty.


id: Ds\PriorityQueue::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values
  
  Removes all values from the queue.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\PriorityQueue::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the queue
  
  Returns a shallow copy of the queue.

<comment>Return:</comment>
  <info>Ds\PriorityQueue</info>  Returns a shallow copy of the queue.


id: Ds\PriorityQueue::count
type: function
doc:
<comment>Description:</comment>
  Returns the number of values in the queue
  
  See <strong>Countable::count()</strong>


id: Ds\PriorityQueue::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the queue is empty
  
  Returns whether the queue is empty.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the queue is empty, <info>false</info> otherwise.


id: Ds\PriorityQueue::peek
type: function
doc:
<comment>Description:</comment>
  Returns the value at the front of the queue
  
  Returns the value at the front of the queue, but does not remove it.

<comment>Return:</comment>
  <info>mixed</info>  The value at the front of the queue.


id: Ds\PriorityQueue::pop
type: function
doc:
<comment>Description:</comment>
  Removes and returns the value with the highest priority
  
  Removes and returns the value at the front of the queue, ie. the value with the highest priority.
  
  Values with equal priority fall back to FIFO (first in first out).

<comment>Return:</comment>
  <info>mixed</info>  The removed value which was at the front of the queue.


id: Ds\PriorityQueue::push
type: function
doc:
<comment>Description:</comment>
  Pushes values into the queue
  
  Pushes a <strong>$value</strong> with a given <strong>$priority</strong> into the queue.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>     The value to push into the queue.
  <info>int</info>    <strong>$priority</strong>  The priority associated with the value.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\PriorityQueue::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the queue to an array
    
  
  Converts the queue to an <info>array</info>.
  
  This method is not destructive.
  
  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 queue.


id: Ds\Queue
type: class
doc:
<comment>Description:</comment>
  A Queue is a “first in, first out” or “FIFO” collection that only allows access to the value at
  the front of the queue and iterates in that order, destructively.


id: Ds\Queue::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.
  
  Capacity will always be rounded up to the nearest power of 2.

<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>  No devuelve ningún valor.


id: Ds\Queue::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the queue
  
  Returns a shallow copy of the queue.

<comment>Return:</comment>
  <info>Ds\Queue</info>  Returns a shallow copy of the queue.


id: Ds\Queue::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Regresa una representacion que puede ser convertida a JSON
  
  Veáse <strong>JsonSerializable::jsonSerialize()</strong>
  
  Nunca debería necesitar llamar esta función directamente.


id: Ds\Queue::pop
type: function
doc:
<comment>Description:</comment>
  Removes and returns the value at the front of the queue
  
  Removes and returns the value at the front of the queue.

<comment>Return:</comment>
  <info>mixed</info>  The removed value which was at the front of the queue.


id: Ds\Queue::push
type: function
doc:
<comment>Description:</comment>
  Añade un elemento a la cola
  
  Añade <strong>$valores</strong> en la cola.

<comment>Param:</comment>
  <info></info>  <strong>$values</strong>  Los valores a añadir a la cola.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Queue::toArray
type: function
doc:
<comment>Description:</comment>
  Convierte la cola en un array
    
  
  Convierte la cola en un <info>array</info>.
  
  Un casting a un <info>array</info> no se soporta todavía.
  
  Este método no es destructivo.

<comment>Return:</comment>
  <info>array</info>  Un <info>array</info> conteniendo todos los elementos en el mismo orden que la cola.


id: Ds\Sequence
type: class
doc:
<comment>Description:</comment>
  A Sequence describes the behaviour of values arranged in a single, linear dimension. Some
  languages refer to this as a "List". It’s similar to an array that uses incremental integer keys,
  with the exception of a few characteristics: Values will always be indexed as [0, 1, 2, …, size -
  1].Only allowed to access values by index in the range [0, size - 1].
  
  Use cases: Wherever you would use an array as a list (not concerned with keys).A more efficient
  alternative to <class>SplDoublyLinkedList</class> and <class>SplFixedArray</class>.


id: Ds\Sequence::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.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Sequence::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 sequence.

<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 sequence.
                       
                       The callback should return what the value should be replaced by.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Sequence::contains
type: function
doc:
<comment>Description:</comment>
  Determines if the sequence contains given values
  
  Determines if the sequence 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 sequence, <info>true</info> otherwise.


id: Ds\Sequence::filter
type: function
doc:
<comment>Description:</comment>
  Creates a new sequence using a callable to
      determine which values to include
   
  
  Creates a new sequence 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\Sequence</info>  A new sequence 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\Sequence::first
type: function
doc:
<comment>Description:</comment>
  Returns the first value in the sequence
  
  Returns the first value in the sequence.

<comment>Return:</comment>
  <info>mixed</info>  The first value in the sequence.


id: Ds\Sequence::insert
type: function
doc:
<comment>Description:</comment>
  Inserts values at a given index
  
  Inserts values into the sequence 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>  No devuelve ningún valor.


id: Ds\Sequence::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 sequence joined together as a string.


id: Ds\Sequence::last
type: function
doc:
<comment>Description:</comment>
  Returns the last value
  
  Returns the last value in the sequence.

<comment>Return:</comment>
  <info>mixed</info>  The last value in the sequence.


id: Ds\Sequence::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 sequence.

<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 sequence.
                       
                       The callable should return what the new value will be in the new sequence.

<comment>Return:</comment>
  <info>Ds\Sequence</info>  The result of applying a <strong>$callback</strong> to each value in the sequence.
               
               The values of the current instance won't be affected.


id: Ds\Sequence::merge
type: function
doc:
<comment>Description:</comment>
  Returns the result of adding all given values to the sequence
  
  Returns the result of adding all given values to the sequence.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  A <class>traversable</class> object or an <info>array</info>.

<comment>Return:</comment>
  <info>Ds\Sequence</info>  The result of adding all given values to the sequence, effectively the same as adding
               the values to a copy, then returning that copy.
               
               The current instance won't be affected.


id: Ds\Sequence::push
type: function
doc:
<comment>Description:</comment>
  Adds values to the end of the sequence
  
  Adds values to the end of the sequence.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to add.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Sequence::reduce
type: function
doc:
<comment>Description:</comment>
  Reduces the sequence to a single value using a callback function
  
  Reduces the sequence 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\Sequence::reverse
type: function
doc:
<comment>Description:</comment>
  Reverses the sequence in-place
    
  
  Reverses the sequence in-place.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Sequence::reversed
type: function
doc:
<comment>Description:</comment>
  Returns a reversed copy
  
  Returns a reversed copy of the sequence.

<comment>Return:</comment>
  <info>Ds\Sequence</info>  A reversed copy of the sequence.
                 The current instance is not affected. 
               
               The current instance is not affected.


id: Ds\Sequence::rotate
type: function
doc:
<comment>Description:</comment>
  Rotates the sequence by a given number of rotations
  
  Rotates the sequence by a given number of rotations, which is equivalent to successively calling
  $sequence-&gt;push($sequence-&gt;shift()) if the number of rotations is positive, or
  $sequence-&gt;unshift($sequence-&gt;pop()) if negative.

<comment>Param:</comment>
  <info>int</info>  <strong>$rotations</strong>  The number of times the sequence should be rotated.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.. The sequence of the current instance will be rotated.


id: Ds\Sequence::slice
type: function
doc:
<comment>Description:</comment>
  Returns a sub-sequence of a given range
    
  
  Creates a sub-sequence of a given range.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>   The index at which the sub-sequence starts.
                
                If positive, the sequence will start at that index in the sequence. If negative, the
                sequence will start that far from the end.
  <info>int</info>  <strong>$length</strong>  If a length is given and is positive, the resulting sequence will have up to that
                many values in it.
                 If the length results in an overflow, only values up to the end of the sequence
                will be included.
                 If a length is given and is negative, the sequence will stop that many values from
                the end.
                 If a length is not provided, the resulting sequence will contain all values between
                the index and the end of the sequence.

<comment>Return:</comment>
  <info>Ds\Sequence</info>  A sub-sequence of the given range.


id: Ds\Sequence::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the sequence in-place
   
  
  Sorts the sequence in-place, using an optional <strong>$comparator</strong> function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$comparator</strong>  La función de comparación debe devolver un entero menor, igual o mayor que
                         cero si el primer argumento se considera que sea respectivamente menor,
                         igual o mayor que el segundo.
                         Observe que antes de PHP 7.0.0 este entero debía estar en el rango de
                         -2147483648 a 2147483647.
                         
                         Returning non-integer values from the comparison function, such as <info>float</info>,
                         will result in an internal cast to <info>int</info> of the callback's return value. So
                         values such as <return>0.99</return> and <return>0.1</return> will both be cast to an integer value of <return>0</return>,
                         which will compare such values as equal.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Sequence::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>  La función de comparación debe devolver un entero menor, igual o mayor que
                         cero si el primer argumento se considera que sea respectivamente menor,
                         igual o mayor que el segundo.
                         Observe que antes de PHP 7.0.0 este entero debía estar en el rango de
                         -2147483648 a 2147483647.
                         
                         Returning non-integer values from the comparison function, such as <info>float</info>,
                         will result in an internal cast to <info>int</info> of the callback's return value. So
                         values such as <return>0.99</return> and <return>0.1</return> will both be cast to an integer value of <return>0</return>,
                         which will compare such values as equal.

<comment>Return:</comment>
  <info>Ds\Sequence</info>  Returns a sorted copy of the sequence.


id: Ds\Sequence::sum
type: function
doc:
<comment>Description:</comment>
  Returns the sum of all values in the sequence
  
  Returns the sum of all values in the sequence.
  
  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 sequence as either a <info>float</info> or <info>int</info> depending on the
             values in the sequence.


id: Ds\Sequence::unshift
type: function
doc:
<comment>Description:</comment>
  Adds values to the front of the sequence
  
  Adds values to the front of the sequence, 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 sequence.  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>  No devuelve ningún valor.


id: Ds\Set
type: class
doc:
<comment>Description:</comment>
  A Set is a sequence of unique values. This implementation uses the same hash table as <class>Ds\Map</class>,
  where values are used as keys and the mapped value is ignored.


id: Ds\Set::add
type: function
doc:
<comment>Description:</comment>
  Adds values to the set
  
  Adds all given values to the set that haven't already been added.
  
  Values 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.
  
  All comparisons are strict (type and value).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  Values to add to the set.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Set::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values
  
  Removes all values from the set.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Set::contains
type: function
doc:
<comment>Description:</comment>
  Determines if the set contains all values
  
  Determines if the set contains all values.
  
  Values 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.
  
  All comparisons are strict (type and value).

<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 set, <info>true</info> otherwise.


id: Ds\Set::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the set
  
  Returns a shallow copy of the set.

<comment>Return:</comment>
  <info>Ds\Set</info>  Returns a shallow copy of the set.


id: Ds\Set::count
type: function
doc:
<comment>Description:</comment>
  Returns the number of values in the set
  
  See <strong>Countable::count()</strong>


id: Ds\Set::diff
type: function
doc:
<comment>Description:</comment>
  Creates a new set using values that aren't in another set
  
  Creates a new set using values that aren't in another set.
  
  A \ B = {x ∈ A | x ∉ B}

<comment>Param:</comment>
  <info>Ds\Set</info>  <strong>$set</strong>  Set containing the values to exclude.

<comment>Return:</comment>
  <info>Ds\Set</info>  A new set containing all values that were not in the other <strong>$set</strong>.

<comment>See Also:</comment>
   * Complement on Wikipedia


id: Ds\Set::filter
type: function
doc:
<comment>Description:</comment>
  Creates a new set using a callable to
      determine which values to include
    
  
  Creates a new set 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\Set</info>  A new set 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\Set::first
type: function
doc:
<comment>Description:</comment>
  Returns the first value in the set
  
  Returns the first value in the set.

<comment>Return:</comment>
  <info>mixed</info>  The first value in the set.


id: Ds\Set::intersect
type: function
doc:
<comment>Description:</comment>
  Creates a new set by intersecting values with another set
  
  Creates a new set using values common to both the current instance and another <strong>$set</strong>.
   In other words, returns a copy of the current instance with all values removed that are not in
  the other <strong>$set</strong>.
  
  A ∩ B = {x : x ∈ A ∧ x ∈ B}

<comment>Param:</comment>
  <info>Ds\Set</info>  <strong>$set</strong>  The other set.

<comment>Return:</comment>
  <info>Ds\Set</info>  The intersection of the current instance and another <strong>$set</strong>.

<comment>See Also:</comment>
   * Intersection on Wikipedia


id: Ds\Set::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the set is empty
  
  Returns whether the set is empty.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the set is empty, <info>false</info> otherwise.


id: Ds\Set::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 set joined together as a string.


id: Ds\Set::last
type: function
doc:
<comment>Description:</comment>
  Returns the last value in the set
  
  Returns the last value in the set.

<comment>Return:</comment>
  <info>mixed</info>  The last value in the set.


id: Ds\Set::merge
type: function
doc:
<comment>Description:</comment>
  Returns the result of adding all given values to the set
  
  Returns the result of adding all given values to the set.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  A <class>traversable</class> object or an <info>array</info>.

<comment>Return:</comment>
  <info>Ds\Set</info>  The result of adding all given values to the set, effectively the same as adding the
          values to a copy, then returning that copy.
          
          The current instance won't be affected.


id: Ds\Set::reduce
type: function
doc:
<comment>Description:</comment>
  Reduces the set to a single value using a callback function
  
  Reduces the set 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\Set::remove
type: function
doc:
<comment>Description:</comment>
  Removes all given values from the set
  
  Removes all given <strong>$values</strong> from the set, ignoring any that are not in the set.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to remove.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Set::reverse
type: function
doc:
<comment>Description:</comment>
  Reverses the set in-place
    
  
  Reverses the set in-place.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Set::reversed
type: function
doc:
<comment>Description:</comment>
  Returns a reversed copy
  
  Returns a reversed copy of the set.

<comment>Return:</comment>
  <info>Ds\Set</info>  A reversed copy of the set.
            The current instance is not affected. 
          
          The current instance is not affected.


id: Ds\Set::slice
type: function
doc:
<comment>Description:</comment>
  Returns a sub-set of a given range
    
  
  Creates a sub-set of a given range.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>   The index at which the sub-set starts.
                
                If positive, the set will start at that index in the set. If negative, the set will
                start that far from the end.
  <info>int</info>  <strong>$length</strong>  If a length is given and is positive, the resulting set will have up to that many
                values in it.
                 If the length results in an overflow, only values up to the end of the set will be
                included.
                 If a length is given and is negative, the set will stop that many values from the
                end.
                 If a length is not provided, the resulting set will contain all values between the
                index and the end of the set.

<comment>Return:</comment>
  <info>Ds\Set</info>  A sub-set of the given range.


id: Ds\Set::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the set in-place
   
  
  Sorts the set in-place, using an optional <strong>$comparator</strong> function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$comparator</strong>  La función de comparación debe devolver un entero menor, igual o mayor que
                         cero si el primer argumento se considera que sea respectivamente menor,
                         igual o mayor que el segundo.
                         Observe que antes de PHP 7.0.0 este entero debía estar en el rango de
                         -2147483648 a 2147483647.
                         
                         Returning non-integer values from the comparison function, such as <info>float</info>,
                         will result in an internal cast to <info>int</info> of the callback's return value. So
                         values such as <return>0.99</return> and <return>0.1</return> will both be cast to an integer value of <return>0</return>,
                         which will compare such values as equal.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Set::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>  La función de comparación debe devolver un entero menor, igual o mayor que
                         cero si el primer argumento se considera que sea respectivamente menor,
                         igual o mayor que el segundo.
                         Observe que antes de PHP 7.0.0 este entero debía estar en el rango de
                         -2147483648 a 2147483647.
                         
                         Returning non-integer values from the comparison function, such as <info>float</info>,
                         will result in an internal cast to <info>int</info> of the callback's return value. So
                         values such as <return>0.99</return> and <return>0.1</return> will both be cast to an integer value of <return>0</return>,
                         which will compare such values as equal.

<comment>Return:</comment>
  <info>Ds\Set</info>  Returns a sorted copy of the set.


id: Ds\Set::sum
type: function
doc:
<comment>Description:</comment>
  Returns the sum of all values in the set
  
  Returns the sum of all values in the set.
  
  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 set as either a <info>float</info> or <info>int</info> depending on the values
             in the set.


id: Ds\Set::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the set to an array
    
  
  Converts the set 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 set.


id: Ds\Set::union
type: function
doc:
<comment>Description:</comment>
  Creates a new set using values from the current instance and another set
  
  Creates a new set that contains the values of the current instance as well as the values of
  another <strong>$set</strong>.
  
  A ∪ B = {x: x ∈ A ∨ x ∈ B}

<comment>Param:</comment>
  <info>Ds\Set</info>  <strong>$set</strong>  The other set, to combine with the current instance.

<comment>Return:</comment>
  <info>Ds\Set</info>  A new set containing all the values of the current instance as well as another <strong>$set</strong>.

<comment>See Also:</comment>
   * Union on Wikipedia


id: Ds\Set::xor
type: function
doc:
<comment>Description:</comment>
  Creates a new set using values in either the current instance or in another set, but not in both
  
  Creates a new set containing values in the current instance as well as another <strong>$set</strong>, but not in
  both.
  
  A ⊖ B = {x : x ∈ (A \ B) ∪ (B \ A)}

<comment>Param:</comment>
  <info>Ds\Set</info>  <strong>$set</strong>  The other set.

<comment>Return:</comment>
  <info>Ds\Set</info>  A new set containing values in the current instance as well as another <strong>$set</strong>, but not in
          both.

<comment>See Also:</comment>
   * Symmetric Difference on Wikipedia


id: Ds\Stack
type: class
doc:
<comment>Description:</comment>
  A Stack is a “last in, first out” or “LIFO” collection that only allows access to the value at the
  top of the structure and iterates in that order, destructively.
  
  Uses a <class>Ds\Vector</class> internally.


id: Ds\Stack::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values
  
  Removes all values from the stack.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Stack::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the stack
  
  Returns a shallow copy of the stack.

<comment>Return:</comment>
  <info>Ds\Stack</info>  Returns a shallow copy of the stack.


id: Ds\Stack::count
type: function
doc:
<comment>Description:</comment>
  Returns the number of values in the stack
  
  See <strong>Countable::count()</strong>


id: Ds\Stack::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the stack is empty
  
  Returns whether the stack is empty.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the stack is empty, <info>false</info> otherwise.


id: Ds\Stack::peek
type: function
doc:
<comment>Description:</comment>
  Returns the value at the top of the stack
  
  Returns the value at the top of the stack, but does not remove it.

<comment>Return:</comment>
  <info>mixed</info>  The value at the top of the stack.


id: Ds\Stack::pop
type: function
doc:
<comment>Description:</comment>
  Removes and returns the value at the top of the stack
  
  Removes and returns the value at the top of the stack.

<comment>Return:</comment>
  <info>mixed</info>  The removed value which was at the top of the stack.


id: Ds\Stack::push
type: function
doc:
<comment>Description:</comment>
  Pushes values onto the stack
  
  Pushes <strong>$values</strong> onto the stack.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to push onto the stack.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Stack::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the stack to an array
    
  
  Converts the stack 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 stack.


id: Ds\Vector
type: class
doc:
<comment>Description:</comment>
  Un Vector es una secuencia de valores en un buffer que crece y se encoge automáticamente. Esta es
  la más eficiente estructura secuencial debido a que el índice de un valor es un mapeo directo a su
  índice en el buffer, y el factor de crecimiento no está ligado a un multiplo o exponente
  específico.


id: Ds\Vector::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 vector.

<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 vector.
                       
                       The callback should return what the value should be replaced by.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Vector::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values
  
  Removes all values from the vector.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: Ds\Vector::contains
type: function
doc:
<comment>Description:</comment>
  Determines if the vector contains given values
  
  Determines if the vector 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 vector, <info>true</info> otherwise.


id: Ds\Vector::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the vector
  
  Returns a shallow copy of the vector.

<comment>Return:</comment>
  <info>Ds\Vector</info>  Returns a shallow copy of the vector.


id: Ds\Vector::filter
type: function
doc:
<comment>Description:</comment>
  Creates a new vector using a callable to
      determine which values to include
   
  
  Creates a new vector 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\Vector</info>  A new vector 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.


